Merge pull request #503 from smititelu/SIPPROXY-195
[sip-router] / README.md
1 # Kamailio - The Open Source SIP Server [![Build Status](https://travis-ci.org/kamailio/kamailio.svg?branch=master)](https://travis-ci.org/kamailio/kamailio)
2
3 Project Website:
4
5   * http://www.kamailio.org
6
7 ## Overview
8
9 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).
10
11 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:
12
13   * http://www.kamailio.org/w/features/
14
15 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.
16
17 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.
18
19 For more information about Kamailio, see the the [website of the project](http://www.kamailio.org), where you can find pointers to documentation, the project wiki and much more.
20
21 ## Contributions
22
23 Github pull requests are the recommended way to contribute to Kamailio source code or documentation:
24
25   * https://github.com/kamailio/kamailio/pulls
26
27 To keep a coherent and consistent history of the development, the commit messages format and content must follow the rules detailed at:
28
29   * https://www.kamailio.org/wiki/devel/github-contributions
30
31 Contributions must conform with licensing rules of the Kamailio project.
32
33 ## License
34
35 Main License: GPLv2.
36
37 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.
38
39 ### License of New Code Contributions
40
41 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.
42
43 ## Documentation
44
45 The main index for documentation is available at:
46
47   * http://www.kamailio.org/w/documentation/
48
49 The online documentation for modules in the latest stable branch:
50
51   * http://kamailio.org/docs/modules/stable/
52
53 The wiki collects a consistent number of tutorials, the indexes for variables, functions and parameters:
54
55   * http://www.kamailio.org/wiki/
56
57 Please read the README file in the source code, one per module.
58
59 ### Installation
60
61 Step by step tutorials to install Kamailio from source code are available at:
62
63   * http://www.kamailio.org/wiki/start#installation
64
65 Please read the INSTALL file from the source code for more information.
66
67 Repositories for Linux packages:
68
69   * deb: https://www.kamailio.org/wiki/packages/debs
70   * rpm: https://www.kamailio.org/wiki/packages/rpms
71
72 ## Issues and bug reports
73
74 To report a bug or make a request for new features, use the Issues Page in the Kamailio Github project:
75
76   * https://github.com/kamailio/kamailio/issues
77
78 ## Open Support and Community Discussions
79
80 ### Mailing Lists
81
82 Mailing list for discussions regarding stable versions of Kamailio:
83
84   * **sr-users (at) lists.sip-router.org** - [sr-users web page](http://lists.sip-router.org/cgi-bin/mailman/listinfo/sr-users)
85
86 Mailing list for discussions regarding the development of Kamailio and the state of master (devel) branch:
87
88   * **sr-dev (at) lists.sip-router.org** - [sr-dev web page](http://lists.sip-router.org/cgi-bin/mailman/listinfo/sr-dev)
89
90 Mailing list for discussions with commercial purpose:
91
92   * **business (at) lists.kamailio.org** - [business web page](http://lists.kamailio.org/cgi-bin/mailman/listinfo/business)
93
94 For more information about the mailing lists, please see:
95
96   * http://www.kamailio.org/w/mailing-lists/
97
98 ### IRC Channel
99
100 An open IRC discussion channel is managed by the community:
101
102   * irc server: irc.freenode.net
103   * irc channel: #kamailio
104
105 ## Useful Resources:
106
107 News:
108
109   * http://www.kamailio.org/w/category/news/
110
111 ## Travis-ci/Testing build environment
112
113  * [travis-ci](https://travis-ci.org/kamailio/kamailio/builds/)
114  * [docker build](/test/travis/README.md)
115
116 **Thank you for flying Kamailio!**