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.
paths
When
sbws is run as a system service,
~/.sbws is changed to
/var/lib/sbws.
- sbws_home =
STR
- sbws home directory. (Default: ~/.sbws)
- datadir =
STR
- Directory where sbws stores temporal bandwidth results files. (Default:
~/.sbws/datadir)
- v3bw_dname =
STR
- Directory where sbws stores the bandwidth list files. These are the files
to be read by the Tor Directory Authorities. (Default: ~/.sbws/v3bw)
- v3bw_fname =
STR
- File names of the bandwidth list files. The latest bandwidth file is
symlinked by latests.v3bw
- started_filepath
= STR
- File path to store the timestamp when the scanner was last started.
(Default: ~/.sbws/started_at)
- log_dname =
STR
- Directory where to store log files when logging to files is enabled.
(Default ~/.sbws/log)
tor
When
sbws is run as a system service
~/.sbws/tor is replaced by
/run/sbws/tor.
- datadir =
STR
- sbws' owned tor directory. (Default: ~/.sbws/tor)
- control_socket
= STR
- sbws's owned tor control socket file. (Default:
~/.sbws/tor/sbws/control)
- pid = STR
- sbws's owned tor pid file. (Default: ~/.sbws/tor/sbws/tor.pid)
- log = STR
- sbws's owned tor directory log files. (Default: ~/.sbws/tor/log)
- sbws's tor extra configuration. (Default: None)
- scanner
- relayprioritizer
- cleanup
- logging
- to_file = {yes,
no}
- Whether or not to log to a rotating file the directory paths.log_dname.
(Default: no)
- to_stdout = {yes,
no}
- Whether or not to log to stdout. (Default: yes)
- to_syslog = {yes,
no}
- Whether or not to log to syslog. (Default: no)
- to_file_max_bytes
= INT
- 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)
- to_file_num_backups
= INT
- If logging to file, how many backups to keep. If zero or max bytes is
zero, never rotate the log file. (Default: 50)
- level = {debug, info,
warning, error, critical}
- Level to log at. (Default: info)
- to_file_level
= {debug, info, warning, error, critical}
- Level to log at when using files. (Default: info)
- to_stdout_level
= {debug, info, warning, error, critical}
- Level to log at when using stdout. (Default: info)
- to_syslog_level
= {debug, info, warning, error, critical}
- Level to log at when using syslog. (Default: info)
- format =
STR
- Format string to use when logging. (Default: [%(asctime)s] [%(name)s]
[%(levelname)s] %(message)s)
- to_file_format
= STR
- Format string to use when logging to files. (Default: $format)
- to_stdout_format
= STR
- Format string to use when logging to stdout. (Default: $format)
- to_syslog_format
= STR
- 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]