call_control: docs - link to mailing list discussion about MI to RPC control
[sip-router] / README.md
1 # Kamailio - The Open Source SIP Server
2
3 [![Build Status](https://travis-ci.org/kamailio/kamailio.svg?branch=master)](https://travis-ci.org/kamailio/kamailio)
4 [![Code Triage Badge](https://www.codetriage.com/kamailio/kamailio/badges/users.svg)](https://www.codetriage.com/kamailio/kamailio)
5
6 Project Website:
7
8   * http://www.kamailio.org
9
10 ## Overview
11
12 Kamailio is an open source implementation of a SIP Signaling Server. SIP is an open standard protocol specified by the IETF. The core specification document is [RFC3261](https://tools.ietf.org/html/rfc3261).
13
14 The Kamailio SIP server is designed for scalability, targeting large deployments (e.g. for IP telephony operators or carriers, which have a large subscriber base or route a big volume of calls), but can be also used in enterprises or for personal needs to provide VoIP, Instant Messaging and Presence. Kamailio is well known for its flexibility, robustness, strong security and the extensive number of features - for more information, please see:
15
16   * https://www.kamailio.org/w/features/
17
18 Kamailio development was started back in 2001 by [Fraunhofer Fokus](https://www.fokus.fraunhofer.de/), a research institute in Berlin, Germany. At that time the project name was SIP Express Router (aka SER). In 2005, a fork named OpenSER was created, which was renamed to Kamailio in July 2008 due to trademark issues. Starting in the autumn of 2008, Kamailio and SER initiated the process to merge the two projects. After the merge was complete, Kamailio became the main name of the project, being better protected in terms of trademarks.
19
20 Fraunhofer Fokus is no longer actively involved in the evolution of the project. Kamailio is  now developed and managed by its world wide community. Fokus still uses Kamailio in its research projects (such as OpenIMSCore) and it is hosting events related to the project, such as developer meetings or the Kamailio World Conference.
21
22 For more information about Kamailio, see the the [website of the project](https://www.kamailio.org), where you can find pointers to documentation, the project wiki and much more.
23
24 ## Contributions
25
26 Github pull requests are the recommended way to contribute to Kamailio source code or documentation:
27
28   * https://github.com/kamailio/kamailio/pulls
29
30 To keep a coherent and consistent history of the development, the commit messages format and content must follow the rules detailed at:
31
32   * https://www.kamailio.org/wiki/devel/github-contributions
33
34 Contributions must conform with licensing rules of the Kamailio project.
35
36 ## License
37
38 Main License: GPLv2.
39
40 Each source code file refers to the license and copyright details in the top of the file. Most of the code is licensed under GPLv2, some parts of the code are licensed under BSD.
41
42 ### License Of New Code Contributions
43
44 New contributions to the core and several main modules (auth, corex, sl, tls, tm) have to be done under the BSD license. New contributions under the GPL must grant the GPL-OpenSSL linking exception. Contributions to existing components released under BSD must be done under BSD as well.
45
46 ## Documentation
47
48 The main index for documentation is available at:
49
50   * https://www.kamailio.org/w/documentation/
51
52 The online documentation for modules in the latest stable branch:
53
54   * https://kamailio.org/docs/modules/stable/
55
56 The wiki collects a consistent number of tutorials, the indexes for variables, functions and parameters:
57
58   * https://www.kamailio.org/wiki/
59
60 Please read the README file in the source code, one per module.
61
62 ### Installation
63
64 Step by step tutorials to install Kamailio from source code are available at:
65
66   * https://www.kamailio.org/wiki/start#installation
67
68 Please read the INSTALL file from the source code for more information.
69
70 Repositories for Linux packages:
71
72   * deb: https://www.kamailio.org/wiki/packages/debs
73   * rpm: https://www.kamailio.org/wiki/packages/rpms
74
75 ## Issues And Bug Reports
76
77 To report a bug or make a request for new features, use the Issues Page in the Kamailio Github project:
78
79   * https://github.com/kamailio/kamailio/issues
80
81 ## Open Support And Community Discussions
82
83 ### Mailing Lists
84
85 Mailing list for discussions regarding stable versions of Kamailio:
86
87   * **sr-users (at) lists.kamailio.org** - [sr-users web page](https://lists.kamailio.org/cgi-bin/mailman/listinfo/sr-users)
88
89 Mailing list for discussions regarding the development of Kamailio and the state of master (devel) branch:
90
91   * **sr-dev (at) lists.kamailio.org** - [sr-dev web page](https://lists.kamailio.org/cgi-bin/mailman/listinfo/sr-dev)
92
93 Mailing list for discussions with commercial purpose:
94
95   * **business (at) lists.kamailio.org** - [business web page](https://lists.kamailio.org/cgi-bin/mailman/listinfo/business)
96
97 For more information about the mailing lists, please see:
98
99   * https://www.kamailio.org/w/mailing-lists/
100
101 ### IRC Channel
102
103 An open IRC discussion channel is managed by the community:
104
105   * irc server: irc.freenode.net
106   * irc channel: #kamailio
107
108 ## Useful Resources
109
110 News:
111
112   * https://www.kamailio.org/w/category/news/
113   * Twitter @kamailio
114
115 ## Travis-CI - Testing Build Environment
116
117  * [travis-ci](https://travis-ci.org/kamailio/kamailio/builds/)
118  * [docker build](/test/travis/README.md)
119
120 **Thank you for flying Kamailio!**