Merge pull request #1986 from ionutionita92/rtpengine
[sip-router] / README
diff --git a/README b/README
index 78b9936..44645b7 100644 (file)
--- a/README
+++ b/README
-$Id$
 
 
-             iptel.org SIP Express Router (ser)
-                http://www.iptel.org/ser/
-               
+Kamailio v5.2
+=============
 
+https://www.kamailio.org
 
-I.   About SIP Express Router (SER)
-II.  Feature List
-III. About iptel.org
-IV.  Obtaining Help
-V.   More Information
+Table of contents
+  I.   About Kamailio
+  II.  Feature List
+  III. Getting started
+  IV.  About the project
+  V.   Obtaining Help
+  VI.  Contributions
+  VII. More Information
 
 
-SIP Express Router (SER) is an industrial-strength, free VoIP 
-server based on the session initiation protocol (SIP RFC2543-bis). 
-It is engineered to power IP telephony infrastructures up to large 
-scale. The server keeps track of users, sets up VoIP 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. It has successfully participated in 
-various interoperability tests in which it worked with the products 
-of other leading SIP vendors.
+I. About Kamailio
+=================
 
-The SIP Express Router 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.  
+Kamailio is an industrial-strength, free server for realtime communication,
+based on the Session Initiation Protocol (SIP RFC3261).
 
-Its performance and robustness allows it to serve millions of users 
-and accommodate needs of very large operators. With a $3000 dual-CPU, 
-the SIP Express Router is able to power IP telephony services in an 
-area as large as the Bay Area during peak hours. Even on an IPAQ PDA, 
-the server withstands 150 calls per second (CPS)! The server has been 
-powering our iptel.org free SIP site withstanding heavy daily load 
-that is further increasing with the popularity of Microsoft's 
-Messenger.  
+It is engineered to power Realtime Communications such as IP telephony and
+presence infrastructures up to large scale. With embedded support for
+WebSockets/WebRTC, HTTP, XSRP and XMLrpc as well as Json-rpc it's a modern
+server, up to date with current standards on IPv4/IPv6 and TLS security.
 
-The SIP Express Router 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, application server, or PSTN gateway 
-guard for example.
+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. Kamailio has
+successfully participated in various interoperability tests in which it worked
+with the products of other leading SIP vendors.
+
+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
+Kamailio. By using the EVAPI interface or the embedded HTTP server restful
+applications can be built.
+
+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 Kamailio server 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
+(Edge Proxy / Session Border Controller) for example.
 
 
 II. Feature List
+================
+
+Please visit https://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 Kamailio's features are implemented as plug-in modules. See
+our web site for a current list.
+
+III. Getting started
+====================
+
+The documentation wiki is an important source of tutorials for installing
+and understanding how Kamailio works:
+
+  * https://www.kamailio.org/wiki/
+
+The INSTALL document provides more details and guidelines that will help with
+the installation.
 
-See http://www.iptel.org/ser/features for an updated feature list.
-Note that as features easily are added as modules, changes can
-occur quickly.
+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 kamailio.org web site.
 
-Most of SER features are implemented as plug-in modules. See
-http://www.iptel.org/views/tableofmodules for a list of modules 
-available in SER distribution.
+We recommend that you continue with reading README-MODULES and then the
+document named INSTALL.
 
+IV. About kamailio.org
+========================
 
-III. About iptel.org
+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.
 
-See http://www.iptel.org/ser_history for the story of SER and iptel.org.
+Kamailio is the result of a merge of the code base and years of experience from
+both developer teams. During the development of the release 4.0, autumn-winter
+of 2012, the merger of the products was completed and a unified product was
+released.
 
-IV. Obtaining Help
+See http://www.kamailio.org/ for the story of SER, OpenSER and Kamailio.
 
-We offer best-effort free support for ser. "best-effort" means 
-that we try to solve your problems via email as soon as we can, 
-subject to available manpower. 
+V. Obtaining Help
+=================
 
-To receive feedback to your inquiries, we recommend you to subscribe 
-to the serusers mailing list and post your queries there. This mailing 
-list is set up for mutual help by the community of ser users and developers. 
-To participate in the mailing list, subscribe at the following web address: 
-         http://lists.iptel.org/mailman/listinfo/serusers.
-Send your questions to 
-         serusers@iptel.org. 
+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.
 
-V. More Information
+To receive feedback to your inquiries, we recommend you to subscribe
+to the sr-users mailing list and post your queries there. This mailing
+list is set up for mutual help by the community of Kamailio users and developers.
+To participate in the mailing list, subscribe at the following web address:
+         https://lists.kamailio.org/mailman/listinfo/sr-users
+
+The IRC channel #kamailio on freenode.net is a place where to meet and discuss
+with other members of Kamailio community.
+
+VI. Contributions
+=================
+
+Kamailio is an open source project managed and developed by its community.
+Anyone is welcome to join the development efforts and contribute with code,
+documentation or other resources that could help the project.
+
+For code contributions, follow the suggestions provided at:
+
+  * https://www.kamailio.org/wiki/devel/git-commit-guidelines
+
+The recommended way to contribute code is via pull requests to Kamailio
+project on Github:
+
+  * httpss://github.com/kamailio
+
+VII. More Information
+=====================
 
 Most up-to-date information is always available at our website,
-                 http://www.iptel.org/ser/
+                 https://www.kamailio.org/
 
 Particularly, it includes:
 - administrator's guide
+- configuration cookbooks (core, pseudovariables and transformations)
+- module documentation
 - installation guidelines (INSTALL)
 - download links
-- list of known issues (ISSUES)
 - etc.
+
+You can also follow us on Twitter as @kamailio and like us on Facebook
+to get regular updates.