commit ca72016c889afd836dfd239d442ac975f8f6ac00 Author: juga0 <juga@riseup.net> Date: Tue Mar 5 17:41:44 2019 +0000 fix: docs: !minor Add country to configuration examples --- docs/source/examples/sbws.example.ini | 10 +++++++++- docs/source/man_sbws.ini.rst | 18 ++++++++++++------ 2 files changed, 21 insertions(+), 7 deletions(-) diff --git a/docs/source/examples/sbws.example.ini b/docs/source/examples/sbws.example.ini index 2f0a6bd..5b9b756 100644 --- a/docs/source/examples/sbws.example.ini +++ b/docs/source/examples/sbws.example.ini @@ -2,6 +2,9 @@ [scanner] # A human-readable string with chars in a-zA-Z0-9 to identify your scanner nickname = sbws_default +# ISO 3166-1 alpha-2 country code where the Web server destination is located. +# Default AA, to detect it was not edited. +country = SN [destinations] # With several destinations, the scanner can continue even if some of them @@ -15,7 +18,12 @@ foo = on [destinations.foo] # the domain and path to the 1GB file. url = https://example.com/does/not/exist.bin - +# Whether to verify or not the TLS certificate. Default True +verify = False +# ISO 3166-1 alpha-2 country code where the Web server destination is located. +# Default AA, to detect it was not edited. +# Use ZZ if the location is unknown (for instance, a CDN). +country = ZZ ## The following logging options are set by default. ## There is no need to change them unless other options are prefered. diff --git a/docs/source/man_sbws.ini.rst b/docs/source/man_sbws.ini.rst index 8f64b0d..5f4241b 100644 --- a/docs/source/man_sbws.ini.rst +++ b/docs/source/man_sbws.ini.rst @@ -6,14 +6,12 @@ DESCRIPTION Tor bandwidth scanner configuration file. -**sbws** (1) ``scanner`` command requires a configuration file with a -"[destinations]" section. -"[destinations]" is the only section that does not have a default value. +**sbws** (1) ``scanner`` command requires a configuration file with the +"[scanner]", "[destinations]" "[destination.<name>]" sections. -It is also required to configure "country" in the "[scanner]" section. -It is recommended, but not required to configure "nickname" in the "[scanner]" -section. +There must be at least one "[destination.<name>]". +See an **EXAMPLES** below for a minimal configuration. SECTIONS --------- @@ -186,6 +184,10 @@ EXAMPLES Example ``destinations`` section:: + [scanner] + nickname = Manual + country = US + [destinations] foo = on bar = on @@ -194,14 +196,18 @@ Example ``destinations`` section:: [destinations.foo] # using HTTP url = http://example.org/sbws.bin + country = ZZ + verify = False [destinations.bar] # using HTTPS url = https://example.com/data + country = SN [destinations.baz] # this will be ignored url = https://example.net/ask/stan/where/the/file/is.exe + country = TH FILES -----