DOKK / manpages / debian 10 / sbws / sbws.ini.5.en
SBWS.INI(5) sbws SBWS.INI(5)

sbws.ini - Simple Bandwidth Scanner configuration

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.

Days into the past that measurements are considered valid. (Default: 5)
Timeout in seconds to give to the python Requests library. (Default: 10)
Timeout in seconds to create circuits. (Default: 10)
Whether or not to reset the bandwidth measurements when the relay's IP address changes. If it changes, we only consider results for the relay that we obtained while the relay was located at its most recent IP address. (Default: on)
NOT implemented for IPv6.


paths

When sbws is run as a system service, ~/.sbws is changed to /var/lib/sbws.
sbws home directory. (Default: ~/.sbws)
Directory where sbws stores temporal bandwidth results files. (Default: ~/.sbws/datadir)
Directory where sbws stores the bandwidth list files. These are the files to be read by the Tor Directory Authorities. (Default: ~/.sbws/v3bw)
File names of the bandwidth list files. The latest bandwidth file is symlinked by latests.v3bw
File path to store the timestamp when the scanner was last started. (Default: ~/.sbws/started_at)
Directory where to store log files when logging to files is enabled. (Default ~/.sbws/log)



Name of destination. It is a name for the Web server from where to download files in order to measure bandwidths.
How often to check if a destination is usable

The URL to the destination. It must include a file path. It can use both http or https.


tor

When sbws is run as a system service ~/.sbws/tor is replaced by /run/sbws/tor.
sbws' owned tor directory. (Default: ~/.sbws/tor)
sbws's owned tor control socket file. (Default: ~/.sbws/tor/sbws/control)
sbws's owned tor pid file. (Default: ~/.sbws/tor/sbws/tor.pid)
sbws's owned tor directory log files. (Default: ~/.sbws/tor/log)
sbws's tor extra configuration. (Default: None)



A human-readable string with chars in a-zA-Z0-9 to identify the scanner. (Default: IDidntEditTheSBWSConfig)
Limits on what download times are too fast/slow/etc. (Default: 1)
Limits on what download times are too fast/slow/etc. (Default: 5)
Limits on what download times are too fast/slow/etc. (Default: 6)
Limits on what download times are too fast/slow/etc. (Default: 10)
How many RTT measurements to make. (Default: 10)
Number of downloads with acceptable times we must have for a relay before moving on. (Default: 5)
The number of bytes to initially request from the server. (Default: 16384)
How many measurements to make in parallel. (Default: 3)
Minimum number of bytes we should ever try to download in a measurement. (Default: 1)
Maximum number of bytes we should ever try to download in a measurement. (Default: 1073741824) 1073741824 == 1 GiB

Whether or not to measure authorities. (Default: off)
The target fraction of best priority relays we would like to return. 0.05 is 5%. In a 7000 relay network, 5% is 350 relays. (Default: 0.05)
The minimum number of best priority relays we are willing to return. (Default: 50)

After this many days, compress data files. (Default: 10)
After this many days, delete data files. (Default: 90)

Whether or not to log to a rotating file the directory paths.log_dname. (Default: no)
Whether or not to log to stdout. (Default: yes)
Whether or not to log to syslog. (Default: no)
If logging to file, how large (in bytes) should the file be allowed to get before rotating to a new one. 10485760 is 10 MiB. If zero or number of backups is zero, never rotate the log file. (Default: 10485760)
If logging to file, how many backups to keep. If zero or max bytes is zero, never rotate the log file. (Default: 50)
Level to log at. (Default: info)
Level to log at when using files. (Default: info)
Level to log at when using stdout. (Default: info)
Level to log at when using syslog. (Default: info)
Format string to use when logging. (Default: [%(asctime)s] [%(name)s] [%(levelname)s] %(message)s)
Format string to use when logging to files. (Default: $format)
Format string to use when logging to stdout. (Default: $format)
Format string to use when logging to syslog. (Default: %(module)s[%(process)s]: <%(levelname)s> %(message)s)


Example destinations section:

[destinations]
foo = on
bar = on
baz = off
[destinations.foo]
# using HTTP
url = http://example.org/sbws.bin
[destinations.bar]
# using HTTPS
url = https://example.com/data
[destinations.baz]
# this will be ignored
url = https://example.net/ask/stan/where/the/file/is.exe


$HOME/.sbws.ini
Default sbws user configuration path.

Any other path to the configuration file can be specified using the sbws argument -c

sbws (1), https://sbws.readthedocs.org.

Please report bugs at https://trac.torproject.org/.

Matt Traudt [sirmatt at ksu dot edu], juga [juga at riseup dot net]

CC0

November 1, 2018 1.0.2