6d342ca36b87885f3a36e6527d4c8b850ab02361
[sip-router] / README
1 $Id$
2
3
4                  SIP Router (sip-router)
5                 http://www.sip-router.org/
6                 ==========================
7
8 I.   About SIP Router (sip-router)
9 II.  Feature List
10 III. Getting started
11 IV.  About the project
12 V.   Obtaining Help
13 VI.  More Information
14
15
16 SIP Router (sip-router) is an industrial-strength, free VoIP server based 
17 on the Session Initiation Protocol (SIP RFC3261). 
18 It is engineered to power Realtime Communications such as IP telephony and presence 
19 infrastructures up to large scale.
20
21 The server keeps track of users, sets up multimedia sessions, relays instant 
22 messages and creates space for new plug-in applications. Its proven interoperability 
23 guarantees seamless integration with components from other vendors, eliminating the 
24 risk of a single-vendor trap. SIP Router has successfully participated in various 
25 interoperability tests in which it worked with the products 
26 of other leading SIP vendors.
27
28 The SIP Router software enables a flexible plug-in model for new applications: Third parties 
29 can easily link their plug-ins with the server code and provide thereby advanced and
30 customized services. With a modern RPC interface, 3rd party application can integrate
31 and interact with services provided by SIP Router.
32
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 
35 IP telephony services in an area as large as the Bay Area during peak hours.
36
37 The SIP Router is extremely configurable to allow the creation of various routing and 
38 admission policies as well as setting up new and customized services. Its configurability 
39 allows it to serve many roles: network security barrier, presence server, application server, 
40 IMS server or PSTN gateway guard (Session Border Controller) for example.
41
42
43 II. Feature List
44 ================
45
46 See http://www.sip-router.org/ for an updated feature list.
47 Note that as features easily are added as modules, changes can occur quickly.
48
49 Most of SIP-router's features are implemented as plug-in modules. See 
50 our web site for a current list.
51
52 III. Getting started
53 ====================
54
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
57 there is a README with documentation on how to configure and use the 
58 module. These are available in each modules source code directory as well
59 as on the sip-router.org web site.
60
61 We recommend that you continue with reading README-MODULES and then the
62 document named INSTALL.
63
64 IV. About sip-router.org
65 ========================
66
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
70 of experience from both developer teams. In release 4.0, during the spring of 2013, the
71 merger of the products was completed and a unified product was released.
72
73 See http://www.sip-router.org/ for the story of SER, OpenSER/Kamailio and sip-router.org.
74
75 V. Obtaining Help
76 =================
77
78 We offer best-effort free support for sip-router. "best-effort" means 
79 that we try to solve your problems via email as soon as we can, 
80 subject to available manpower. 
81
82 To receive feedback to your inquiries, we recommend you to subscribe 
83 to the sr-users mailing list and post your queries there. This mailing 
84 list is set up for mutual help by the community of ser users and developers. 
85 To participate in the mailing list, subscribe at the following web address: 
86          http://lists.sip-router.org/mailman/listinfo/sr-users
87
88 VI. More Information
89 ====================
90
91 Most up-to-date information is always available at our website,
92                  http://www.sip-router.org/
93
94 Particularly, it includes:
95 - administrator's guide
96 - configuration cookbooks (core, pseudovariables and transformations)
97 - module documentation
98 - installation guidelines (INSTALL)
99 - download links
100 - etc.