Browse code

README.md: details useful to be displayed on github main page for the project

Daniel-Constantin Mierla authored on 01/09/2015 09:43:09
Showing 1 changed files
1 1
new file mode 100644
... ...
@@ -0,0 +1,99 @@
0
+# Kamailio - The Open Source SIP Server
1
+
2
+Project Website:
3
+
4
+  * http://www.kamailio.org
5
+
6
+## Overview
7
+
8
+Kamailio is an open source implementation of a SIP Signaling Server. SIP is an open standard protocol specified by IETF, the core specification document is [RFC3261](https://tools.ietf.org/html/rfc3261).
9
+
10
+It is designed for scalability, targeting large deployoments (e.g., for IP telephony operators or carriers, which have a large subscriber base or route a big volume of acalls), 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, see:
11
+
12
+  * http://www.kamailio.org/w/features/
13
+
14
+Kamailio was started back in 2001 by Fraunhofer Fokus, a research institute in Berlin, Germany, at that time having the name SIP Express Router (aka SER). In 2005, a fork named OpenSER has been 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 back. After the merge was complete, Kamailio became the main name of the project, being better protected in terms of trademarks.
15
+
16
+Fraunhofer Fokus is no longer actively involved in the evolution of the project, Kamailio being 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 Kamailio World Conference.
17
+
18
+For more about Kamailio, see the [website of the project](http://www.kamailio.org).
19
+
20
+## Contributions
21
+
22
+Github pull requests are the recommended way to contribute to Kamailio source code or documentation:
23
+
24
+  * https://github.com/kamailio/kamailio/pulls
25
+
26
+To keep a coherent and consitent history of the development, the commit messages format and content must follow the rules detailed at:
27
+
28
+  * https://www.kamailio.org/wiki/devel/github-contributions
29
+
30
+## Documentation
31
+
32
+The main index for documentation is available at:
33
+
34
+  * http://www.kamailio.org/w/documentation/
35
+
36
+The online documentation for modules in the latest stable branch:
37
+
38
+  * http://kamailio.org/docs/modules/stable/
39
+
40
+The wiki collect a consistent number of tutorials, the indexes for variables, functions and parameters:
41
+
42
+  * http://www.kamailio.org/wiki/
43
+
44
+Read also the README file from the source code.
45
+
46
+### Installation
47
+
48
+Step by step tutorials to install Kamailio from source code are available at:
49
+
50
+  * http://www.kamailio.org/wiki/start#installation
51
+
52
+Read also the INSTALL file from the source code.
53
+
54
+Repositories for packages:
55
+
56
+  * deb: https://www.kamailio.org/wiki/packages/debs
57
+  * rpm: https://www.kamailio.org/wiki/packages/rpms
58
+
59
+## Issues
60
+
61
+To report a bug or make a request for a features, use the Issues Page from Github project:
62
+
63
+  * https://github.com/kamailio/kamailio/issues
64
+
65
+## Open Support and Community Discussions
66
+
67
+### Mailing Lists
68
+
69
+Mailing list for discussions regarding stable versions of Kamailio:
70
+
71
+  * <sr-users (at) lists.sip-router.org> - [sr-users web page](http://lists.sip-router.org/cgi-bin/mailman/listinfo/sr-users)
72
+
73
+Mailing list for discussions regarding development of Kamailio and the state of master (devel) branch:
74
+
75
+  * <sr-dev (at) lists.sip-router.org> - [sr-dev web page](http://lists.sip-router.org/cgi-bin/mailman/listinfo/sr-dev)
76
+
77
+Mailing list for discussions with commercial purpose:
78
+
79
+  * <business (at) lists.kamailio.org> - [business web page](http://lists.kamailio.org/cgi-bin/mailman/listinfo/business)
80
+
81
+For more, see:
82
+
83
+  * http://www.kamailio.org/w/mailing-lists/
84
+
85
+### IRC Channel
86
+
87
+An open IRC discussion channel is managed by the community:
88
+
89
+  * irc server: irc.freenode.net
90
+  * irc channel: #kamailio
91
+
92
+## Useful Resources:
93
+
94
+News:
95
+
96
+  * http://www.kamailio.org/w/category/news/
97
+
98
+_** Thank you for flying Kamailio! **_