RustPBX Configuration Guide

June 25, 2026 ยท View on GitHub

RustPBX configuration is split into several logical sections. The application loads its main configuration from rustpbx.toml by default, or from a path specified by the --conf argument. The format is TOML.

  1. Overview & Concepts
    File structure, reload behavior, generated configs.

  2. Platform & Networking
    HTTP, Logging, Database, RTP, NAT, ICE.

  3. Proxy Core
    Binding ports, Transport (UDP/TCP/TLS/WS), Concurrency, Modules.

  4. Authentication & Users
    User Backends (Memory, DB, HTTP), Locators, Realms.

  5. Routing
    Static Routes, Regex Matching, Rewrites, HTTP Dynamic Router.

  6. Trunks & Queues
    SIP Gateways, Load Balancing, Queue Strategies, Agent Management.

  7. Media, Recording & CDR
    Media Proxy, Recording Policies, Storage Backends (Local/S3).

  8. Addons, Console & Admin
    Web Console, AMI, Archiving, Wholesale & Custom Addons.

  9. SipFlow
    SIP signalling capture, RTP recording, Storage backends, WAV export.