README
550bb8c3
 
1dcfc5fa
 
4d0eae5c
 Kamailio v4.3
b9c6e708
 =============
a865b622
 
b9c6e708
 http://www.kamailio.org
550bb8c3
 
b9c6e708
 Table of contents
   I.   About Kamailio
   II.  Feature List
   III. Getting started
   IV.  About the project
   V.   Obtaining Help
   VI.  More Information
a7aaf4d4
 
 
b9c6e708
 I. About Kamailio
 =================
 
a865b622
 Kamailio is an industrial-strength, free server for realtime communication,
 based on the Session Initiation Protocol (SIP RFC3261). 
 
32e73f99
 It is engineered to power Realtime Communications such as IP telephony and presence 
a865b622
 infrastructures up to large scale. With embedded support for WebSockets, HTTP,
 MSRP and XMLrpc as well as Json-rpc it's a modern server, up to date with current
 standards.
32e73f99
 
a865b622
 Kamailio keeps track of users, sets up multimedia sessions, relays instant 
a7aaf4d4
 messages and creates space for new plug-in applications. Its proven interoperability 
 guarantees seamless integration with components from other vendors, eliminating the 
a865b622
 risk of a single-vendor trap. Kamailio has successfully participated in various 
a7aaf4d4
 interoperability tests in which it worked with the products 
c6a041c5
 of other leading SIP vendors.
893ade1e
 
a865b622
 The Kamailio software enables a flexible plug-in model for new applications: Third parties 
a7aaf4d4
 can easily link their plug-ins with the server code and provide thereby advanced and
32e73f99
 customized services. With a modern RPC interface, 3rd party application can integrate
bef223c9
 and interact with services provided by Kamailio. By using the EVAPI interface or the
 embedded HTTP server restful applications can be built.
c6a041c5
 
a865b622
 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 
a7aaf4d4
 IP telephony services in an area as large as the Bay Area during peak hours.
c6a041c5
 
0bdc78ff
 The Kamailio server is extremely configurable to allow the creation of various routing and 
a7aaf4d4
 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, 
32e73f99
 IMS server or PSTN gateway guard (Session Border Controller) for example.
893ade1e
 
 
 II. Feature List
a7aaf4d4
 ================
 
a865b622
 Please visit http://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.
 
a865b622
 Most of Kamailio's features are implemented as plug-in modules. See 
a7aaf4d4
 our web site for a current list.
 
 III. Getting started
 ====================
893ade1e
 
a865b622
 The INSTALL document will guide you through the installation.
 
 Kamailio is composed of a core and additional modules. For each module
a7aaf4d4
 there is a README with documentation on how to configure and use the 
 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
 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 Kamailio.org
 and SIP Express Router (SER) from iptel.org. 
 
0bdc78ff
 Kamailio is the result of a merge of the code base and years of experience from
 both developer teams. In release 4.0, during the spring of 2013, the
32e73f99
 merger of the products was completed and a unified product was released.
893ade1e
 
f8d3d4ae
 See http://www.kamailio.org/ for the story of SER, OpenSER/Kamailio and kamailio.org.
893ade1e
 
a7aaf4d4
 V. Obtaining Help
 =================
893ade1e
 
a865b622
 We offer best-effort free support for Kamailio. "best-effort" means 
c21b0b47
 that we try to solve your problems via email as soon as we can, 
95d1ae89
 subject to available manpower. 
893ade1e
 
c21b0b47
 To receive feedback to your inquiries, we recommend you to subscribe 
a7aaf4d4
 to the sr-users mailing list and post your queries there. This mailing 
0bdc78ff
 list is set up for mutual help by the community of Kamailio users and developers. 
c21b0b47
 To participate in the mailing list, subscribe at the following web address: 
a7aaf4d4
          http://lists.sip-router.org/mailman/listinfo/sr-users
c21b0b47
 
a7aaf4d4
 VI. More Information
 ====================
893ade1e
 
 Most up-to-date information is always available at our website,
a865b622
                  http://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.