README - converted to Kamailio
[sip-router] / README
1 $Id$
2
3
4                 Welcome to Kamailio v4.0!
5
6                 http://www.kamailio.org/
7                 ==========================
8
9 I.   About Kamailio
10 II.  Feature List
11 III. Getting started
12 IV.  About the project
13 V.   Obtaining Help
14 VI.  More Information
15
16
17 Kamailio is an industrial-strength, free server for realtime communication,
18 based on the Session Initiation Protocol (SIP RFC3261). 
19
20 It is engineered to power Realtime Communications such as IP telephony and presence 
21 infrastructures up to large scale. With embedded support for WebSockets, HTTP,
22 MSRP and XMLrpc as well as Json-rpc it's a modern server, up to date with current
23 standards.
24
25 Kamailio keeps track of users, sets up multimedia sessions, relays instant 
26 messages and creates space for new plug-in applications. Its proven interoperability 
27 guarantees seamless integration with components from other vendors, eliminating the 
28 risk of a single-vendor trap. Kamailio has successfully participated in various 
29 interoperability tests in which it worked with the products 
30 of other leading SIP vendors.
31
32 The Kamailio software enables a flexible plug-in model for new applications: Third parties 
33 can easily link their plug-ins with the server code and provide thereby advanced and
34 customized services. With a modern RPC interface, 3rd party application can integrate
35 and interact with services provided by Kamailio.
36
37 Kamailio's performance and robustness allows it to serve millions of users and accommodate needs
38 of very large operators. With a low-cost dual-CPU, the Kamailio server is able to power 
39 IP telephony services in an area as large as the Bay Area during peak hours.
40
41 The Kamailio is extremely configurable to allow the creation of various routing and 
42 admission policies as well as setting up new and customized services. Its configurability 
43 allows it to serve many roles: network security barrier, presence server, application server, 
44 IMS server or PSTN gateway guard (Session Border Controller) for example.
45
46
47 II. Feature List
48 ================
49
50 Please visit http://www.kamailio.org/ for the most up-to-date feature list.
51 Note that as features easily are added as modules, changes can occur quickly.
52
53 Most of Kamailio's features are implemented as plug-in modules. See 
54 our web site for a current list.
55
56 III. Getting started
57 ====================
58
59 The INSTALL document will guide you through the installation.
60
61 Kamailio is composed of a core and additional modules. For each module
62 there is a README with documentation on how to configure and use the 
63 module. These are available in each modules source code directory as well
64 as on the kamailio.org web site.
65
66 We recommend that you continue with reading README-MODULES and then the
67 document named INSTALL.
68
69 IV. About kamailio.org
70 ========================
71
72 The Kamailio project has roots in a line of projects starting with SIP Express
73 Router, then OpenSER and now Kamailio. A merge project was started during the fall
74 of 2008 by developers from the OpenSER project, recently renamed to Kamailio.org
75 and SIP Express Router (SER) from iptel.org. 
76
77 Kamailio is the result of a merge of the code base and years
78 of experience from both developer teams. In release 4.0, during the spring of 2013, the
79 merger of the products was completed and a unified product was released.
80
81 See http://www.sip-router.org/ for the story of SER, OpenSER/Kamailio and kamailio.org.
82
83 V. Obtaining Help
84 =================
85
86 We offer best-effort free support for Kamailio. "best-effort" means 
87 that we try to solve your problems via email as soon as we can, 
88 subject to available manpower. 
89
90 To receive feedback to your inquiries, we recommend you to subscribe 
91 to the sr-users mailing list and post your queries there. This mailing 
92 list is set up for mutual help by the community of ser users and developers. 
93 To participate in the mailing list, subscribe at the following web address: 
94          http://lists.sip-router.org/mailman/listinfo/sr-users
95
96 VI. More Information
97 ====================
98
99 Most up-to-date information is always available at our website,
100                  http://www.kamailio.org/
101
102 Particularly, it includes:
103 - administrator's guide
104 - configuration cookbooks (core, pseudovariables and transformations)
105 - module documentation
106 - installation guidelines (INSTALL)
107 - download links
108 - etc.