Docs GitHub
-- --
Theme:
Language:
EN فا

Settings Overview#

bgscan keeps all configuration in plain TOML files inside settings/. The app also exposes these same options through the in-app Settings inspector, which writes changes back to disk automatically.

Setting files#

FilePurpose
settings/general_settings.tomlGlobal scan control and pipeline mode
settings/writer_settings.tomlResult buffering and disk writes
settings/icmp_settings.tomlICMP probe tuning
settings/tcp_settings.tomlTCP connect tuning
settings/http_settings.tomlHTTP/HTTPS/HTTP3 probe tuning
settings/xray_settings.tomlXray test tuning
settings/dns_settings.tomlDNS resolver and tunnel scan orchestration

Two ways to edit settings#

  • TOML files — open any settings/*.toml file in a text editor, change values, save, and restart bgscan. This works well under version control.
  • In-app inspector — open bgscan, navigate to Settings in the main menu, pick a category, press Enter on any field to edit it. Changes are saved immediately to disk.

Some fields are dynamic. For example, TLS-related options only show when HTTPS is selected, and DNSTT/Slipstream fields only show when those probes are enabled.

Defaults and validation#

Defaults are compiled into bgscan. A missing settings file is created with its defaults on first run, and a field absent from an existing file falls back to its default. A file that exists but cannot be parsed is an error, not a fallback.

On startup, every loaded config is validated. Out-of-range values are replaced with the default and the correction is logged, so a bad edit degrades to the default instead of failing the run.

DNS tunnel protocol settings (DNSTT, VayDNS, Slipstream) are stored in separate TOML files under assets/dns-tunneling/, not in dns_settings.toml. These are created and managed through the TUI at Main Menu → DNS Tunneling.