====== Kamailio SIP Server Documentation Wiki ====== **NOTE: This wiki portal is in READ ONLY mode and kept for archiving purpose. It will not be updated as of June 10, 2022.** **The wiki content has been migrated to markdown and it is hosted on github at:** * **https://github.com/kamailio/kamailio-wiki** **Contributions to wiki content must be done via pull requests to the github repository.** The new wiki content can be browsed in html format at: * **https://www.kamailio.org/wikidocs/** ---- ---- ---- //IMPORTANT: For a cleaner presentation, the front page in this wiki site is linking the documents for latest stable versions, 4.3 or newer, respectively the installation and upgrade tutorials, new features, a.s.o... For older releases, 3.2.x to 4.2.x, go to **Older Releases Index**:// * [[content:old-releases|Link To Content For Older Releases]] //IMPORTANT: Content for older releases than 3.2.0 is available at the **Old Wiki Site**:// * [[https://www.kamailio.org/dokuwiki/|Link To Old Wiki Site]] ===== Installation ===== ==== Installation from GIT Sources ==== * [[https://kamailio.org/docs/tutorials/devel/kamailio-install-guide-git/|Install Kamailio Devel Version From GIT (html)]] * [[install:devel:git|Install Kamailio Devel Version From GIT (wiki)]] * [[https://kamailio.org/docs/tutorials/5.5.x/kamailio-install-guide-git/|Install Kamailio v5.5.x From GIT (html)]] * [[https://kamailio.org/docs/tutorials/5.4.x/kamailio-install-guide-git/|Install Kamailio v5.4.x From GIT (html)]] * [[https://kamailio.org/docs/tutorials/5.3.x/kamailio-install-guide-git/|Install Kamailio v5.3.x From GIT (html)]] * [[https://kamailio.org/docs/tutorials/5.2.x/kamailio-install-guide-git/|Install Kamailio v5.2.x From GIT (html)]] * [[https://kamailio.org/docs/tutorials/5.1.x/kamailio-install-guide-git/|Install Kamailio v5.1.x From GIT (html)]] * [[https://kamailio.org/docs/tutorials/5.0.x/kamailio-install-guide-git/|Install Kamailio v5.0.x From GIT (html)]] * [[install:4.4.x:git|Install Kamailio v4.4.x From GIT]] * [[install:4.3.x:git|Install Kamailio v4.3.x From GIT]] ==== Installation By Building Packages ==== * [[install:4.0.x:debian|Install Kamailio v4.0.x By Building Debian Packages]] * [[install:3.2.x:debian|Install Kamailio v3.2.x By Building Debian Packages]] ==== Installation From Packages ==== * [[https://kamailio.org/docs/tutorials/devel/kamailio-install-guide-deb/|Install Kamailio On Debian Or Ubuntu (html)]] * [[install:stable:debian|Install Kamailio On Debian]] ==== Installation On Containers ==== * [[install:container:docker|Install Kamailio On Docker]] * [[https://github.com/ghrst/Kamailio-HA|Install Kamailio using Ansible and Docker]] ==== Upgrade ==== * [[install:upgrade:stable-to-devel|Upgrade Kamailio stable to devel]] * [[install:upgrade:5.4.x-to-5.5.0|Upgrade Kamailio v5.4.x to v5.5.0]] * [[install:upgrade:5.3.x-to-5.4.0|Upgrade Kamailio v5.3.x to v5.4.0]] * [[install:upgrade:5.2.x-to-5.3.0|Upgrade Kamailio v5.2.x to v5.3.0]] * [[install:upgrade:5.1.x-to-5.2.0|Upgrade Kamailio v5.1.x to v5.2.0]] * [[install:upgrade:5.0.x-to-5.1.0|Upgrade Kamailio v5.0.x to v5.1.0]] * [[install:upgrade:4.4.x-to-5.0.0|Upgrade Kamailio v4.4.x to v5.0.0]] * [[install:upgrade:4.3.x-to-4.4.0|Upgrade Kamailio v4.3.x to v4.4.0]] ===== Download ===== * [[https://www.kamailio.org/w/download/|Main Download Page]] * [[https://www.kamailio.org/pub/kamailio/latest/src/|Download Tarball with Sources of Latest Stable Release]] * [[download:v5.4.x-from-git|Download Sources of v5.4.x from GIT Repository]] * [[download:v5.3.x-from-git|Download Sources of v5.3.x from GIT Repository]] * [[download:v5.2.x-from-git|Download Sources of v5.2.x from GIT Repository]] * [[download:v5.1.x-from-git|Download Sources of v5.1.x from GIT Repository]] * [[download:v5.0.x-from-git|Download Sources of v5.0.x from GIT Repository]] * [[download:v4.4.x-from-git|Download Sources of v4.4.x from GIT Repository]] * [[download:v4.3.x-from-git|Download Sources of v4.3.x from GIT Repository]] ==== Linux - Unix Distributions ==== * [[packages:debs|DEBS: Debian - Ubuntu]] * [[packages:rpms|RPMS: CentOS - RedHat - Fedora - OpenSUSE]] * [[packages:alpinelinux|AlpineLinux]] ===== Cookbooks ===== \\ | Version ^ Core Cookbook ^ Pseudo Variables ^ Transformations ^ Selects ^ Modules ^ ^ devel | [[cookbooks:devel:core|link]] | [[cookbooks:devel:pseudovariables|link]] | [[cookbooks:devel:transformations|link]] | [[cookbooks:devel:selects|link]] | [[https://kamailio.org/docs/modules/devel/|link]] | ^ 5.5.x | [[cookbooks:5.5.x:core|link]] | [[cookbooks:5.5.x:pseudovariables|link]] | [[cookbooks:5.5.x:transformations|link]] | [[cookbooks:5.5.x:selects|link]] | [[https://kamailio.org/docs/modules/5.5.x/|link]] | ^ 5.4.x | [[cookbooks:5.4.x:core|link]] | [[cookbooks:5.4.x:pseudovariables|link]] | [[cookbooks:5.4.x:transformations|link]] | [[cookbooks:5.4.x:selects|link]] | [[https://kamailio.org/docs/modules/5.4.x/|link]] | ^ 5.3.x | [[cookbooks:5.3.x:core|link]] | [[cookbooks:5.3.x:pseudovariables|link]] | [[cookbooks:5.3.x:transformations|link]] | [[cookbooks:5.3.x:selects|link]] | [[https://kamailio.org/docs/modules/5.3.x/|link]] | ^ 5.2.x | [[cookbooks:5.2.x:core|link]] | [[cookbooks:5.2.x:pseudovariables|link]] | [[cookbooks:5.2.x:transformations|link]] | [[cookbooks:5.2.x:selects|link]] | [[https://kamailio.org/docs/modules/5.2.x/|link]] | ^ 5.1.x | [[cookbooks:5.1.x:core|link]] | [[cookbooks:5.1.x:pseudovariables|link]] | [[cookbooks:5.1.x:transformations|link]] | [[cookbooks:5.1.x:selects|link]] | [[https://kamailio.org/docs/modules/5.1.x/|link]] | ^ 5.0.x | [[cookbooks:5.0.x:core|link]] | [[cookbooks:5.0.x:pseudovariables|link]] | [[cookbooks:5.0.x:transformations|link]] | [[cookbooks:5.0.x:selects|link]] | [[https://kamailio.org/docs/modules/5.0.x/|link]] | ^ 4.4.x | [[cookbooks:4.4.x:core|link]] | [[cookbooks:4.4.x:pseudovariables|link]] | [[cookbooks:4.4.x:transformations|link]] | [[cookbooks:4.4.x:selects|link]] | [[https://kamailio.org/docs/modules/4.4.x/|link]] | ^ 4.3.x | [[cookbooks:4.3.x:core|link]] | [[cookbooks:4.3.x:pseudovariables|link]] | [[cookbooks:4.3.x:transformations|link]] | [[cookbooks:4.3.x:selects|link]] | [[https://kamailio.org/docs/modules/4.3.x/|link]] | \\ ===== Alphabetic Indexes ===== Alphabetic indexes generated from documentation (modules' readme docs). \\ | Version ^ Modules Parameters ^ Modules Functions ^ RPC Commands ^ Statistics ^ ^ devel | [[alphaindexes:devel:modparameters|link]] | [[alphaindexes:devel:modfunctions|link]] | [[alphaindexes:devel:rpccommands|link]] | [[alphaindexes:devel:modstatistics|link]] | ^ 5.5.x | [[alphaindexes:5.5.x:modparameters|link]] | [[alphaindexes:5.5.x:modfunctions|link]] | [[alphaindexes:5.5.x:rpccommands|link]] | [[alphaindexes:5.5.x:modstatistics|link]] | ^ 5.4.x | [[alphaindexes:5.4.x:modparameters|link]] | [[alphaindexes:5.4.x:modfunctions|link]] | [[alphaindexes:5.4.x:rpccommands|link]] | [[alphaindexes:5.4.x:modstatistics|link]] | ^ 5.3.x | [[alphaindexes:5.3.x:modparameters|link]] | [[alphaindexes:5.3.x:modfunctions|link]] | [[alphaindexes:5.3.x:rpccommands|link]] | [[alphaindexes:5.3.x:modstatistics|link]] | ^ 5.2.x | [[alphaindexes:5.2.x:modparameters|link]] | [[alphaindexes:5.2.x:modfunctions|link]] | [[alphaindexes:5.2.x:rpccommands|link]] | [[alphaindexes:5.2.x:modstatistics|link]] | ^ 5.1.x | [[alphaindexes:5.1.x:modparameters|link]] | [[alphaindexes:5.1.x:modfunctions|link]] | [[alphaindexes:5.1.x:rpccommands|link]] | [[alphaindexes:5.1.x:modstatistics|link]] | ^ 5.0.x | [[alphaindexes:5.0.x:modparameters|link]] | [[alphaindexes:5.0.x:modfunctions|link]] | [[alphaindexes:5.0.x:rpccommands|link]] | [[alphaindexes:5.0.x:modstatistics|link]] | \\ | Version ^ Modules Parameters ^ Modules Functions ^ MI Commands ^ Statistics ^ RPC Commands (List) ^ ^ 4.4.x | [[alphaindexes:4.4.x:modparameters|link]] | [[alphaindexes:4.4.x:modfunctions|link]] | [[alphaindexes:4.4.x:micommands|link]] | [[alphaindexes:4.4.x:modstatistics|link]] | [[https://www.kamailio.org/docs/docbooks/4.4.x/rpc_list/rpc_list.html|link]] | ^ 4.3.x | [[alphaindexes:4.3.x:modparameters|link]] | [[alphaindexes:4.3.x:modfunctions|link]] | [[alphaindexes:4.3.x:micommands|link]] | [[alphaindexes:4.3.x:modstatistics|link]] | [[https://www.kamailio.org/docs/docbooks/4.3.x/rpc_list/rpc_list.html|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 | [[https://www.kamailio.org/docs/docbooks/devel/rpc_list/rpc_list.html|link]] | [[https://www.kamailio.org/docs/docbooks/devel/cfg_var_list/cfg_var_list.html|link]] | [[https://www.kamailio.org/docs/docbooks/devel/select_list/select_list.html|link]] | [[https://www.kamailio.org/docs/docbooks/devel/counter_list/counter_list.html|link]] | ^ 5.0.x | [[https://www.kamailio.org/docs/docbooks/5.0.x/rpc_list/rpc_list.html|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.4.x: https://kamailio.org/docs/tutorials/5.4.x/kamailio-kemi-framework/ ===== Features ===== * [[features:new-in-devel|New Features in Devel Version]] * [[features:new-in-5.5.x|New Features in Release 5.5.x]] * [[features:new-in-5.4.x|New Features in Release 5.4.x]] * [[features:new-in-5.3.x|New Features in Release 5.3.x]] * [[features:new-in-5.2.x|New Features in Release 5.2.x]] * [[features:new-in-5.1.x|New Features in Release 5.1.x]] * [[features:new-in-5.0.x|New Features in Release 5.0.x]] * [[features:new-in-4.4.x|New Features in Release 4.4.x]] * [[features:new-in-4.3.x|New Features in Release 4.3.x]] ===== Tutorials ===== * [[tutorials:3.2.x:syslog|Kamailio and Syslog with Log Rotate]] * [[tutorials:tls:testing-and-debugging|Testing and Debugging TLS Connections]] * [[tutorials:faq:main|Frequently Asked Questions]] * [[tutorials:dns:dnssec|Kamailio with DNSSEC]] * [[tutorials:mini-howto-admin:main|Mini HowTo Tutorials]] * [[tutorials:IMS:installation-howto|Howto install and configure IMS with Kamailio]] * [[tutorials:auth:auth_db|Howto setup auth_db and usrloc]] * [[tutorials:tls:howto-openssl-1-0|Howto switch to OpenSSL 1.0 for TLS Connections]] * [[tutorials:troubleshooting:memory|Troubleshooting - Memory]] * [[tutorials:troubleshooting:coredumpfile|Troubleshooting - Core Dump File]] * [[tutorials:getting-started:main|Getting Started]] * [[tutorials:kamailio-and-mongodb|Kamailio and MongoDB]] * [[tutorials:kamailio-startup-scripts|Kamailio Startup Scripts]] * [[tutorials:kamailio-flag-operations| Kamailio Flag Operations]] ==== Security related tutorials ==== * [[tutorials:Security:Security-threats|Overview of Security issues for SIP routers]] * [[tutorials:Security:Kamailio-Security|Overview of Security related config snippets]] ==== External Tutorials ==== * [[http://kb.asipto.com/asterisk:index|Kamailio and Asterisk Integration]] * [[http://kb.asipto.com/freeswitch:index|Kamailio and FreeSwitch Integration]] * [[http://kb.asipto.com/kamailio:index|Various Kamailio Use Case Tutorials]] ==== Database Structure ==== * [[https://www.kamailio.org/docs/db-tables/kamailio-db-devel.html|Devel Version]] * [[https://www.kamailio.org/docs/db-tables/kamailio-db-5.2.x.html|5.2.x Version]] * [[https://www.kamailio.org/docs/db-tables/kamailio-db-5.1.x.html|5.1.x Version]] * [[https://www.kamailio.org/docs/db-tables/kamailio-db-5.0.x.html|5.0.x Version]] * [[https://www.kamailio.org/docs/db-tables/kamailio-db-4.4.x.html|4.4.x Version]] * [[https://www.kamailio.org/docs/db-tables/kamailio-db-4.3.x.html|4.3.x Version]] ===== Development ===== ==== Development APIs ==== * [[https://www.kamailio.org/docs/docbooks/3.2.x/rpc_api/rpc_api.html|RPC Control Interface - API]] * [[https://www.asipto.com/pub/kamailio-devel-guide/|Kamailio Development Guide]] ==== Embedded APIs ==== See the section about KEMI exports. Old Exports APIs: \\ | Version ^ - Java - ^ - Lua - ^ - Mono - ^ - Perl - ^ - Python - ^ ^ devel | [[embeddedapi:devel:java|link]] | [[embeddedapi:devel:lua|link]] | [[embeddedapi:devel:mono|link]] | [[embeddedapi:devel:perl|link]] | [[embeddedapi:devel:python|link]] | ^ 4.3.x | [[embeddedapi:4.3.x:java|link]] | [[embeddedapi:4.3.x:lua|link]] | [[embeddedapi:4.3.x:mono|link]] | [[embeddedapi:4.3.x:perl|link]] | [[embeddedapi:4.3.x:python|link]] | \\ ==== Guidelines ==== * [[https://asipto.com/u/kdg|Kamailio SIP Server v3.2.x Devel Guide]] * [[devel:backporting-to-3.2.x|Backporting Patches from Devel Branch to 3.2.x]] * [[devel:git-commit-guidelines|GIT Commit Guidelines]] * [[devel:github-contributions|Contributions via Github]] * [[devel:update-database-schema|Update Database Schema]] * [[devel:how-to:main|Mini How-To Guides for Development]] * [[devel:module-docbook-readme|Writing Docbook Files for Module Readme]] * [[devel:git-access|Developer Git Access]] * [[security:policy|Process for handling Security Vulnerabilities]] * [[devel:config-engines|Configuration File Engines]] * [[devel:troubleshooting-gdb-scripts|Troubleshooting - GDB Scripts]] ==== Misc ==== * [[devel:new-features-requests|New Features Requests]] * [[devel:active-contributors|Contributors - List of Active Developers]] * [[devel:irc-meetings|Online IRC Development Meetings]] * [[devel:makefile-system|Makefile System]] * [[https://www.kamailio.org.cn|Kamailio Chinese Community-中国社区]] * [[scripts:toc|Various Scripts]] * [[devel:kamailio-5.0-design|Kamailio v5.0 Design]] * [[https://kamailio.org/docs/tutorials/devel/kamailio-kemi-framework/|Kamailio KEMI Framework Tutorial]] * [[devel:config-engines|KEMI Configuration File Engines]] * [[history:09-years-ser-kamailio|History - 9 Years of SER-Kamailio]] * [[history:15-years-ser-kamailio|History - 15 Years of SER-Kamailio]] * [[https://www.kamailio.org/events/|Kamailio related event presentation archive]] * [[kemi:performances|KEMI Performances]] ===== Disclaimer ===== The dokuwiki is left open for contribution to anybody but may be abused by malicious people out there. Hence, the content of the dokuwiki page may have //illegal// content at some points in time. Please report such cases as soon as you see them at //sr-dev@lists.kamailio.org//. Kamailio.org is not responsible for the content in the dokuwiki pages.