Home

Documentation

Start with the project README for an overview and the Docker Compose quick start, then come back here for depth.

Getting started

Doc	What it covers
Quick Start	Deploy the full stack with Docker Compose
supported-hardware.md	Which modems/readers work, which call modes each supports, and one-time device setup
configuration.md	Every config.toml key, with defaults, ranges, and example configs

Guides

Doc	What it covers
operations.md	Day-2 runbook: card CLI, database queries/prune/backup, troubleshooting, the VoLTE bridge reference, the SIP server mode runbook, and the outbound calling runbook
observability.md	Prometheus metrics reference, Grafana dashboard, database schema
ec20-volte-setup.md	Enabling the EC20's own modem-internal VoLTE (MBN profile deactivation, AT commands) — distinct from the host-side VoLTE bridge below
migrating-config-to-strict-parsing.md	Upgrading to strict config parsing: unknown keys now fail startup, and derived per-line fields are no longer accepted at the top level
migrating-config-reorg.md	Upgrading to the restructured config.toml ([audio]/[modem_audio] split, per-line [[vowifi.line]]/[[volte.line]])
development.md	Building from source, Makefile targets, pre-commit checks
migrating-from-v4.1.x.md	Upgrading from the C++ v4.1.x to the Rust v5.x

Architecture

Doc	What it covers
architecture.md	Crate layout, all three call flows (CS, VoWiFi, VoLTE), the two SIP-side topologies (PBX trunk or the bridge as SIP server), outbound calling, audio pipeline, multi-card/multi-line design
vowifi-bridge.md	The VoWiFi-to-SIP bridge in depth: two-agent design, codecs, control protocol
omnikey-pcsc-vowifi.md	A VoWiFi line backed by a physical PC/SC reader (e.g. OmniKey AG 3x21) instead of a modem — config, IMSI/IMEI handling, verification checklist, troubleshooting

Design notes & engineering history

Kept for the reasoning and findings, not as how-to guides.

Doc	What it covers
vowifi-epdg-research-notes.md	ePDG tunnel, IMS-AKA registration, Gm IPsec debugging, per-carrier findings (historical)
gm-ipsec-xfrm-plan.md	Design plan for the kernel-XFRM Gm IPsec implementation (implemented)
audio-tuning-log.md	Running log of modem/SIP audio parameter changes and their outcomes

Per-feature specs, plans, and task breakdowns live under specs/, one numbered directory per feature in the order it was built. RELEASE_NOTES.md says what each one changed for an operator.