====== Kamailio (OpenSER) Documentation Factory ====== ===== Cookbooks References ===== * Kamailio (OpenSER) Core CookBook - statements, functions and parameters of the Kamailio (OpenSER) core. * Kamailio (OpenSER) Pseudo-variables - access and assign content of SIP messages and other information. * Kamailio (OpenSER) Transformations - modify pseudo-variables. \\ | Core documentation ^ Core cookbook ^ Pseudo-variables ^ Transformations ^ Selects ^ ^ Development version | [[http://sip-router.org/wiki/cookbooks/core-cookbook/devel|link]] | [[http://sip-router.org/wiki/cookbooks/pseudo-variables/devel|link]] | [[http://sip-router.org/wiki/cookbooks/transformations/devel|link]] | [[http://sip-router.org/wiki/cookbooks/selects/devel|link]] | ^ 3.0.x version | [[core-cookbook:3.0.x|link]] | [[pseudovariables:3.0.x|link]] | [[transformations:3.0.x|link]] | [[selects:3.0.x|link]] | ^ 1.5.x version | [[core-cookbook:1.5.x|link]] | [[pseudovariables:1.5.x|link]] | [[transformations:1.5.x|link]] | - | ^ 1.4.x version | [[core-cookbook:1.4.x|link]] | [[pseudovariables:1.4.x|link]] | [[transformations:1.4.x|link]] | - | ^ 1.3.x version | [[core-cookbook:1.3.x|link]] | [[pseudovariables:1.3.x|link]] | [[transformations:1.3.x|link]] | - | ^ 1.2.x version | [[core-cookbook:1.2.x|link]] | [[pseudovariables:1.2.x|link]] | [[transformations:1.2.x|link]] | - | ^ 1.1.x version | [[core-cookbook:1.1.x|link]] | [[pseudovariables:1.1.x|link]] | - | - | \\ ===== Modules References ===== * Parameter - adapt the module behaviour to your needs. * Functions - execute functions to e.g. alter or route SIP messages from the configuration. * MI commands - change or query the module state during runtime. * Statistics - informations about the status and past events. * Pseudo-variables - access module data or special variables. * Examples - How to use the module in the configuration. * README - Reference documentation of the module, contains all previous informations. \\ | Module documentation ^ Parameter ^ Functions ^ MI commands ^ Statistics ^ Pseudo-variables ^ Examples ^ README ^ ^ Development version | [[modules:1.6.x:index-parameters|link]] | [[modules:1.6.x:index-functions|link]] | [[modules:1.6.x:index-MI|link]] | [[modules:1.6.x:index-statistics|link]] | [[modules:1.6.x:index-pseudo-var|link]] | [[modules:1.6.x:index-examples|link]] | [[http://www.kamailio.org/docs/modules/devel|link]] | ^ 3.0.x version | [[modules:3.0.x:index-parameters|link]] | [[modules:3.0.x:index-functions|link]] | [[modules:3.0.x:index-MI|link]] | [[modules:3.0.x:index-statistics|link]] | [[modules:3.0.x:index-pseudo-var|link]] | [[modules:3.0.x:index-examples|link]] | [[http://www.kamailio.org/docs/modules/3.0.x|link]] | ^ 1.5.x version | [[modules:1.5.x:index-parameters|link]] | [[modules:1.5.x:index-functions|link]] | [[modules:1.5.x:index-MI|link]] | [[modules:1.5.x:index-statistics|link]] | [[modules:1.5.x:index-pseudo-var|link]] | [[modules:1.5.x:index-examples|link]] | [[http://www.kamailio.org/docs/modules/1.5.x|link]] | ^ 1.4.x version | [[modules:1.4.x:index-parameters|link]] | [[modules:1.4.x:index-functions|link]] | [[modules:1.4.x:index-MI|link]] | [[modules:1.4.x:index-statistics|link]] | [[modules:1.4.x:index-pseudo-var|link]] | [[modules:1.4.x:index-examples|link]] | [[http://www.kamailio.org/docs/modules/1.4.x|link]] | ^ 1.3.x version | [[modules:1.3.x:index-parameters|link]] | [[modules:1.3.x:index-functions|link]] | [[modules:1.3.x:index-MI|link]] | [[modules:1.3.x:index-statistics|link]] | [[modules:1.3.x:index-pseudo-var|link]] | [[modules:1.3.x:index-examples|link]] | [[http://www.kamailio.org/docs/modules/1.3.x|link]] | ^ 1.2.x version | [[modules:1.2.x:index-parameters|link]] | [[modules:1.2.x:index-functions|link]] | [[modules:1.2.x:index-MI|link]] | [[modules:1.2.x:index-statistics|link]] | [[modules:1.2.x:index-pseudo-var|link]] | [[modules:1.2.x:index-examples|link]] | [[http://www.kamailio.org/docs/modules/1.2.x|link]] | ^ 1.1.x version | [[modules:1.1.x:index-parameters|link]] | [[modules:1.1.x:index-functions|link]] | [[modules:1.1.x:index-fifo-commands|link]] | [[modules:1.1.x:index-statistics|link]] | [[modules:1.1.x:index-pseudo-var|link]] | [[modules:1.1.x:index-examples|link]] | [[http://www.kamailio.org/docs/modules/1.1.x|link]] | ^ 1.0.x version | [[modules:1.0.x:index-parameters|link]] | [[modules:1.0.x:index-functions|link]] | [[modules:1.0.x:index-fifo-commands|link]] | - | - | [[modules:1.0.x:index-examples|link]] | [[http://www.kamailio.org/docs/modules/1.0.x|link]] | ^ 0.9.x version | [[modules:0.9.x:index-parameters|link]] | [[modules:0.9.x:index-functions|link]] | - | - | - | [[modules:0.9.x:index-examples|link]] | [[http://www.kamailio.org/docs/modules/0.9.x|link]] | \\ * [[modules:status|Status of modules]] ===== Features ===== # [[capabilities:index|Kamailio (OpenSER) capabilities]] # [[features:new-in-1.3.x|New in 1.3.x]] # [[features:new-in-1.4.x|New in 1.4.x]] # [[features:new-in-1.5.x|New in 1.5.x]] # [[features:new-in-3.0.x|New in 3.0.x]] # [[http://sip-router.org/wiki/features/new-in-devel|New in devel]] ===== Download and Packages ===== Main download page: * http://www.kamailio.org/w/download/ ==== Linux - Unix Distributions ==== * [[packages:debs|DEBS: Debian - Ubuntu]] * [[packages:rpms|RPMS: Centos]] * [[packages:pkgs|PKGS: FreeBSD]] ==== Download Repositories ==== * [[download:git|Download Sources from GIT Repository]] (v3.0.0 or grater) * [[download:svn|Download Sources from SVN Repository]] (v0.9.4 to v1.5.x) * [[download:embedded|Download Sites for Embedded Systems]] ===== Setup ===== #[b][i][color=teal]Recommended Readings[/color][/i][/b] ## [[docs:recommended-readings|Recommended Readings]] #[b][i][color=teal]Installation[/color][/i][/b] ## [[install:kamailio-3.0.x-from-git|Install and maintain Kamailio (OpenSER) v3.0.x from GIT]] ## [[install:kamailio-1.5.x-from-svn|Install and maintain Kamailio (OpenSER) v1.5.x from SVN]] ## [[install:openser-from-svn|Install and maintain Kamailio(OpenSER) from SVN]] ## [[install:make-debian-packages|How to make Debian packages]] ## [[install:install-debian-packages|Install Debian packages]] ## [[http://www.sureteq.com/asterisk/kamailio_start_to_finish.htm|Install Kamailio 1.4.x on Fedora 9]] ## [[install:backport-debian-source-package|Backporting Kamailio(OpenSER) v1.3.2 to Debian Etch 4.0]] ## [[install:configure-install-solaris-sparc|Configuring and installing Kamailio(OpenSER) v1.3.2 on Solaris SPARC]] ## [[http://muhammad.akl.googlepages.com/OpenSER-getting-started-on-Solaris10.pdf|Configuring and installing Kamailio(OpenSER) v1.3.4-notls on Solaris 10-i386]] ## [[install:configure-initd-script|How to make init.d script to work with monit]] # [b][i][color=teal]Migration[/color][/i][/b] ## [[install:1.0.x-to-1.1.x|Migrating OpenSER v1.0.x to v1.1.x]] ## [[install:1.1.x-to-1.2.x|Migrating OpenSER v1.1.x to v1.2.x]] ## [[install:1.2.1-to-1.2.2|Migrating OpenSER v1.2.1 to v1.2.2]] ## [[install:1.2.2-to-1.3.0|Migrating OpenSER v1.2.2 to v1.3.0]] ## [[install:1.3.x-to-1.4.0|Migrating OpenSER v1.3.x to Kamailio v1.4.0]] ## [[install:1.4.x-to-1.5.0|Migrating Kamailio v1.4.x to Kamailio v1.5.0]] ## [[install:1.5.x-to-3.0.0|Migrating Kamailio v1.5.x to Kamailio v3.0.0]] ## [[http://sip-router.org/wiki/install/3.0.x-to-3.1.x|Migrating Kamailio v3.0.x to Kamailio v3.1.0]] ===== Troubleshooting ===== # [[troubleshooting:report-an-issue|Report an issue]] # [[troubleshooting:faq|F.A.Q.]] # [[troubleshooting:memory|Memory]] # [[troubleshooting:private-memory-size|Private Memory Size]] # [[troubleshooting:nat|NAT]] # [[troubleshooting:tls|TLS]] # [[troubleshooting:radius|RADIUS]] # [[troubleshooting:mailing-list-links|Links to useful mailing list discussions]] # [[troubleshooting:uac:uac-auth|UAC Module - uac_auth() comments]] # [[troubleshooting:signal9]] # [[troubleshooting:tm:t_relay|t_relay() clarification]] # [[troubleshooting:corefiles]] ===== Tutorials ===== # [b][i][color=teal]Kamailio (OpenSER) & NAT[/color][/i][/b] ## [[nat:remote-rtpproxy|Run RTPproxy on a remote host]] ## [[http://voip-info.org/wiki/view/OpenSER+And+RTPProxy|Kamailio (OpenSER) and RTPProxy]] ## [[http://voip-info.org/wiki/view/OpenSER+And+Mediaproxy| Kamailio (OpenSER) and Mediaproxy]] # [b][i][color=teal]Kamailio (OpenSER) & Asterisk[/color][/i][/b] ## [[asterisk:realtime-integration|Realtime Integration of Kamailio (OpenSER) and Asterisk]] ## [[asterisk:realtime-mysql-views|Kamailio (OpenSER) to Asterisk Realtime MySQL Views]] ## [[asterisk:voicemail-system|Using Asterisk as Voicemail System]] ## [[asterisk:conference-bridge|Using Asterisk as a Conference Bridge]] ## [[asterisk:load-balancing-and-ha|Asterisk Load Balancing and High Availability with Kamailio (OpenSER)]] # [b][i][color=teal]Kamailio and TLS[/color][/i][/b] ## [[tls:create-certificates|Create Certificates to be used with Kamailio]] ===== Detailed documentation and links ===== # [b][i][color=teal]Kamailio (OpenSER) Presence and Instant Messaging Extensions[/color][/i][/b] ## [[presence:presence-module|SIMPLE Presence Server]] ## [[presence:pua-modules|Presence User Agent Client Modules]] ## [[http://www.kamailio.org/docs/modules/devel/xmpp.html|SIP/SIMPLE-XMPP Gateway]] ## [[http://www.kamailio.org/docs/modules/devel/imc.html|Instant Messaging Conferencing]] ## [[http://openxcap.org|Fully featured XCAP server implementation]] # [b][i][color=teal]Kamailio (OpenSER) Web Interfaces[/color][/i][/b] ## [[http://siremis.asipto.com|SIREMIS]] ## [[http://openseradmin.sourceforge.net/|OpenSER Administrator]] ## [[http://voip-info.org/wiki/view/OpenSER+1.1.x+and+SerWEB+0.9.4|OpenSER and SerWEB 0.9.4]] # [b][i][color=teal]Configuration Files Bank[/color][/i][/b] ## [[cfg-scripts-bank:main-index|Configuration Files Bank - Main Index]] # [b][i][color=teal]New design for Kamailio modules[/color][/i][/b] ## [[modules-new-design:dialog-module-design|Dialog Module]] ## [[modules-new-design:lcr-module-design|LCR Module]] ===== Database structure ===== # [[database:1.0.x|OpenSER 1.0.x - Database structure]] # [[database:1.2.x|OpenSER 1.2.x - Database structure]] # [[http://www.kamailio.org/docs/db-tables/openser-db-1.3.x.html|OpenSER 1.3.x - Database structure]] # [[http://www.kamailio.org/docs/db-tables/kamailio-db-1.4.x.html|Kamailio 1.4.x - Database structure]] # [[http://www.kamailio.org/docs/db-tables/kamailio-db-1.5.x.html|Kamailio 1.5.x - Database structure]] # [[http://www.kamailio.org/docs/db-tables/openser-db-devel.html|Kamailio (OpenSER) Devel - Database structure]] - auto-generated daily ===== Development documentation ===== # [b][i][color=teal]Development[/color][/i][/b] ## [[http://www.asipto.com/pub/openser-devel-guide/|Kamailio (OpenSER) Devel Guide]] ## [[development:write-module|Writing Kamailio (OpenSER) Modules]] ## [[development:module-makefile|Kamailio (OpenSER) Module's Makefile]] ## [[development:tls-requirements|Kamailio (OpenSER) TLS requirements]] ## [[development:irc-meetings|IRC development meetings]] ## [[development:hosting|Hosting requirements for Kamailio (OpenSER)]] ## [[development:build-service|Build service for Kamailio (OpenSER)]] ## [[development:release-policy|Release policy and actual dates for Kamailio (OpenSER)]] ## [[development:db-schema|Kamailio (OpenSER) Database Schema]] ## [[development:contributions|Contributions to Kamailio (OpenSER)]] ## [[development:db-devel|Developing a new database module]] ## [[development:new-devel|New development guidelines]] ## [[development:sdp-parsing|SDP parsing in Kamailio (OpenSER)]] ## [[development:event-evaluation|Evaluation of event frameworks]] ## [[development:mi-commands|Adding MI Commands]] # [b][i][color=teal]Roadmap[/color][/i][/b] ## [[roadmap:1.5.x|Roadmap for the 1.5 release]] ## [[roadmap:1.4.x|Roadmap for the 1.4 release]] ## [[roadmap:1.3.x|Roadmap for the 1.3 release]] ## [[http://www.kamailio.org/mos/view/Roadmap/|Older roadmaps]] ## [[Openser -> Kamailio renaming Todos]] ## [[development:release-policy|Release policy and actual dates for OpenSER]] ===== Documentation development ===== # [[doc-devel:module-doc|Writing Module Documentation]] ===== External documentation ===== # [b][i][color=teal]Tutorials[/color][/i][/b] ## [[http://www.kamailio.org/docs|Kamailio (OpenSER) Documentation Site]] ## [[http://www.sureteq.com/asterisk/kamailio_start_to_finish.htm|Kamailio - Start to Finish Guide]] ## [[http://www.voip-wiki.nl/doku.php?id=openser|A Dutch Kamailio (OpenSER) Installation manual]] ## [[http://www.kamailio.org/docs/openser-radius-1.0.x.html|FreeRADIUS Integration for Kamailio (OpenSER) 1.0.x]] ## [[http://econf.switch.ch/econfportal/www/page_viewer/?id=/documentation/ecs/technical_infos/overview.html|Kamailio (OpenSER) Configuration Guidelines]] ## [[http://www.voip-wiki.nl/doku.php?id=openser|NL Wiki Page for Kamailio (OpenSER)]] ## [[http://www.oldskoolphreak.com/tfiles/voip/beginners_openser.txt|A Beginners Guide to Kamailio (OpenSER)]] ## [[http://frad-cdrtool.sourceforge.net/README|FreeRADIUS-CDRTool Connector for Kamailio (OpenSER)]] # [b][i][color=teal]Practical Examples[/color][/i][/b] ## [[examples:caller-callee-same-group|How to use Attribute Value Pairs (AVP's) to determine if both the caller and the callee are in the same group.]] ## [[examples:restrict-calls-to-registered-users|How to restrict calls to only registered users]] ## [[examples:set-blind-call-forwarding|How to set up blind call forwarding using *21 on your phone]] ## [[examples:caller-callee-behind-same-nat|How to set up nathelper/rtpproxy when both SIP UA's are behind same NAT]] ## [[examples:accounting-setup|Kamailio (OpenSER) Accounting Setup]] ## [[http://www.kamailio.org/docs/avp_db_query.html|avp_db_query()]] ## [[http://nrenum.net/how-to_openser.html|Enum query with two enum trees]] ## [[http://voipembedded.com/resources/openser_dbtext_lcr.cfg|Least cost routing using the lcr module]] ## [[http://www.bestessays.ca/|Essay writing service]] ## [[http://voipembedded.com/resources/openser_cr.cfg|Least cost routing using the carrierroute module]] # [b][i][color=teal]Useful tutorials & tools[/color][/i][/b] ## [[utils:flags|Flags Description]] ## [[utils:fifo-relay|FIFO Interface]] ## [[utils:fifo-client-php|FIFO Client PHP Example]] ## [[utils:basic-syslog-configuration|Basic Kamailio (OpenSER) Syslog Logging and Logrotate]] ## [[utils:openser-and-sems|Kamailio (OpenSER) and SEMS]] # [b][i][color=teal]Kamailio (OpenSER) tutorials[/color][/i][/b] ## [[tutorials:openser-flag-operations|Kamailio (OpenSER) - Flag Operations]] ## [[tutorials:debug-syslog-messages|Kamailio (OpenSER) - Debug and Syslog Messages]] ## [[tutorials:avpops|Kamailio (OpenSER) - AVPops module]] ## [[tutorials:openser-modular-install|Kamailio (OpenSER) modular installation (beginner level)]] ## [[tutorials:openser-auth-ldap|LDAP Authentication with OpenSER 1.3.x]] # [b][i][color=teal]Kamailio (OpenSER) course materials[/color][/i][/b] ## [[http://www.kamailio.org/events/2007-VoN-Europe-Rome/von-italy07-openser-admin-course.tgz|Admin Course Rome 2007]] ## [[http://www.kamailio.org/events/2007-VoN-Fall-Boston/openser-admin-vonfall07.tgz|Admin Course Boston 2007]] ===== Other ===== # [[admin:foundation-draft|Foundation Draft]] # [[modules:html-documentation| Documentation Extensions, About HTML Documentation]] # [[site:about| About this page]] # [b][i][color=teal]OpenSER Sandbox[/color][/i][/b] ===== Disclaimer ===== [color=brown] **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 //devel@kamailio.org// or //team@kamailio.org// for private messages. Kamailio.org is not responsible for the content in the dokuwiki pages.** [/color]