uac: new modparam reg_gc_interval
[sip-router] / README
1
2
3 Kamailio v5.2
4 =============
5
6 https://www.kamailio.org
7
8 Table of contents
9   I.   About Kamailio
10   II.  Feature List
11   III. Getting started
12   IV.  About the project
13   V.   Obtaining Help
14   VI.  Contributions
15   VII. More Information
16
17
18 I. About Kamailio
19 =================
20
21 Kamailio is an industrial-strength, free server for realtime communication,
22 based on the Session Initiation Protocol (SIP RFC3261).
23
24 It is engineered to power Realtime Communications such as IP telephony and
25 presence infrastructures up to large scale. With embedded support for
26 WebSockets/WebRTC, HTTP, XSRP and XMLrpc as well as Json-rpc it's a modern
27 server, up to date with current standards on IPv4/IPv6 and TLS security.
28
29 Kamailio keeps track of users, sets up multimedia sessions, relays instant
30 messages and creates space for new plug-in applications. Its proven
31 interoperability guarantees seamless integration with components from other
32 vendors, eliminating the risk of a single-vendor trap. Kamailio has
33 successfully participated in various interoperability tests in which it worked
34 with the products of other leading SIP vendors.
35
36 The Kamailio software enables a flexible plug-in model for new applications:
37 third parties can easily link their plug-ins with the server code and provide
38 thereby advanced and customized services. With a modern RPC interface, 3rd
39 party application can integrate and interact with services provided by
40 Kamailio. By using the EVAPI interface or the embedded HTTP server restful
41 applications can be built.
42
43 Kamailio's performance and robustness allows it to serve millions of users and
44 accommodate needs of very large operators. With a low-cost dual-CPU, the
45 Kamailio server is able to power IP telephony services in an area as large as
46 the Bay Area during peak hours.
47
48 The Kamailio server is extremely configurable to allow the creation of various
49 routing and admission policies as well as setting up new and customized
50 services. Its configurability  allows it to serve many roles: network security
51 barrier, presence server, application server,  IMS server or PSTN gateway guard
52 (Edge Proxy / Session Border Controller) for example.
53
54
55 II. Feature List
56 ================
57
58 Please visit https://www.kamailio.org/ for the most up-to-date feature list.
59 Note that as features easily are added as modules, changes can occur quickly.
60
61 Most of Kamailio's features are implemented as plug-in modules. See
62 our web site for a current list.
63
64 III. Getting started
65 ====================
66
67 The documentation wiki is an important source of tutorials for installing
68 and understanding how Kamailio works:
69
70   * https://www.kamailio.org/wiki/
71
72 The INSTALL document provides more details and guidelines that will help with
73 the installation.
74
75 Kamailio is composed of a core and additional modules. For each module
76 there is a README with documentation on how to configure and use the
77 module. These are available in each modules source code directory as well
78 as on the kamailio.org web site.
79
80 We recommend that you continue with reading README-MODULES and then the
81 document named INSTALL.
82
83 IV. About kamailio.org
84 ========================
85
86 The Kamailio project has roots in a line of projects starting with SIP Express
87 Router, then OpenSER and now Kamailio. A merge project was started during the
88 fall of 2008 by developers from the OpenSER project, recently renamed to
89 Kamailio.org, and SIP Express Router (SER) from iptel.org.
90
91 Kamailio is the result of a merge of the code base and years of experience from
92 both developer teams. During the development of the release 4.0, autumn-winter
93 of 2012, the merger of the products was completed and a unified product was
94 released.
95
96 See http://www.kamailio.org/ for the story of SER, OpenSER and Kamailio.
97
98 V. Obtaining Help
99 =================
100
101 We offer best-effort free support for Kamailio. "best-effort" means
102 that we try to solve your problems via email as soon as we can,
103 subject to available manpower.
104
105 To receive feedback to your inquiries, we recommend you to subscribe
106 to the sr-users mailing list and post your queries there. This mailing
107 list is set up for mutual help by the community of Kamailio users and developers.
108 To participate in the mailing list, subscribe at the following web address:
109          https://lists.kamailio.org/mailman/listinfo/sr-users
110
111 The IRC channel #kamailio on freenode.net is a place where to meet and discuss
112 with other members of Kamailio community.
113
114 VI. Contributions
115 =================
116
117 Kamailio is an open source project managed and developed by its community.
118 Anyone is welcome to join the development efforts and contribute with code,
119 documentation or other resources that could help the project.
120
121 For code contributions, follow the suggestions provided at:
122
123   * https://www.kamailio.org/wiki/devel/git-commit-guidelines
124
125 The recommended way to contribute code is via pull requests to Kamailio
126 project on Github:
127
128   * httpss://github.com/kamailio
129
130 VII. More Information
131 =====================
132
133 Most up-to-date information is always available at our website,
134                  https://www.kamailio.org/
135
136 Particularly, it includes:
137 - administrator's guide
138 - configuration cookbooks (core, pseudovariables and transformations)
139 - module documentation
140 - installation guidelines (INSTALL)
141 - download links
142 - etc.
143
144 You can also follow us on Twitter as @kamailio and like us on Facebook
145 to get regular updates.