kamailio.cfg: removed sample db_mode parameter for domain module
[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 IP telephony and presence infrastructures up to large 
19 scale. The server keeps track of users, sets up VoIP sessions, relays instant 
20 messages and creates space for new plug-in applications. Its proven interoperability 
21 guarantees seamless integration with components from other vendors, eliminating the 
22 risk of a single-vendor trap. It has successfully participated in various 
23 interoperability tests in which it worked with the products 
24 of other leading SIP vendors.
25
26 The SIP Router enables a flexible plug-in model for new applications: Third parties 
27 can easily link their plug-ins with the server code and provide thereby advanced and
28 customized services.  
29
30 Its performance and robustness allows it to serve millions of users and accommodate needs
31 of very large operators. With a $3000 dual-CPU, the SIP Express Router is able to power 
32 IP telephony services in an area as large as the Bay Area during peak hours.
33
34 The SIP Router is extremely configurable to allow the creation of various routing and 
35 admission policies as well as setting up new and customized services. Its configurability 
36 allows it to serve many roles: network security barrier, presence server, application server, 
37 or PSTN gateway guard (Session Border Controller) for example.
38
39
40 II. Feature List
41 ================
42
43 See http://www.sip-router.org/ for an updated feature list.
44 Note that as features easily are added as modules, changes can occur quickly.
45
46 Most of SIP-router's features are implemented as plug-in modules. See 
47 our web site for a current list.
48
49 III. Getting started
50 ====================
51
52 The INSTALL document will guide you through the installation of sip-router. 
53 SIP-router is composed of a core and additional modules. For each module
54 there is a README with documentation on how to configure and use the 
55 module. These are available in each modules source code directory as well
56 as on the sip-router.org web site.
57
58 We recommend that you continue with reading README-MODULES and then the
59 document named INSTALL.
60
61 IV. About sip-router.org
62 ========================
63
64 The SIP Router project was started during the fall of 2008 by developers from
65 the OpenSER project, recently renamed to Kamailio.org and SIP Express Router (SER)
66 from iptel.org. SIP Router is the result of a merge of the code base and years
67 of experience from both developer teams.
68
69 See http://www.sip-router.org/ for the story of SER, OpenSER/Kamailio and sip-router.org.
70
71 V. Obtaining Help
72 =================
73
74 We offer best-effort free support for sip-router. "best-effort" means 
75 that we try to solve your problems via email as soon as we can, 
76 subject to available manpower. 
77
78 To receive feedback to your inquiries, we recommend you to subscribe 
79 to the sr-users mailing list and post your queries there. This mailing 
80 list is set up for mutual help by the community of ser users and developers. 
81 To participate in the mailing list, subscribe at the following web address: 
82          http://lists.sip-router.org/mailman/listinfo/sr-users
83
84 VI. More Information
85 ====================
86
87 Most up-to-date information is always available at our website,
88                  http://www.sip-router.org/
89
90 Particularly, it includes:
91 - administrator's guide
92 - configuration cookbook
93 - module documentation
94 - installation guidelines (INSTALL)
95 - download links
96 - etc.