Browse code

Starting to prepare README/INSTALL files for release

Olle E. Johansson authored on 15/01/2013 08:46:22
Showing 4 changed files
... ...
@@ -131,6 +131,13 @@ W: http://www.ohlmeier.org
131 131
 P: BAD6CA40   B5E7 4FB0 800F 0A2C E3E9  4073 C7C3 F275 BAD6 CA40
132 132
 D:
133 133
 
134
+N: Olle E. JOhansson
135
+C: oej
136
+E: oej@edvina.net
137
+W: http://edvina.net
138
+P: 
139
+D:
140
+
134 141
 N: Peter Griffiths
135 142
 C: 
136 143
 E:
... ...
@@ -62,6 +62,10 @@ very few, Kamailio enabling next compile time flags:
62 62
   - internal statistics
63 63
   - application server extensions in tm module
64 64
 
65
+In version 4.0.0 the modules were merged into one set and the merger
66
+between the two products was completed. Kamailio is now the main
67
+flavour.
68
+
65 69
 Switching between flavours is a matter of 'make' command parameters.
66 70
 
67 71
 Several installation tutorials for Kamailio are available on the web wiki:
... ...
@@ -130,6 +134,7 @@ Requirements:
130 130
 - libpcre libs and devel headers - if you want to compile the lcr and dialplan
131 131
   modules
132 132
 - libsctp devel headers - if you want to compile the SCTP transport in the core
133
+- linunistring - for the Websockets module
133 134
 
134 135
 
135 136
 OS Notes:
... ...
@@ -253,10 +258,8 @@ B) Build Commands
253 253
 
254 254
 Compile modules except some explicitly excepted (see below)
255 255
 	make modules  - all modules in the modules/ directory (common modules)
256
-	make modules_s - all modules in the modules_s/ directory (ser modules)
257 256
 	make modules_k - all modules in the modules_k/ directory (kamailio modules)
258
-	make modules-all or make every-module  - all the modules (modules, modules_s
259
-                                         and module_k)
257
+	make modules-all or make every-module  - all the modules (modules and module_k)
260 258
 
261 259
 * Compile all:
262 260
 	make all
... ...
@@ -680,10 +683,10 @@ D) SIP Server with Persistent Data Storage
680 680
 
681 681
 3.2) create MySQL tables for Kamailio flavour
682 682
 	- if you have a previously installed Kamailio on your system, use
683
-    	/usr/sbin/kamdbctl reinstall 
683
+    	/usr/local/sbin/kamdbctl reinstall 
684 684
 	  to convert your Kamailio database into new structures
685 685
 	- otherwise, if this is your very first installation, use
686
-    	/usr/sbin/kamdbctl create
686
+    	/usr/local/sbin/kamdbctl create
687 687
 	  to create Kamailio database structures
688 688
    (you will be prompted for password of MySql "root" user)
689 689
 
... ...
@@ -15,26 +15,29 @@ VI.  More Information
15 15
 
16 16
 SIP Router (sip-router) is an industrial-strength, free VoIP server based 
17 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 
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 
20 22
 messages and creates space for new plug-in applications. Its proven interoperability 
21 23
 guarantees seamless integration with components from other vendors, eliminating the 
22
-risk of a single-vendor trap. It has successfully participated in various 
24
+risk of a single-vendor trap. SIP Router has successfully participated in various 
23 25
 interoperability tests in which it worked with the products 
24 26
 of other leading SIP vendors.
25 27
 
26
-The SIP Router enables a flexible plug-in model for new applications: Third parties 
28
+The SIP Router software enables a flexible plug-in model for new applications: Third parties 
27 29
 can easily link their plug-ins with the server code and provide thereby advanced and
28
-customized services.  
30
+customized services. With a modern RPC interface, 3rd party application can integrate
31
+and interact with services provided by SIP Router.
29 32
 
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 
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 
32 35
 IP telephony services in an area as large as the Bay Area during peak hours.
33 36
 
34 37
 The SIP Router is extremely configurable to allow the creation of various routing and 
35 38
 admission policies as well as setting up new and customized services. Its configurability 
36 39
 allows it to serve many roles: network security barrier, presence server, application server, 
37
-or PSTN gateway guard (Session Border Controller) for example.
40
+IMS server or PSTN gateway guard (Session Border Controller) for example.
38 41
 
39 42
 
40 43
 II. Feature List
... ...
@@ -64,7 +67,8 @@ IV. About sip-router.org
64 64
 The SIP Router project was started during the fall of 2008 by developers from
65 65
 the OpenSER project, recently renamed to Kamailio.org and SIP Express Router (SER)
66 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.
67
+of experience from both developer teams. In release 4.0, during the spring of 2013, the
68
+merger of the products was completed and a unified product was released.
68 69
 
69 70
 See http://www.sip-router.org/ for the story of SER, OpenSER/Kamailio and sip-router.org.
70 71
 
... ...
@@ -89,7 +93,7 @@ Most up-to-date information is always available at our website,
89 89
 
90 90
 Particularly, it includes:
91 91
 - administrator's guide
92
-- configuration cookbook
92
+- configuration cookbooks (core, pseudovariables and transformations)
93 93
 - module documentation
94 94
 - installation guidelines (INSTALL)
95 95
 - download links
... ...
@@ -3,23 +3,14 @@
3 3
 SIP-ROUTER modules
4 4
 ==================
5 5
 
6
-This is the first release of the combined project. In order to be able to support
7
-an upgrade path for both Kamailio/OpenSER and SER current users, we have been forced to
8
-provide some modules in two versions, which means that we have three set of modules:
6
+This is the first release of the merged product - Kamailio and SER. 
7
+In the previous release some modules where provided in two versions, in Kamailio
8
+and SER flavours. These are now merged. In some cases, the functionality has 
9
+changed. You can still do the same operation, but how you do it may be different.
9 10
 
11
+Modules are divided in two directories
10 12
  - modules: 	the SIP router modules
11 13
  - modules_k: 	Kamailio modules
12
- - modules_s: 	SER modules
13
-
14
-All modules are compatible with the core, so regardless if you are a new user or 
15
-an existing, you are free to make a choice between the three sets as well as
16
-mix and match between them.
17
-
18
-Note that if you are currently using one product, you want to select the module
19
-that exists in the K/S directories first to get a smooth upgrade path.
20
-
21
-As sip-router development progress, we will move as many modules as possible
22
-into the core and only keep k/s modules for backwards compatibility when required.
23 14
 
24 15
 What is a module?
25 16
 =================
... ...
@@ -27,22 +18,16 @@ A module consists of a lot of functions that enhance the core. Some of the modul
27 27
 depends on other modules. It's all properly documented in the README that belongs
28 28
 to each module (available as web pages on the sip-router.org web site).
29 29
 
30
-A module providers up to three different APIs:
30
+A module providers up to five different APIs:
31 31
 
32 32
 - Enhancements to the core SIP-router routing script (functions)
33
-- Commands for the management interface (MI)
33
+- Commands for the management interface (MI and RPC)
34 34
 - Development interface for other modules
35
+- Pseudo-variables
36
+- Selects and config framework variables
35 37
 
36 38
 A single module may provide a selection of this, maybe only one of them.
37 39
 
38
-Why do we have two modules with the same name?
39
-==============================================
40
-Some modules exists both in modules_k and modules_s - like xlog. If you are
41
-upgrading from Kamailio, we recommend using the one in modules_k for backwards
42
-compatibility, if you are using SER then select the one in modules_s.
43
-In the future the development team will try to integrate modules that are
44
-split like this into one integrated module.
45
-
46 40
 Core modules
47 41
 ------------
48 42
 auth_identity		SIP Identity support (RFC 4474)