rustpbx 0.4.8

A SIP PBX implementation in Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

# RustPBX Configuration Overview

## Configuration Sources
RustPBX loads configuration in the following order of precedence:
1. **Command Line arguments**: e.g. `--conf my_config.toml`
2. **Main Config File**: `rustpbx.toml` (or custom path)
3. **Partial Config Files**: Loaded via glob patterns defined in main config (e.g. `trunks_files`, `routes_files`).
4. **Generated Configs**: Automatically loaded from `generated_dir` if present (managed by UI/API).

## Directory Structure
By default, the system assumes a `config` folder exists next to the binary:

```toml
[proxy]
# Root for generated configs (default: ./config)
generated_dir = "./config"
# Explicit overrides for file patterns
routes_files = ["config/routes/*.toml"]
trunks_files = ["config/trunks/*.toml"]
acl_files = ["config/acl/*.toml"]
```

## Reload Behavior
Changes to `rustpbx.toml` usually require a restart. However, **Trunks**, **Queues**, **Routes**, and **ACLs** can be reloaded at runtime without dropping active calls via the Admin Console or API.

## Addon System
Addons (like Wholesale, Queue, Transcript) are enabled in the `[proxy]` section but configured in their own namespaces.

```toml
[proxy]
addons = ["wholesale", "queue"]

# Addon-specific configuration map
[addons.wholesale]
license = "key-123"
```

## Configuration Reference

| # | File | Topics |
|---|---|---|
| 01 | [Platform & Networking](01-platform.md) | HTTP/HTTPS, ports, TLS, external IP |
| 02 | [Proxy Core](02-proxy-core.md) | SIP stack, realms, locators, dialplan |
| 03 | [Auth & Users](03-auth-users.md) | User accounts, passwords, RBAC |
| 04 | [Routing](04-routing.md) | Route rules, pattern matching |
| 05 | [Trunks & Queues](05-trunks-queues.md) | SIP trunks, call queues |
| 06 | [Media & Recording](06-media-recording.md) | RTP proxy, codecs, call recording, CDR |
| 07 | [Addons, Console & Storage](07-addons-admin-storage.md) | Web console, AMI, blob storage |
| 08 | [SipFlow](08-sipflow.md) | SIP flow capture, optional RTP recording, query API |