Skip to main content

Module config

Module config 

Source

Functions§

clearnet_url
huddle 1.0: optional clearnet relay URL — a ws://<ip>:<port>/ws or wss://host/ws door onto the SAME relay backend as the onion. Lets users behind a VPN (or where Tor is blocked) reach the relay directly and fast. The scheme decides which clearnet door (plain / TLS) is used.
config_path
Phase D: location of the user’s optional config file. We use dirs::config_dir() rather than data_dir() so this lives in the platform-appropriate “preferences” directory (macOS ~/Library/Application Support, Linux ~/.config, Windows %APPDATA%). Doesn’t have to exist — load_relays returns an empty list if absent.
data_dir
db_path
ensure_data_dir
identity_key_path
load_relays
Phase D: parse the relay multiaddr list from the config file. The documented form (README + MANUAL_TESTING §14) is a top-level array:
log_path
server_url
huddle 0.8: optional override for the centralized server (a Tor-onion relay) WebSocket URL, read from config.toml:
tor_bridge
huddle 1.0: optional Tor bridge line for the bridge door (to reach Tor where it’s blocked). With the arti build this is passed to the embedded Tor; otherwise it documents that your system Tor should carry this bridge.
tor_socks
huddle 0.8: optional override for the local Tor SOCKS5 proxy address used to reach .onion server URLs (default 127.0.0.1:9050). Set in config.toml as tor_socks = "127.0.0.1:9150" — e.g. to use the Tor Browser bundle’s port. --tor-socks overrides this. None if absent.