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

[sbws/master] English wording
by pastly＠torproject.org 05 Sep '18

05 Sep '18

commit a1390f7ba8f23f4b483b8a27ec47bf5404228d23 Author: juga0 <juga(a)riseup.net> Date: Wed Aug 29 06:56:20 2018 +0000 English wording --- INSTALL.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/INSTALL.rst b/INSTALL.rst index 23217c1..7ab7558 100644 --- a/INSTALL.rst +++ b/INSTALL.rst @@ -6,7 +6,7 @@ Installing Simple Bandwidth Scanner The prefered method to install ``sbws`` is to install it from your system distribution. Currently there is not any system distribution package. -In the meanwhile, follow the following steps. +In the meantime, follow the following steps. System requirements --------------------

1 0

[sbws/master] It is only the scanner that needs destinations
by pastly＠torproject.org 05 Sep '18

05 Sep '18

commit bdf9384b92f3d269f8b77d16c7f84d8b21f9c1c6 Author: juga0 <juga(a)riseup.net> Date: Wed Aug 29 07:26:27 2018 +0000 It is only the scanner that needs destinations --- DEPLOY.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/DEPLOY.rst b/DEPLOY.rst index aafa093..e7f2a36 100644 --- a/DEPLOY.rst +++ b/DEPLOY.rst @@ -27,7 +27,7 @@ well connected machines. Install sbws according to :doc:`/INSTALL`. -``sbws`` needs :term:`destination` (s) to request files from. +``sbws scanner`` needs :term:`destination` (s) to request files from. They are not included by default. To configure destinations, create a file called ``config.ini``. It can be

1 0

[sbws/master] HTTP Server must also support Range requests
by pastly＠torproject.org 05 Sep '18

05 Sep '18

commit 6585dc741826b89cf3b0efb705f4f228956fbfba Author: juga0 <juga(a)riseup.net> Date: Wed Aug 29 06:41:53 2018 +0000 HTTP Server must also support Range requests --- DEPLOY.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/DEPLOY.rst b/DEPLOY.rst index 5ed375b..41ff9cd 100644 --- a/DEPLOY.rst +++ b/DEPLOY.rst @@ -16,8 +16,9 @@ well connected machines. :term:`destination` requirements ------------------------------------ -- A Web server installed and running that supports HEAD and GET - requests (``apache`` and ``nginx`` fit this description) +- A Web server installed and running that supports HTTP GET, HEAD and + Range (:rfc:`7233`) requests. + ``Apache`` HTTP Server and ``Nginx`` support them. - Optional support for TLS - A large file; at the time of writing, at least 1 GiB in size

1 0

[sbws/master] Remove anticipated config location in system package
by pastly＠torproject.org 05 Sep '18

05 Sep '18

commit 4beeb253f11f1e6d30832440389b13a48190e022 Author: juga0 <juga(a)riseup.net> Date: Wed Aug 29 06:45:27 2018 +0000 Remove anticipated config location in system package it will have to be added again when there is a system package --- DEPLOY.rst | 2 -- 1 file changed, 2 deletions(-) diff --git a/DEPLOY.rst b/DEPLOY.rst index 8ed429c..fa58b62 100644 --- a/DEPLOY.rst +++ b/DEPLOY.rst @@ -34,8 +34,6 @@ To configure destinations, create a file called ``config.ini``. It can be located in: * ``~/.sbws.ini`` if you are running ``sbws`` manually -* ``/etc/sbws`` if you are running ``sbws`` from a system package as a - ``systemd`` directory (not yet supported) * any localion, an specify the path via the ``-c`` argument And edit destinations according to :doc:`man_sbws.ini`

1 0

[sbws/master] Add other paths and remove non-config dir
by pastly＠torproject.org 05 Sep '18

05 Sep '18

commit 2dfe05595906d0a742873025f7ada90ef75fe330 Author: juga0 <juga(a)riseup.net> Date: Wed Aug 29 07:25:19 2018 +0000 Add other paths and remove non-config dir --- docs/source/man_sbws.ini.rst | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/source/man_sbws.ini.rst b/docs/source/man_sbws.ini.rst index 3ed78e5..01257ef 100644 --- a/docs/source/man_sbws.ini.rst +++ b/docs/source/man_sbws.ini.rst @@ -153,9 +153,8 @@ FILES $HOME/.sbws.ini Default ``sbws`` user configuration path. -$HOME/.sbws - Default sbws home, where it stores measurement data files, - bandwidth list files and tor process data. +Any other path to the configuration file can be specified using the +``sbws`` argument ``-c`` SEE ALSO ---------

1 0

[sbws/master] No need to repeat what is already in man sbws.ini
by pastly＠torproject.org 05 Sep '18

05 Sep '18

commit 2391db08a743e5180a52f9c074c90674c92ff3ad Author: juga0 <juga(a)riseup.net> Date: Wed Aug 29 07:27:09 2018 +0000 No need to repeat what is already in man sbws.ini --- DEPLOY.rst | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/DEPLOY.rst b/DEPLOY.rst index e7f2a36..9bd53ba 100644 --- a/DEPLOY.rst +++ b/DEPLOY.rst @@ -30,14 +30,8 @@ Install sbws according to :doc:`/INSTALL`. ``sbws scanner`` needs :term:`destination` (s) to request files from. They are not included by default. -To configure destinations, create a file called ``config.ini``. It can be -located in: - -* ``~/.sbws.ini`` if you are running ``sbws`` manually -* any location, specify the path via the ``-c`` argument. - For instance: ``sbws -c myconfig.ini scanner`` - -And edit destinations according to :doc:`man_sbws.ini` +To configure destinations, create a configuration file according to +:doc:`man_sbws.ini` It is not required, but it is recomended to include a custom scanner ``nickname`` in ``config.ini``.

1 0

[sbws/master] config.ini is not a default configuration file
by pastly＠torproject.org 05 Sep '18

05 Sep '18

commit 68cf30399b75822aac3100a57becfbf89343452d Author: juga0 <juga(a)riseup.net> Date: Wed Aug 29 07:27:49 2018 +0000 config.ini is not a default configuration file --- DEPLOY.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/DEPLOY.rst b/DEPLOY.rst index 9bd53ba..7a20fae 100644 --- a/DEPLOY.rst +++ b/DEPLOY.rst @@ -34,7 +34,7 @@ To configure destinations, create a configuration file according to :doc:`man_sbws.ini` It is not required, but it is recomended to include a custom scanner -``nickname`` in ``config.ini``. +``nickname`` in the configuration file`. Destination(s) configuration in more detail::

1 0

[sbws/master] Add path to runtime directory
by pastly＠torproject.org 05 Sep '18

05 Sep '18

commit 022ce9a68ad5251f7785fa803f626c89503d7627 Author: juga0 <juga(a)riseup.net> Date: Wed Aug 29 07:29:48 2018 +0000 Add path to runtime directory --- docs/source/man_sbws.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/source/man_sbws.rst b/docs/source/man_sbws.rst index 775c7db..7ffb7ba 100644 --- a/docs/source/man_sbws.rst +++ b/docs/source/man_sbws.rst @@ -62,6 +62,9 @@ $HOME/.sbws Default sbws home, where it stores measurement data files, bandwidth list files and tor process data. +$XDG_RUNTIME_DIR/sbws + Runtime directory for the tor process launched by ``sbws``. + SEE ALSO ---------

1 0

[sbws/master] Add example with default configuration path
by pastly＠torproject.org 05 Sep '18

05 Sep '18

commit 7acff724bd16f4c63cab67f049cb395c208f8765 Author: juga0 <juga(a)riseup.net> Date: Wed Aug 29 07:28:48 2018 +0000 Add example with default configuration path --- docs/source/man_sbws.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/source/man_sbws.rst b/docs/source/man_sbws.rst index 94bb9f2..775c7db 100644 --- a/docs/source/man_sbws.rst +++ b/docs/source/man_sbws.rst @@ -40,6 +40,9 @@ Optional arguments EXAMPLES -------- +sbws scanner + Run the scanner using the configuration file in ~/.sbws.ini + sbws -c ~/.sbwsrc scanner Run the scanner using the configuration file in ~/.sbwsrc

1 0

[sbws/master] Clarify which section must be edited
by pastly＠torproject.org 05 Sep '18

05 Sep '18

commit abee1767b8dbcebad4edb108baae775676f8bf5f Author: juga0 <juga(a)riseup.net> Date: Wed Aug 29 07:54:31 2018 +0000 Clarify which section must be edited --- docs/source/man_sbws.ini.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/source/man_sbws.ini.rst b/docs/source/man_sbws.ini.rst index 01257ef..1df9639 100644 --- a/docs/source/man_sbws.ini.rst +++ b/docs/source/man_sbws.ini.rst @@ -6,6 +6,13 @@ DESCRIPTION Tor bandwidth scanner configuration file. +**sbws** (1) ``scanner`` command requires a configuration file with a +"[destinations]" section. +It is the only section that does not have a default value. +It is recommended, but not required to configure "nickname" in the "[scanner]" +section. + + SECTIONS ---------

1 0