[sr-dev] git:master: Starting to prepare README/INSTALL files for release

Module: sip-router Branch: master Commit: 32e73f99a3bab4bc673504d316831f0a8ff1f48c URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=32e73f9… Author: Olle E. Johansson <oej(a)edvina.net> Committer: Olle E. Johansson <oej(a)edvina.net> Date: Tue Jan 15 09:46:22 2013 +0100 Starting to prepare README/INSTALL files for release --- AUTHORS | 7 +++++++ INSTALL | 13 ++++++++----- README | 24 ++++++++++++++---------- README-MODULES | 33 +++++++++------------------------ 4 files changed, 38 insertions(+), 39 deletions(-) diff --git a/AUTHORS b/AUTHORS index f79ba18..b766254 100644 --- a/AUTHORS +++ b/AUTHORS @@ -131,6 +131,13 @@ W: http://www.ohlmeier.org P: BAD6CA40 B5E7 4FB0 800F 0A2C E3E9 4073 C7C3 F275 BAD6 CA40 D: +N: Olle E. JOhansson +C: oej +E: oej(a)edvina.net +W: http://edvina.net +P: +D: + N: Peter Griffiths C: E: diff --git a/INSTALL b/INSTALL index 8519add..68bed71 100644 --- a/INSTALL +++ b/INSTALL @@ -62,6 +62,10 @@ very few, Kamailio enabling next compile time flags: - internal statistics - application server extensions in tm module +In version 4.0.0 the modules were merged into one set and the merger +between the two products was completed. Kamailio is now the main +flavour. + Switching between flavours is a matter of 'make' command parameters. Several installation tutorials for Kamailio are available on the web wiki: @@ -130,6 +134,7 @@ Requirements: - libpcre libs and devel headers - if you want to compile the lcr and dialplan modules - libsctp devel headers - if you want to compile the SCTP transport in the core +- linunistring - for the Websockets module OS Notes: @@ -253,10 +258,8 @@ B) Build Commands Compile modules except some explicitly excepted (see below) make modules - all modules in the modules/ directory (common modules) - make modules_s - all modules in the modules_s/ directory (ser modules) make modules_k - all modules in the modules_k/ directory (kamailio modules) - make modules-all or make every-module - all the modules (modules, modules_s - and module_k) + make modules-all or make every-module - all the modules (modules and module_k) * Compile all: make all @@ -680,10 +683,10 @@ D) SIP Server with Persistent Data Storage 3.2) create MySQL tables for Kamailio flavour - if you have a previously installed Kamailio on your system, use - /usr/sbin/kamdbctl reinstall + /usr/local/sbin/kamdbctl reinstall to convert your Kamailio database into new structures - otherwise, if this is your very first installation, use - /usr/sbin/kamdbctl create + /usr/local/sbin/kamdbctl create to create Kamailio database structures (you will be prompted for password of MySql "root" user) diff --git a/README b/README index 1b0ab00..6d342ca 100644 --- a/README +++ b/README @@ -15,26 +15,29 @@ VI. More Information SIP Router (sip-router) is an industrial-strength, free VoIP server based on the Session Initiation Protocol (SIP RFC3261). -It is engineered to power IP telephony and presence infrastructures up to large -scale. The server keeps track of users, sets up VoIP sessions, relays instant +It is engineered to power Realtime Communications such as IP telephony and presence +infrastructures up to large scale. + +The server 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. It has successfully participated in various +risk of a single-vendor trap. SIP Router has successfully participated in various interoperability tests in which it worked with the products of other leading SIP vendors. -The SIP Router enables a flexible plug-in model for new applications: Third parties +The SIP Router 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. +customized services. With a modern RPC interface, 3rd party application can integrate +and interact with services provided by SIP Router. -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 +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 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 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, -or PSTN gateway guard (Session Border Controller) for example. +IMS server or PSTN gateway guard (Session Border Controller) for example. II. Feature List @@ -64,7 +67,8 @@ IV. About sip-router.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 -of experience from both developer teams. +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. @@ -89,7 +93,7 @@ Most up-to-date information is always available at our website, Particularly, it includes: - administrator's guide -- configuration cookbook +- configuration cookbooks (core, pseudovariables and transformations) - module documentation - installation guidelines (INSTALL) - download links diff --git a/README-MODULES b/README-MODULES index 8861ec6..e04c872 100644 --- a/README-MODULES +++ b/README-MODULES @@ -3,23 +3,14 @@ SIP-ROUTER modules ================== -This is the first release of the combined project. In order to be able to support -an upgrade path for both Kamailio/OpenSER and SER current users, we have been forced to -provide some modules in two versions, which means that we have three set of modules: +This is the first release of the merged product - Kamailio and SER. +In the previous release some modules where provided in two versions, in Kamailio +and SER flavours. These are now merged. In some cases, the functionality has +changed. You can still do the same operation, but how you do it may be different. +Modules are divided in two directories - modules: the SIP router modules - modules_k: Kamailio modules - - modules_s: SER modules - -All modules are compatible with the core, so regardless if you are a new user or -an existing, you are free to make a choice between the three sets as well as -mix and match between them. - -Note that if you are currently using one product, you want to select the module -that exists in the K/S directories first to get a smooth upgrade path. - -As sip-router development progress, we will move as many modules as possible -into the core and only keep k/s modules for backwards compatibility when required. What is a module? ================= @@ -27,22 +18,16 @@ A module consists of a lot of functions that enhance the core. Some of the modul depends on other modules. It's all properly documented in the README that belongs to each module (available as web pages on the sip-router.org web site). -A module providers up to three different APIs: +A module providers up to five different APIs: - Enhancements to the core SIP-router routing script (functions) -- Commands for the management interface (MI) +- Commands for the management interface (MI and RPC) - Development interface for other modules +- Pseudo-variables +- Selects and config framework variables A single module may provide a selection of this, maybe only one of them. -Why do we have two modules with the same name? -============================================== -Some modules exists both in modules_k and modules_s - like xlog. If you are -upgrading from Kamailio, we recommend using the one in modules_k for backwards -compatibility, if you are using SER then select the one in modules_s. -In the future the development team will try to integrate modules that are -split like this into one integrated module. - Core modules ------------ auth_identity SIP Identity support (RFC 4474)