# Yeti Switch

> Yeti Switch is an open-source, carrier-grade SIP Class 4 Session Border Controller (SBC) and softswitch with built-in real-time billing. It is designed for wholesale VoIP interconnection, prepaid/postpaid retail, and large-scale call routing, and is built on the high-performance SEMS SIP/RTP stack.

Yeti is used by ITSPs, carriers, and enterprise voice operators who need an open alternative to proprietary SBCs (Sansay, Sonus/Ribbon, Oracle/Acme Packet, AudioCodes). Core capabilities include least-cost routing (LCR) with load and capacity control, integrated wholesale and retail billing, number portability (LNP) and CNAM lookups, STIR/SHAKEN call authentication, Microsoft Teams Direct Routing, WebRTC-to-SIP gateway, a full REST API for provisioning, and a customer self-service portal.

The project is licensed under GPL, developed in the open on GitHub, and supported by a public community forum.

## Documentation

- [Documentation home](https://yeti-switch.org/docs/): top-level index of all administrative and operational documentation.
- [General information](https://yeti-switch.org/docs/): architecture overview and capabilities.
- [Changelog](https://yeti-switch.org/docs/changelog): release history and version-by-version changes.

## Installation

- [Install Yeti 1.14](https://yeti-switch.org/docs/installation/installation-1.14/): current stable installation guide.
- [Install Yeti 1.13](https://yeti-switch.org/docs/installation/installation-1.13/): previous stable installation guide.
- [Package repositories](https://yeti-switch.org/docs/installation/installation-1.14/repositories): Debian/Ubuntu APT repositories.
- [SEMS configuration](https://yeti-switch.org/docs/installation/installation-1.14/sems): the SIP/RTP media engine.

## Routing and call control

- [Routing Quick Start](https://yeti-switch.org/docs/quick-start/quick_start): end-to-end example of getting a route working.
- [Routing Plans, Dialpeers, Destinations](https://yeti-switch.org/docs/web-interface/routing/): full routing model.
- [Using Routing Tags](https://yeti-switch.org/docs/best-practices/using-routing-tags): tag-based route selection.
- [Number translations](https://yeti-switch.org/docs/best-practices/numbers-translations): number rewriting rules.
- [Headers transit](https://yeti-switch.org/docs/best-practices/headers-transit): SIP header pass-through and manipulation.
- [Emergency calls](https://yeti-switch.org/docs/quick-start/emergency): emergency call handling configuration.

## Billing

- [Billing overview](https://yeti-switch.org/docs/web-interface/billing/): accounts, services, invoices, transactions.
- [Origin-based billing](https://yeti-switch.org/docs/quick-start/origin_based_billing): origin-dependent pricing model.
- [CDR Export](https://yeti-switch.org/docs/advanced/cdr-export): exporting Call Detail Records.
- [Invoices PDF generation](https://yeti-switch.org/docs/advanced/pdf-documents): invoice templates and PDF output.

## Integration and interoperability

- [REST API](https://yeti-switch.org/docs/api/): full REST API reference for provisioning and querying.
- [STIR/SHAKEN](https://yeti-switch.org/docs/best-practices/stir-shaken): call authentication and attestation.
- [Microsoft Teams Direct Routing](https://yeti-switch.org/docs/best-practices/teams-direct-routing): Yeti as a Teams Direct Routing SBC.
- [WebRTC](https://yeti-switch.org/docs/best-practices/webrtc): WebRTC-to-SIP gateway configuration.
- [Customer Portal](https://yeti-switch.org/docs/advanced/yeti-client): white-label self-service portal for customers.
- [LDAP authentication](https://yeti-switch.org/docs/advanced/ldap): admin authentication via LDAP.

## Operations

- [PCAP storage (call trace)](https://yeti-switch.org/docs/advanced/call-trace): per-call SIP/RTP capture.
- [Monitoring](https://yeti-switch.org/docs/advanced/monitoring): metrics and observability.
- [Load Balancer](https://yeti-switch.org/docs/advanced/load-balancer): SIP load balancing in front of Yeti.
- [Database maintenance](https://yeti-switch.org/docs/advanced/database-tuning): PostgreSQL tuning for routing and CDR.
- [Data Retention](https://yeti-switch.org/docs/advanced/data-retention): retention policies for CDR and logs.
- [Troubleshooting](https://yeti-switch.org/docs/best-practices/troubleshooting): common issues and diagnostics.
- [Internal disconnect codes](https://yeti-switch.org/docs/disconnect-codes): Yeti-specific call termination codes.

## SEMS (SIP/RTP engine)

- [SEMS documentation](https://yeti-switch.org/docs/sems/index): module index.
- [SEMS configuration](https://yeti-switch.org/docs/sems/sems): main SEMS configuration reference.
- [Yeti SEMS module](https://yeti-switch.org/docs/sems/sems-module-yeti): the module that integrates SEMS with Yeti routing/billing.
- [Prometheus module](https://yeti-switch.org/docs/sems/sems-module-prometheus): metrics endpoint.
- [JSON-RPC module](https://yeti-switch.org/docs/sems/sems-module-jsonrpc): control interface.

## Project resources

- [GitHub organization](https://github.com/yeti-switch): source code for all Yeti components.
- [Community forum](https://community.yeti-switch.org): user and operator discussion.
- [Live demo](https://yeti-switch.org/demo): public demo instance.
- [Contact](https://yeti-switch.org/about_us): commercial support and contact information.