[sr-dev] git:master: README - converted to Kamailio

Module: sip-router Branch: master Commit: a865b622be84ddc1dacff35401adbb6937ec86b3 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=a865b62… Author: Olle E. Johansson <oej(a)edvina.net> Committer: Olle E. Johansson <oej(a)edvina.net> Date: Fri Jan 18 13:32:55 2013 +0100 README - converted to Kamailio --- README | 58 +++++++++++++++++++++++++++++++++------------------------- 1 files changed, 33 insertions(+), 25 deletions(-) diff --git a/README b/README index 6d342ca..e1ee0ba 100644 --- a/README +++ b/README @@ -1,11 +1,12 @@ $Id$ - SIP Router (sip-router) - http://www.sip-router.org/ + Welcome to Kamailio v4.0! + + http://www.kamailio.org/ ========================== -I. About SIP Router (sip-router) +I. About Kamailio II. Feature List III. Getting started IV. About the project @@ -13,28 +14,31 @@ V. Obtaining Help VI. More Information -SIP Router (sip-router) is an industrial-strength, free VoIP server based -on the Session Initiation Protocol (SIP RFC3261). +Kamailio is an industrial-strength, free server for realtime communication, +based on the Session Initiation Protocol (SIP RFC3261). + It is engineered to power Realtime Communications such as IP telephony and presence -infrastructures up to large scale. +infrastructures up to large scale. With embedded support for WebSockets, HTTP, +MSRP and XMLrpc as well as Json-rpc it's a modern server, up to date with current +standards. -The server keeps track of users, sets up multimedia sessions, relays instant +Kamailio keeps track of users, sets up multimedia sessions, relays instant messages and creates space for new plug-in applications. Its proven interoperability guarantees seamless integration with components from other vendors, eliminating the -risk of a single-vendor trap. SIP Router has successfully participated in various +risk of a single-vendor trap. Kamailio has successfully participated in various interoperability tests in which it worked with the products of other leading SIP vendors. -The SIP Router software enables a flexible plug-in model for new applications: Third parties +The Kamailio software enables a flexible plug-in model for new applications: Third parties can easily link their plug-ins with the server code and provide thereby advanced and customized services. With a modern RPC interface, 3rd party application can integrate -and interact with services provided by SIP Router. +and interact with services provided by Kamailio. -SIP Router's performance and robustness allows it to serve millions of users and accommodate needs -of very large operators. With a low-cost dual-CPU, the SIP Router server is able to power +Kamailio's performance and robustness allows it to serve millions of users and accommodate needs +of very large operators. With a low-cost dual-CPU, the Kamailio server is able to power IP telephony services in an area as large as the Bay Area during peak hours. -The SIP Router is extremely configurable to allow the creation of various routing and +The Kamailio is extremely configurable to allow the creation of various routing and admission policies as well as setting up new and customized services. Its configurability allows it to serve many roles: network security barrier, presence server, application server, 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. II. Feature List ================ -See http://www.sip-router.org/ for an updated feature list. +Please visit http://www.kamailio.org/ for the most up-to-date feature list. Note that as features easily are added as modules, changes can occur quickly. -Most of SIP-router's features are implemented as plug-in modules. See +Most of Kamailio's features are implemented as plug-in modules. See our web site for a current list. III. Getting started ==================== -The INSTALL document will guide you through the installation of sip-router. -SIP-router is composed of a core and additional modules. For each module +The INSTALL document will guide you through the installation. + +Kamailio is composed of a core and additional modules. For each module there is a README with documentation on how to configure and use the module. These are available in each modules source code directory as well -as on the sip-router.org web site. +as on the kamailio.org web site. We recommend that you continue with reading README-MODULES and then the document named INSTALL. -IV. About sip-router.org +IV. About kamailio.org ======================== -The SIP Router project was started during the fall of 2008 by developers from -the OpenSER project, recently renamed to Kamailio.org and SIP Express Router (SER) -from iptel.org. SIP Router is the result of a merge of the code base and years +The Kamailio project has roots in a line of projects starting with SIP Express +Router, then OpenSER and now Kamailio. A merge project was started during the fall +of 2008 by developers from the OpenSER project, recently renamed to Kamailio.org +and SIP Express Router (SER) from iptel.org. + +Kamailio is the result of a merge of the code base and years of experience from both developer teams. In release 4.0, during the spring of 2013, the merger of the products was completed and a unified product was released. -See http://www.sip-router.org/ for the story of SER, OpenSER/Kamailio and sip-router.org. +See http://www.sip-router.org/ for the story of SER, OpenSER/Kamailio and kamailio.org. V. Obtaining Help ================= -We offer best-effort free support for sip-router. "best-effort" means +We offer best-effort free support for Kamailio. "best-effort" means that we try to solve your problems via email as soon as we can, subject to available manpower. @@ -89,7 +97,7 @@ VI. More Information ==================== Most up-to-date information is always available at our website, - http://www.sip-router.org/ + http://www.kamailio.org/ Particularly, it includes: - administrator's guide