README
550bb8c3
 
1dcfc5fa
 
66cc8e36
 Kamailio v5.0
b9c6e708
 =============
a865b622
 
66cc8e36
 https://www.kamailio.org
550bb8c3
 
b9c6e708
 Table of contents
   I.   About Kamailio
   II.  Feature List
   III. Getting started
   IV.  About the project
   V.   Obtaining Help
92b155e5
   VI.  Contributions
   VII. More Information
a7aaf4d4
 
 
b9c6e708
 I. About Kamailio
 =================
 
a865b622
 Kamailio is an industrial-strength, free server for realtime communication,
6259d640
 based on the Session Initiation Protocol (SIP RFC3261).
a865b622
 
92b155e5
 It is engineered to power Realtime Communications such as IP telephony and
 presence infrastructures up to large scale. With embedded support for
 WebSockets/WebRTC, HTTP, XSRP and XMLrpc as well as Json-rpc it's a modern
 server, up to date with current standards on IPv4/IPv6 and TLS security.
32e73f99
 
6259d640
 Kamailio keeps track of users, sets up multimedia sessions, relays instant
92b155e5
 messages and creates space for new plug-in applications. Its proven
 interoperability guarantees seamless integration with components from other
 vendors, eliminating the risk of a single-vendor trap. Kamailio has
 successfully participated in various interoperability tests in which it worked
 with the products of other leading SIP vendors.
 
 The Kamailio software enables a flexible plug-in model for new applications:
 third parties can easily link their plug-ins with the server code and provide
 thereby advanced and customized services. With a modern RPC interface, 3rd
 party application can integrate and interact with services provided by
 Kamailio. By using the EVAPI interface or the embedded HTTP server restful
 applications can be built.
 
 Kamailio's performance and robustness allows it to serve millions of users and
 accommodate needs of very large operators. With a low-cost dual-CPU, the
 Kamailio server is able to power IP telephony services in an area as large as
 the Bay Area during peak hours.
 
 The Kamailio server is extremely configurable to allow the creation of various
 routing and admission policies as well as setting up new and customized
 services. Its configurability  allows it to serve many roles: network security
 barrier, presence server, application server,  IMS server or PSTN gateway guard
 (Edge Proxy / Session Border Controller) for example.
893ade1e
 
 
 II. Feature List
a7aaf4d4
 ================
 
66cc8e36
 Please visit https://www.kamailio.org/ for the most up-to-date feature list.
a7aaf4d4
 Note that as features easily are added as modules, changes can occur quickly.
 
6259d640
 Most of Kamailio's features are implemented as plug-in modules. See
a7aaf4d4
 our web site for a current list.
 
 III. Getting started
 ====================
893ade1e
 
92b155e5
 The documentation wiki is an important source of tutorials for installing
 and understanding how Kamailio works:
 
66cc8e36
   * https://www.kamailio.org/wiki/
92b155e5
 
 The INSTALL document provides more details and guidelines that will help with
 the installation.
a865b622
 
 Kamailio is composed of a core and additional modules. For each module
6259d640
 there is a README with documentation on how to configure and use the
a7aaf4d4
 module. These are available in each modules source code directory as well
a865b622
 as on the kamailio.org web site.
893ade1e
 
a7aaf4d4
 We recommend that you continue with reading README-MODULES and then the
 document named INSTALL.
c21b0b47
 
a865b622
 IV. About kamailio.org
a7aaf4d4
 ========================
893ade1e
 
a865b622
 The Kamailio project has roots in a line of projects starting with SIP Express
92b155e5
 Router, then OpenSER and now Kamailio. A merge project was started during the
 fall of 2008 by developers from the OpenSER project, recently renamed to
66cc8e36
 Kamailio.org, and SIP Express Router (SER) from iptel.org.
a865b622
 
0bdc78ff
 Kamailio is the result of a merge of the code base and years of experience from
92b155e5
 both developer teams. During the development of the release 4.0, autumn-winter
c9adb0fa
 of 2012, the merger of the products was completed and a unified product was
92b155e5
 released.
893ade1e
 
92b155e5
 See http://www.kamailio.org/ for the story of SER, OpenSER and Kamailio.
893ade1e
 
a7aaf4d4
 V. Obtaining Help
 =================
893ade1e
 
6259d640
 We offer best-effort free support for Kamailio. "best-effort" means
 that we try to solve your problems via email as soon as we can,
 subject to available manpower.
893ade1e
 
6259d640
 To receive feedback to your inquiries, we recommend you to subscribe
 to the sr-users mailing list and post your queries there. This mailing
 list is set up for mutual help by the community of Kamailio users and developers.
 To participate in the mailing list, subscribe at the following web address:
dd3a55d1
          https://lists.kamailio.org/mailman/listinfo/sr-users
c21b0b47
 
92b155e5
 The IRC channel #kamailio on freenode.net is a place where to meet and discuss
 with other members of Kamailio community.
 
 VI. Contributions
 =================
 
 Kamailio is an open source project managed and developed by its community.
 Anyone is welcome to join the development efforts and contribute with code,
 documentation or other resources that could help the project.
 
 For code contributions, follow the suggestions provided at:
 
66cc8e36
   * https://www.kamailio.org/wiki/devel/git-commit-guidelines
92b155e5
 
 The recommended way to contribute code is via pull requests to Kamailio
 project on Github:
 
66cc8e36
   * httpss://github.com/kamailio
92b155e5
 
 VII. More Information
 =====================
893ade1e
 
 Most up-to-date information is always available at our website,
66cc8e36
                  https://www.kamailio.org/
c21b0b47
 
 Particularly, it includes:
 - administrator's guide
32e73f99
 - configuration cookbooks (core, pseudovariables and transformations)
a7aaf4d4
 - module documentation
c21b0b47
 - installation guidelines (INSTALL)
 - download links
 - etc.
66cc8e36
 
 You can also follow us on Twitter as @kamailioproject and like us on Facebook
 to get regular updates.