Kamailio SIP Server Documentation Wiki
π Contributions are very much appreciated! Use pull requests to add or update content of this repository.
The wiki content is also available in HTML format:
Few guidelines to edit the wiki:
- everyone is welcome to add useful content to the wiki
- use a sub-folder per category when adding new pages
- if there is subfolder that matches the new page topic, add it inside it, eventually create there a new sub-folder if you want to narrow down to a sub-category
- if you add many pages for the same subject, group them under same sub-folder
- if you are not sure that the content is entirely correct, send an email to mailing list sr-users (at) lists.sip-router.org asking for review
π₯ IMPORTANT: For a cleaner presentation, the front page in this wiki site is linking the documents for latest stable versions, 5.2 or newer, respectively the installation and upgrade tutorials, new features, a.s.o... For older releases, 3.2.x to 5.1.x, go to Older Releases Index:
π₯ IMPORTANT: Content for older releases than 3.2.0 is available at the Old Wiki Site:
Installation
Installation from GIT Sources
- Install Kamailio Devel Version From GIT (html)
- Install Kamailio Devel Version From GIT (wiki)
- Install Kamailio v5.8.x From GIT (html)
- Install Kamailio v5.7.x From GIT (html)
- Install Kamailio v5.6.x From GIT (html)
- Install Kamailio v5.5.x From GIT (html)
- Install Kamailio v5.4.x From GIT (html)
- Install Kamailio v5.3.x From GIT (html)
- Install Kamailio v5.2.x From GIT (html)
Installation By Building Packages
- Install Kamailio v4.0.x By Building Debian Packages
- Install Kamailio v3.2.x By Building Debian Packages
Installation From Packages
Installation On Containers
Upgrade
- Upgrade Kamailio stable to devel
- Upgrade Kamailio v5.7.x to v5.8.0
- Upgrade Kamailio v5.6.x to v5.7.0
- Upgrade Kamailio v5.5.x to v5.6.0
- Upgrade Kamailio v5.4.x to v5.5.0
- Upgrade Kamailio v5.3.x to v5.4.0
- Upgrade Kamailio v5.2.x to v5.3.0
Download
- Main Download Page
- Download Tarball with Sources of Latest Stable Release
- Download Sources of v5.8.x from GIT Repository
- Download Sources of v5.7.x from GIT Repository
- Download Sources of v5.6.x from GIT Repository
- Download Sources of v5.5.x from GIT Repository
- Download Sources of v5.4.x from GIT Repository
- Download Sources of v5.3.x from GIT Repository
- Download Sources of v5.2.x from GIT Repository
Linux - Unix Distributions
Cookbooks
| Version | Core Cookbook | Pseudo Variables | Transformations | Selects | Modules |
| devel | link | link | link | link | link |
| 5.8.x | link | link | link | link | link |
| 5.7.x | link | link | link | link | link |
| 5.6.x | link | link | link | link | link |
| 5.5.x | link | link | link | link | link |
| 5.4.x | link | link | link | link | link |
| 5.3.x | link | link | link | link | link |
| 5.2.x | link | link | link | link | link |
Alphabetic Indexes
Alphabetic indexes generated from documentation (modules' readme docs).
| Version | Modules Parameters | Modules Functions | RPC Commands | Statistics |
| devel | link | link | link | link |
| 5.8.x | link | link | link | link |
| 5.7.x | link | link | link | link |
| 5.6.x | link | link | link | link |
| 5.5.x | link | link | link | link |
| 5.4.x | link | link | link | link |
| 5.3.x | link | link | link | link |
| 5.2.x | link | link | link | link |
C Code Export Lists
Lists of exported symbols generated from C code.
| Version | RPC Commands List | Cfg Vars List | Selects List | Counters List |
| devel | link | link | link | link |
| 5.0.x | link | --- | --- | --- |
KEMI Framework
Documentation and functions exported to KEMI framework, that can be used in embedded Lua/Python/JavaScript/Ruby/... SIP routing scripts:
- Development: https://kamailio.org/docs/tutorials/devel/kamailio-kemi-framework/
- Version 5.8.x: https://kamailio.org/docs/tutorials/5.8.x/kamailio-kemi-framework/
- Version 5.7.x: https://kamailio.org/docs/tutorials/5.7.x/kamailio-kemi-framework/
- Version 5.6.x: https://kamailio.org/docs/tutorials/5.6.x/kamailio-kemi-framework/
- Version 5.5.x: https://kamailio.org/docs/tutorials/5.5.x/kamailio-kemi-framework/
- Version 5.4.x: https://kamailio.org/docs/tutorials/5.4.x/kamailio-kemi-framework/
Features
- New Features in Devel Version
- New Features in Release 5.8.x
- New Features in Release 5.7.x
- New Features in Release 5.6.x
- New Features in Release 5.5.x
- New Features in Release 5.4.x
- New Features in Release 5.3.x
- New Features in Release 5.2.x
Tutorials
- Kamailio and Syslog with Log Rotate
- Testing and Debugging TLS Connections
- Frequently Asked Questions
- Kamailio with DNSSEC
- Mini HowTo Tutorials
- Howto install and configure IMS with Kamailio
- Howto setup auth_db and usrloc
- Howto switch to OpenSSL 1.0 for TLS Connections
- Troubleshooting - Memory
- Troubleshooting - Core Dump File
- Getting Started
- Kamailio and MongoDB
- Kamailio Startup Scripts
- Kamailio Flag Operations
Security related tutorials
External Tutorials
- Kamailio and Asterisk Integration
- Kamailio and FreeSwitch Integration
- Various Kamailio Use Case Tutorials
Database Structure
- Devel Version
- 5.8.x Version
- 5.7.x Version
- 5.6.x Version
- 5.5.x Version
- 5.4.x Version
- 5.3.x Version
- 5.2.x Version
Development
Development APIs
Embedded APIs
See the section about KEMI exports.
Old Exports APIs:
| Version | - Java - | - Lua - | - Mono - | - Perl - | - Python - |
| devel | link | link | link | link | link |
| 4.3.x | link | link | link | link | link |
Guidelines
- Kamailio SIP Server v3.2.x Devel Guide
- Backporting Patches from Devel Branch to 3.2.x
- GIT Commit Guidelines
- Contributions via Github
- Update Database Schema
- Mini How-To Guides for Development
- Writing Docbook Files for Module Readme
- Developer Git Access
- Process for handling Security Vulnerabilities
- Configuration File Engines
- Troubleshooting - GDB Scripts
Misc
- New Features Requests
- Contributors - List of Active Developers
- Online IRC Development Meetings
- Makefile System
- Kamailio Chinese Community-δΈε½η€ΎεΊ
- Various Scripts
- Kamailio v5.0 Design
- Kamailio KEMI Framework Tutorial
- KEMI Configuration File Engines
- History - 9 Years of SER-Kamailio
- History - 15 Years of SER-Kamailio
- Kamailio related event presentation archive
- KEMI Performances
Disclaimer
π The initial content was migrated to github.com from an open wiki portal, where people could contribute without any restrictions. Should anyone notice any illegal content please email to sr-dev@lists.kamailio.org or open an issue. kamailio.org organization is not responsible for the content contributed by external people and commits to react in a reasonable time when such content is reported.