Skip to content

Rewrite docs and fix health endpoint for trunk-host-only mode#3

Merged
amenophis1er merged 2 commits into
mainfrom
docs/update-readme-guide-api-reference
Mar 15, 2026
Merged

Rewrite docs and fix health endpoint for trunk-host-only mode#3
amenophis1er merged 2 commits into
mainfrom
docs/update-readme-guide-api-reference

Conversation

@amenophis1er

Copy link
Copy Markdown
Contributor

Summary

  • README rewrite: Rebalanced to cover all three connection modes equally (extension, trunk client, trunk host) instead of being SIP-trunk-heavy. Punchy tagline, better "Why xbridge?" section, accurate feature table.
  • Integration guide rewrite: New "Choose a Connection Mode" section, native binary mode examples throughout, corrected pipeline start pattern (call.answered webhook), STUN config typo fix.
  • API reference update: Renamed "SIP Trunks" → "SIP Client" with clarified description, rewrote "Trunk Host (Server)" with full field tables documenting rtp_address, hosts (CIDR ranges), per-peer rtp_address override.
  • Health endpoint fix: Previously returned "starting" in trunk-host-only mode because it only checked SIP client registrations. Now also checks trunk host server status. Added sip_server boolean field to response.
  • Config example update: Added rtp_address, hosts (CIDR), and per-peer rtp_address fields. Clarified SIP block works for both PBX extensions and cloud providers.

Test plan

  • cargo test — all 20 tests pass
  • Verify health endpoint returns "ok" in trunk-host-only mode
  • Review README, guide, and API reference for accuracy and readability

Amen added 2 commits March 14, 2026 21:25
- Rewrite README to balance all three connection modes (extension, trunk
  client, trunk host) instead of being trunk-heavy
- Rewrite integration guide with connection mode selection, native binary
  mode examples, and corrected pipeline start pattern
- Update API reference: rename SIP Trunks → SIP Client, add full Trunk
  Host field tables (rtp_address, hosts/CIDR, per-peer overrides)
- Fix health endpoint returning "starting" in trunk-host-only mode by
  also checking xphone_server status; add sip_server field to response
- Update config.example.yaml with rtp_address, hosts, and per-peer
  rtp_address fields; clarify SIP block works for both PBX and cloud
@amenophis1er amenophis1er merged commit a1581f6 into main Mar 15, 2026
1 check passed
@amenophis1er amenophis1er deleted the docs/update-readme-guide-api-reference branch March 15, 2026 01:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant