Browse code

README - converted to Kamailio

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