Configuration Reference
This guide covers the essentials. Read the full upstream guide on GitHub → For a specific release, select its tag in the repository.
The repository maintains the detailed settings alongside the implementation:
- Configuration guide: settings, precedence, environment overrides, credentials, and tuning.
- Commented example TOML: the complete example to adapt.
- Catalog zones: discovery and member transfer policies.
For a file that matches your installed binary, run borondns --example-config.
Essential settings
| Setting | Purpose |
|---|---|
interfaces.dns | UDP/TCP query and NOTIFY listener addresses. |
interfaces.transfer | Optional local source sockets for outbound transfers. |
health.bind_address, health.bind_port | Explicit management HTTP bind; configure together. |
server.zone_cache_directory | Durable last-good zone state. |
[[zones]] | Static zones, primaries, NOTIFY sources, and key references. |
[[tsig_keys]] | Named transfer authentication keys. |
transfer.require_tsig | Require authentication for every static zone. |
[[catalog_zones]] | Catalog-driven member discovery. |
Configuration precedence
A mode-specific path such as serve --config takes precedence over top-level --config, then BORONDNS_CONFIG, then the default path.
Only the explicitly documented environment overrides are supported; arbitrary TOML keys cannot be converted to environment variables. Validate before restarting, and inspect --dump-config when diagnosing effective settings. See configuration for a small working structure.