data_period = INT

Days into the past that measurements are considered valid. (Default: 5)

http_timeout = INT

Timeout in seconds to give to the python Requests library. (Default: 10)

circuit_timeout = INT

Timeout in seconds to create circuits. (Default: 60)

reset_bw_ipv4_changes = {on, off}

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: off)

reset_bw_ipv6_changes = off

NOT implemented for IPv6.

When sbws is run as a system service, ~/.sbws is changed to /var/lib/sbws.

It is required to set at least one destination for the scanner to run. It is recommended to set several destinations so that the scanner can continue if one fails.

url = STR

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

verify = BOOL

Whether or not to verify the destination certificate. (Default: True)

country = STR

ISO 3166-1 alpha-2 country code. Use ZZ if the destination URL is a domain name and it is in a CDN.

When sbws is run as a system service ~/.sbws/tor is replaced by /run/sbws/tor.

nickname = STR

A human-readable string with chars in a-zA-Z0-9 to identify the scanner. (Default: IDidntEditTheSBWSConfig)

country = STR

ISO 3166-1 alpha-2 country code. (Default: AA, a non existing country to detect it was not edited)

download_toofast = INT

Limits on what download times are too fast/slow/etc. (Default: 1)

download_min = INT

Limits on what download times are too fast/slow/etc. (Default: 5)

download_target = INT

Limits on what download times are too fast/slow/etc. (Default: 6)

download_max = INT

Limits on what download times are too fast/slow/etc. (Default: 10)

num_rtts = INT

How many RTT measurements to make. (Default: 0)

num_downloads = INT

Number of downloads with acceptable times we must have for a relay before moving on. (Default: 5)

initial_read_request = INT

The number of bytes to initially request from the server. (Default: 16384)

measurement_threads = INT

How many measurements to make in parallel. (Default: 3)

min_download_size = INT

Minimum number of bytes we should ever try to download in a measurement. (Default: 1)

max_download_size = INT

Maximum number of bytes we should ever try to download in a measurement. (Default: 1073741824) 1073741824 == 1 GiB

measure_authorities = {on, off}

Whether or not to measure authorities. (Default: off)

fraction_relays = FLOAT

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)

min_relays = INT

The minimum number of best priority relays we are willing to return. (Default: 50)

data_files_compress_after_days = INT

After this many days, compress data files. (Default: 29)

data_files_delete_after_days = INT

After this many days, delete data files. (Default: 57)

v3bw_files_compress_after_days = INT

After this many days, compress v3bw files. (Default: 1)

v3bw_files_delete_after_days = INT

After this many days, delete v3bw files. (Default: 7)

to_file = {yes, no}

Whether or not to log to a rotating file the directory paths.log_dname. (Default: yes)

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) NOTE that when sbws is launched by systemd, stdout goes to journal and syslog.

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: debug)

to_file_level = {debug, info, warning, error, critical}

Level to log at when using files. (Default: debug)

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 %(module)s[%(process)s]: <%(levelname)s> %(message)s)

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)

to_file_format = STR

Format string to use when logging to files. (Default: %(asctime)s %(levelname)s %(threadName)s %(filename)s:%(lineno)s - %(funcName)s - %(message)s)

[scanner]
nickname = Manual
country = US
[destinations]
foo = on
bar = on
baz = off
[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