September 2018 - tor-commits - lists.torproject.org

[sbws/master] Indent example to the correct term
by pastly＠torproject.org 05 Sep '18

05 Sep '18

commit fb76c84fd593e66f9f4b76b5a670e71947ae519e Author: juga0 <juga(a)riseup.net> Date: Tue Aug 28 14:47:21 2018 +0000 Indent example to the correct term --- docs/source/glossary.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/glossary.rst b/docs/source/glossary.rst index 2b5d56d..575088e 100644 --- a/docs/source/glossary.rst +++ b/docs/source/glossary.rst @@ -39,7 +39,7 @@ Glossary The term used by ``sbws`` to refer to :term:`bandwidth list file` v1.1.0. -.. literalinclude:: v3bw.txt - :caption: A v3bw file + .. literalinclude:: v3bw.txt + :caption: A v3bw file .. glossary::

1 0

[sbws/master] Simplify definition with specification terms
by pastly＠torproject.org 05 Sep '18

05 Sep '18

commit d18ca62f1d786fc25f918a6ce2eb4a2d7db1e1dc Author: juga0 <juga(a)riseup.net> Date: Tue Aug 28 14:46:15 2018 +0000 Simplify definition with specification terms --- docs/source/glossary.rst | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/docs/source/glossary.rst b/docs/source/glossary.rst index 30e070b..394f5f5 100644 --- a/docs/source/glossary.rst +++ b/docs/source/glossary.rst @@ -33,9 +33,7 @@ Glossary The ``sbws`` command used to run ``sbws`` as a :term:`scanner`. sbws generate - The sbws command that a :term:`bandwidth authority` runs periodically - to generate a new :term:`v3bw file` from results gathered by - :term:`sbws scanner`. + The ``sbws`` command used to run ``sbws`` as a :term:`generator`. v3bw file The file generated by :term:`sbws generate` that a :term:`bandwidth

1 0

[sbws/master] Simplify definition with specification terms
by pastly＠torproject.org 05 Sep '18

05 Sep '18

commit b53827073864c5bd32a4584236868af859baeffd Author: juga0 <juga(a)riseup.net> Date: Tue Aug 28 14:45:51 2018 +0000 Simplify definition with specification terms --- docs/source/glossary.rst | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/docs/source/glossary.rst b/docs/source/glossary.rst index ab4bf29..30e070b 100644 --- a/docs/source/glossary.rst +++ b/docs/source/glossary.rst @@ -30,10 +30,7 @@ Glossary to know about the file specification. sbws scanner - The sbws command that a :term:`bandwidth authority` runs continuously - to gather information about how fast Tor relays are. The results from - this process are used by :term:`sbws generate` to generate - :term:`v3bw files <v3bw file>`. + The ``sbws`` command used to run ``sbws`` as a :term:`scanner`. sbws generate The sbws command that a :term:`bandwidth authority` runs periodically

1 0

[sbws/master] Add reference label to deploy file
by pastly＠torproject.org 05 Sep '18

05 Sep '18

commit 2d1a6355a75f43e4e2c77bd100eee1940657f69f Author: juga0 <juga(a)riseup.net> Date: Tue Aug 28 14:50:21 2018 +0000 Add reference label to deploy file --- DEPLOY.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/DEPLOY.rst b/DEPLOY.rst index e3c4ac4..f5ae2cb 100644 --- a/DEPLOY.rst +++ b/DEPLOY.rst @@ -1,3 +1,5 @@ +.. _deploy: + Deploying Simple Bandwidth Scanner =====================================

1 0

[sbws/master] Reuse glossary term
by pastly＠torproject.org 05 Sep '18

05 Sep '18

commit 1d23f7d0baa30ad328fec29ca4fcc01c92a894a6 Author: juga0 <juga(a)riseup.net> Date: Tue Aug 28 14:51:12 2018 +0000 Reuse glossary term --- DEPLOY.rst | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/DEPLOY.rst b/DEPLOY.rst index f5ae2cb..2d2e65e 100644 --- a/DEPLOY.rst +++ b/DEPLOY.rst @@ -5,9 +5,8 @@ Deploying Simple Bandwidth Scanner So you want to run sbws for yourself. You will need -- A machine to measure from, hereafter referred to as |scanner_nick|. -- One or more webservers hosting a large file, hereafter referred to as - |dests|. +- A machine to run the :term:`scanner`. +- One or more :term:`destination` (s) that serve a large file. Both |scanner_nick| and your |dests| should be on fast, well connected machines.

1 0

[sbws/master] Reuse glossary term
by pastly＠torproject.org 05 Sep '18

05 Sep '18

commit 3432effef20007a9d9c6b9616581404a6748df67 Author: juga0 <juga(a)riseup.net> Date: Tue Aug 28 14:52:47 2018 +0000 Reuse glossary term --- DEPLOY.rst | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/DEPLOY.rst b/DEPLOY.rst index e6eb185..dfb8e1c 100644 --- a/DEPLOY.rst +++ b/DEPLOY.rst @@ -21,9 +21,8 @@ well connected machines. - Optional support for TLS - A large file; at the time of writing, at least 1 GiB in size -|scanner_nick| setup -------------------------------- - +:term:`scanner` setup +---------------------- Install sbws according to :doc:`/INSTALL`.

1 0

[sbws/master] Reuse glossary term
by pastly＠torproject.org 05 Sep '18

05 Sep '18

commit a8bf0785bc01900ccacad0f4a8bd6f77dd1e7029 Author: juga0 <juga(a)riseup.net> Date: Tue Aug 28 14:51:33 2018 +0000 Reuse glossary term --- DEPLOY.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/DEPLOY.rst b/DEPLOY.rst index 2d2e65e..b9f63b7 100644 --- a/DEPLOY.rst +++ b/DEPLOY.rst @@ -8,8 +8,8 @@ So you want to run sbws for yourself. You will need - A machine to run the :term:`scanner`. - One or more :term:`destination` (s) that serve a large file. -Both |scanner_nick| and your |dests| should be on fast, well connected -machines. +Both :term:`scanner` and your :term:`destination` (s) should be on fast, +well connected machines. |scanner_nick| requirements -------------------------------

1 0

[sbws/master] Reuse glossary term and do not repeat requirements
by pastly＠torproject.org 05 Sep '18

05 Sep '18

commit 560052868dd9adee2b1093530218e3e40b46b2d2 Author: juga0 <juga(a)riseup.net> Date: Tue Aug 28 14:52:29 2018 +0000 Reuse glossary term and do not repeat requirements --- DEPLOY.rst | 19 +++++-------------- 1 file changed, 5 insertions(+), 14 deletions(-) diff --git a/DEPLOY.rst b/DEPLOY.rst index b9f63b7..e6eb185 100644 --- a/DEPLOY.rst +++ b/DEPLOY.rst @@ -11,22 +11,13 @@ So you want to run sbws for yourself. You will need Both :term:`scanner` and your :term:`destination` (s) should be on fast, well connected machines. -|scanner_nick| requirements -------------------------------- - -- A fast, well connected machine on the Internet. Ideally its bandwidth should - not be a limiting factor in measurements. -- Linux host OS -- Python 3, virtualenv -- Tor installed with ``tor`` in your ``PATH`` +.. _destinations_requirements: -|dests| requirements -------------------------------- +:term:`destination` requirements +------------------------------------ -- A fast, well connected machine on the Internet. Ideally its bandwidth should - not be a limiting factor in measurements. -- Some sort of webserver installed and running that supports HEAD and GET - requests (apache and nginx fit this description) +- A Web server installed and running that supports HEAD and GET + requests (``apache`` and ``nginx`` fit this description) - Optional support for TLS - A large file; at the time of writing, at least 1 GiB in size

1 0

[sbws/master] Remove obsolote command, add requirement
by pastly＠torproject.org 05 Sep '18

05 Sep '18

commit ac56d0087d11862c0a289b1c1a7fe298765d1822 Author: juga0 <juga(a)riseup.net> Date: Tue Aug 28 14:53:42 2018 +0000 Remove obsolote command, add requirement --- DEPLOY.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/DEPLOY.rst b/DEPLOY.rst index dfb8e1c..4411d85 100644 --- a/DEPLOY.rst +++ b/DEPLOY.rst @@ -26,8 +26,8 @@ well connected machines. Install sbws according to :doc:`/INSTALL`. -Make sure you have initialized sbws. If you haven't already run ``sbws init``, -then enter your virtualenv and run it. +``sbws`` needs :term:`destination` (s) to request files from. +They are not included by default. Inside |dotsbws| you will find ``config.ini``. Open it with a text editor. it should be very simple. Let's give our scanner a nickname. Add the following

1 0

[sbws/master] Create virtualenv using python 3
by pastly＠torproject.org 05 Sep '18

05 Sep '18

commit 16423a51dfd114d39e24284093484ccf22539c25 Author: juga0 <juga(a)riseup.net> Date: Tue Aug 28 15:06:01 2018 +0000 Create virtualenv using python 3 --- INSTALL.rst | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/INSTALL.rst b/INSTALL.rst index 2c7d2f3..7c74c0f 100644 --- a/INSTALL.rst +++ b/INSTALL.rst @@ -26,12 +26,11 @@ Python dependencies - Stem_ > 1.6.0 - Requests_ (with socks_ support) >= 2.10.0 -I like to keep mine in my simple-bw-scanner directory and assume that's where -you'll put it. +To install the Python dependencies, create a ``virtualenv`` first :: - virtualenv -p python3 venv + virtualenv venv -p /usr/bin/python3 source venv/bin/activate Install stem in virtualenv

1 0