RustPBX Overview
RustPBX is a cloud-native PBX written in Rust for voice AI, contact center, and enterprise telephony workloads. It emphasizes stability, low latency, and observability while keeping modules decoupled so you can extend the platform as needed. This overview highlights the capabilities you should understand before rolling out the system.
Platform Positioning
- Unified voice plane: SIP signaling, media proxying, call records, billing, and access control live in one runtime.
- Config-driven architecture: behavior is authored through TOML files and database entities, which works well with DevOps/GitOps pipelines.
- AI-ready: directories such as
llm/andaddons/expose hooks for voice bots, bulk outbound services, and certificate automation.
(Insert a “system overview” diagram here if desired.)
Core Module Map
| Directory / Module | Responsibilities |
|---|---|
src/call/ | Call control, IVR logic, policies, and per-call state machines |
src/proxy/ | SIP proxying, ACL enforcement, active call registry |
src/models/ | Database entities for billing, routing, queues, extensions, etc. |
src/console/ | Web console APIs, middleware, authentication |
config/ | Runtime configuration for trunks, routes, queues, ACLs |
addons/ | Optional plugins such as wholesale routing or ACME |
Typical Workflow
- Prepare the environment: deploy via container or bare metal and complete the steps in “Basic Setup.”
- Build connectivity: add SIP trunks, routing policies, and billing templates (“Routing, Trunk & Billing”).
- Distribute traffic: configure extensions, queues, and policies so calls reach the right destination (“Extension Management”).
- Monitor & diagnose: rely on Diagnostics, logs, and health probes to validate changes (“Diagnostics” & “Operations Manual”).
- Operate continuously: edit
config.tomlfor advanced features and use “Troubleshooting” when incidents occur.
Documentation Map
- Basic Setup: deployment, initialization, and the first trunk.
- Routing, Trunk & Billing: end-to-end line management and billing practices.
- Extension Management: agent accounts, device settings, and quotas.
- Diagnostics: reload workflow, route evaluation, health checks, and logging aids.
- Operations Manual: daily routines, rollout processes, backups, compliance.
- Technical Specs: compatibility notes, performance guidance, extension points.
- Troubleshooting: categorized issues with recommended recovery steps.
Read sequentially or jump directly to the chapter that matches your current task.