Browse code

INSTALL: updates to reflect flavour switching

Daniel-Constantin Mierla authored on 12/10/2010 20:50:28
Showing 1 changed files
... ...
@@ -1,54 +1,88 @@
1 1
 $Id$
2 2
 
3 3
 
4
-     ===========================================
4
+     ==================================================
5 5
 
6
-     SIP Router (sip-router) Installation Notes
6
+     SIP Express Router and Kamailio Installation Notes
7 7
 
8 8
              http://sip-router.org
9
+			 http://www.kamailio.org
9 10
 
10
-     ===========================================
11
+     ==================================================
11 12
 
12
-  Welcome to the SIP router! This is an amazingly flexible, robust
13
+  Welcome! This is an amazingly flexible, robust
13 14
   and secure SIP server built on years of experience in several Open
14
-  Source projects. It's a merge of the SIP Express Router and the
15
-  OpenSER/Kamailio products produced by a joint development team.
15
+  Source projects. It's a merge of the SIP Express Router (SER) and the
16
+  Kamailio (OpenSER) products produced by a joint development team. When
17
+  not explicitely mentioned, SIP server refers to any of these two
18
+  applications.
16 19
 
17
-  This memo gives you hints how to set up SIP Router quickly. To 
18
-  understand how SIP Router works and how to configure it properly,
19
-  please read the admin's guide available from the SIP Router website.
20
+  This memo gives you hints how to set up the SIP server quickly. To 
21
+  understand how SIP server works and how to configure it properly,
22
+  please read the admin's guide available from the http://sip-router.org
23
+  website.
20 24
 
21
-  We also urge you to read latest ISSUES (available from SIP Router website
25
+  We also urge you to read latest ISSUES (available from website
22 26
   too) and check for potential problems in this release.
23 27
   Users of previous releases are encouraged to read NEWS to learn how to move
24
-  to this new SIP Router version.
28
+  to this new SIP server version.
25 29
   
26 30
 
27 31
 Table of Contents
28 32
 =================
29 33
 
30
-1. Supported Architectures and Requirements
31
-2. Howto Build sip-router From the Source Distribution
32
-3. Quick-Start Installation Guide
34
+1. SIP Server Flavours
35
+2. Supported Architectures and Requirements
36
+3. Howto Build SIP Server From the Source Distribution
37
+4. Quick-Start Installation Guide
33 38
    A) Getting Help
34 39
    B) Disclaimers
35 40
    C) Quick Start
36
-   D) sip-router with Persistent Data Storage
37
-4. Troubleshooting
41
+   D) SIP Server with Persistent Data Storage
42
+5. Troubleshooting
43
+
44
+
45
+
46
+1. SIP Server Flavours
47
+----------------------
48
+
49
+The two major SIP server flavours are:
50
+  - SIP Express Router (aka SER)
51
+  - Kamailio (former OpenSER)
52
+
53
+Starting with version 3.0.0, the two SIP server flavours are built from
54
+same source code three.
55
+
56
+SER flavor is the one built by default - historically speaking, it is the
57
+first open source SIP server started in 2001. Kamailio forked from SER in
58
+2005 under the initial name OpenSER.
38 59
 
60
+Starting with version 3.1.0 the differences between the two flavours are
61
+very few, Kamailio enabling next compile time flags:
62
+  - internal statistics
63
+  - application server extensions in tm module
39 64
 
65
+Switching between flavours is a matter of 'make' command parameters.
40 66
 
41
-1. Supported Architectures and Requirements
67
+
68
+2. Supported Architectures and Requirements
42 69
 -------------------------------------------
43 70
 
44
-Supported operating systems: Linux, FreeBSD, NetBSD, OpenBSD, Solaris, OS/X
45
-Darwin, Dragonfly BSD.
46
-Partially supported: Windows+Cygwin (core + static modules only, no IPv6, no
47
-TCP, no dynamic modules)
71
+Supported operating systems:
72
+ - Linux (Debian, Ubuntu, Fedora, RedHat, CentOS, OpenSUSE, Gentoo, a.s.o.)
73
+ - FreeBSD, NetBSD, OpenBSD, Dragonfly BSD
74
+ - Solaris
75
+ - OS/X, Darwin
76
+
77
+Partially supported
78
+ - Windows+Cygwin (core + static modules only, no IPv6, no
79
+   TCP, no dynamic modules)
48 80
 
49
-Supported architectures: i386, x86_64 (amd64), armv4l, sparc64, powerpc,
50
-powerpc64
51
-Experimental architectures: mips1, mips2, sparc32, alpha
81
+Supported architectures
82
+ - i386, x86_64 (amd64), armv4l, sparc64, powerpc, powerpc64
83
+
84
+Experimental architectures:
85
+ - mips1, mips2, sparc32, alpha
52 86
 
53 87
 (for other architectures the Makefiles might need to be edited)
54 88
 
... ...
@@ -68,12 +102,30 @@ Requirements:
68 68
 - GNU install, BSD install or Solaris install if you want "make
69 69
   install", "make bin", "make sunpkg" to work
70 70
 - libmysqlclient & libz (zlib) if you want Mysql support (the db_mysql module)
71
-- libexpat if you want the XMPP/Jabber gateway support (the jabber module)
72 71
 - libxml2 if you want to compile the cpl-c (CPL support) or pa (presence) 
73 72
    modules
74 73
 - libradiusclient-ng (> 5.0) if you need radius support (the auth_radius,
75 74
   group_radius, uri_radius and avp_radius modules)
76 75
 - libpq if you need PostgreSQL support (the db_postgres module)
76
+- libexpat if you want the jabber gateway support (the jabber module) or the
77
+  XMPP gateway support
78
+- libxml2 if you want to use the cpl-c (Call Processing Language) or
79
+  the presence modules (presence and pua*)
80
+- libradius-ng -libs and devel headers- if you want to use functionalities
81
+  with radius support - authentication, accounting, group support, etc
82
+- unixodbc - libs and devel headers - if you want UNIXODBC support as
83
+  DB underlayer
84
+- libxmlrpc-c3 - libs and devel headers - if you want to have XML-RPC support
85
+  for the Management interface (MI)
86
+- libperl - libs and devel headers - if you want PERL connector to support
87
+  perl scripting from you config file (perl module)
88
+- libsnmp9 - libs and devel headers - if you want SNMP client functionality 
89
+  (SNMP AgentX subagent) for Kamailio
90
+- libldap libs and devel headers v2.1 or greater - if you want LDAP support
91
+- libconfuse and devel headers - if you want to compile the carrierroute
92
+  module
93
+- libpcre libs and devel headers - if you want to compile the lcr and dialplan
94
+  modules
77 95
 
78 96
 
79 97
 OS Notes:
... ...
@@ -93,7 +145,7 @@ OS Notes:
93 93
   NOTE: you'll need to add radiusclient_ng=4 to the gmake command line if you
94 94
   use the 0.4.* version.
95 95
   
96
-  Compile example (all the modules and sip-router in a tar.gz):
96
+  Compile example (all the modules and SIP server core in a tar.gz):
97 97
      gmake bin radiusclient_ng=4 include_modules="mysql jabber cpl-c auth_radius group_radius uri_radius postgres pa"
98 98
 
99 99
   OpenBSD 3.7
... ...
@@ -106,7 +158,7 @@ OS Notes:
106 106
    (you need to download and install it, since there is no "official" 
107 107
    openbsd port for it) for libradiusclient-ng 
108 108
 
109
-  Compile example (all the modules and sip-router in a tar.gz):
109
+  Compile example (all the modules and SIP server core in a tar.gz):
110 110
      gmake bin include_modules="mysql jabber cpl-c auth_radius group_radius uri_radius pa"
111 111
 
112 112
   NetBSD 2.0
... ...
@@ -116,7 +168,7 @@ OS Notes:
116 116
   - libxml2-2.6.19 (/usr/pkgsrc/textproc/libxml2) for libxml2
117 117
   - radiusclient-ng-0.5.1 (see OpenBSD)
118 118
   
119
-  Compile example (all the modules and sip-router in a tar.gz):
119
+  Compile example (all the modules and SIP server in a tar.gz):
120 120
      gmake bin include_modules="mysql jabber cpl-c auth_radius group_radius uri_radius pa"
121 121
 
122 122
   Solaris 10
... ...
@@ -130,7 +182,7 @@ OS Notes:
130 130
   Needed packages:
131 131
   [TODO]
132 132
   
133
-  Compile example (all the modules and sip-router in a tar.gz):
133
+  Compile example (all the modules and SIP server in a tar.gz):
134 134
      gmake bin INSTALL=install include_modules="mysql jabber cpl-c auth_radius group_radius uri_radius postgres pa"
135 135
 
136 136
   Linux
... ...
@@ -141,23 +193,20 @@ OS Notes:
141 141
       - libpq-dev for libpq
142 142
       - libexpat1-dev for libexpat
143 143
       - libxml2-dev for libxml2
144
-      - libradiusclient-ng-dev for libradiusclient (you can download the 
145
-      package from http://apt.sip-router.org/debian/dists/unstable/main/binary-i386/libradiusclient-ng-dev_0.5.1-0.5_i386.deb ).
146
-      NOTE: you can get up-to-date sip-router packages or libradiusclient packages
147
-      from http://apt.sip-router.org: add to your /etc/apt/sources.list the
148
-      following lines:
149
-         deb http://apt.sip-router.org/debian testing main contrib non-free
150
-         deb http://apt.sip-router.org/debian unstable main contrib non-free
151
-      and then: apt-get update; apt-get install libradiusclient-ng-dev
152
-      (or, if you want to use the pre-built modules:
153
-       apt-get install sip-router sip-router-cpl-module sip-router-jabber-module sip-router-mysq-module sip-router-pa-module sip-router-postgres-module sip-router-radius-modules )
144
+      - libradiusclient-ng-dev for libradiusclient
145
+	  - other libraries are needed for some other modules,
146
+	    see README of the module you want to use
147
+    Both SER and Kamailio flavours have APT deb repositories that allow you to
148
+	install the binaries easily - see the web sites for more details:
149
+	  - http://iptel.org/ser
150
+	  - http://kamailio.org
154 151
 
155 152
  Cygwin  (alpha state, partial support)
156 153
  --------------------------------------
157 154
  make sure make, bison, flex, minires and minires-devel (needed for the
158 155
  resolver functions) are installed.
159 156
  
160
- Only building sip-router's core and some static modules is supported for now.
157
+ Only building SIP server's core and some static modules is supported for now.
161 158
  Stuff known not to work:
162 159
            - IPv6 (cygwin doesn't support it yet)
163 160
            - TCP (the tcp code heavily depends on file descriptor passing 
... ...
@@ -166,21 +215,37 @@ OS Notes:
166 166
              backlinking doesn't work in windows by design)
167 167
 
168 168
 
169
-  Compile example (all the modules and sip-router in a tar.gz):
169
+  Compile example (all the modules and SIP server in a tar.gz):
170 170
      make bin include_modules="mysql jabber cpl-c auth_radius group_radius uri_radius postgres pa"
171 171
 
172 172
 
173
-2. Howto Build sip-router From Source Distribution
173
+3. Howto Build SIP Server From Source Distribution
174 174
 -------------------------------------------
175 175
 
176 176
 (NOTE: if make doesn't work try gmake  instead)
177 177
 
178
-  SIP Router is split in four main parts: The core, the modules, the
178
+A) Set SIP Server Flavour
179
+
180
+If you don't have a clean source tree, first do:
181
+   make proper
182
+
183
+To build SER flavour, you don't need to do anything special, continue to
184
+read the section 3.B).
185
+
186
+To build Kamailio flavour, you have to run first:
187
+   make FLAVOUR=kamailio cfg
188
+
189
+The parameter 'FLAVOUR=kamailio' must be given all the time when make target
190
+is 'cfg'.
191
+
192
+B) Build Commands
193
+
194
+  SIP server is split in four main parts: The core, the modules, the
179 195
   utilties, and scripts/examples.  When you build, you can decide to build
180 196
   only the core, the modules, both, or all.
181 197
 
182
-* Compile SIP Router core only:
183
-	make   #builds only sip-router core, equivalent to make sip-router
198
+* Compile SIP server core only:
199
+	make
184 200
 
185 201
 Compile modules except some explicitly excepted (see below)
186 202
 	make modules  - all modules in the modules/ directory (common modules)
... ...
@@ -194,32 +259,42 @@ Compile modules except some explicitly excepted (see below)
194 194
 
195 195
 * Explicitly excepted modules:
196 196
   By default make all will not build modules that require external libraries or
197
-  that are considered to be "experimental". The modules that have external
197
+  that are considered to be "experimental". For example, modules that have external
198 198
   dependencies are: db_mysql, jabber, cpl-c, auth_radius, group_radius, uri_radius,
199
-  avp_radius, db_postgres, db_berkely, carrierroute, pa.
199
+  avp_radius, db_postgres, db_berkely, carrierroute, ...
200 200
 
201 201
 Including groups of modules:
202 202
   Instead of compiling the default modules only, you can specify groups of
203 203
   modules to include, according to their status:
204
-  - standard - Modules in this group are considered a standard part of SIP Router (due to widespread usage)
205
-    but they have no dependencies (note that some of these interplay with external systems.
204
+  - standard - Modules in this group are considered a standard part of SIP server
205
+    (due to widespread usage) but they have no dependencies (note that some of
206
+	these interplay with external systems.
206 207
     However, they don't have compile or link dependencies).
207 208
 
208 209
   - db - Modules in this group use databases and need a database driver to run.
209
-     Included are drivers for the text mode db (dbtext) and for dumping
210
-     large ammount of data to files (db_flatstore). See also the mysql or
211
-     postgres groups.
210
+    Included are drivers for the text mode db (dbtext) and for dumping
211
+    large ammount of data to files (db_flatstore). See also the mysql or
212
+    postgres groups.
212 213
 
213
-  - standard_dep -  Modules in this group are considered a standard part of SIP Router (due to widespread usage)
214
+  - standard_dep -  Modules in this group are considered a standard part of SIP
215
+    server(due to widespread usage)
214 216
     but they have dependencies that most be satisfied for compilation.
215
-    NOTE! All presence modules (dialog, pa, presence_b2b, rls, xcap) have been included in this
216
-    group due to interdependencies
217
+    NOTE! All presence modules (dialog, pa, presence_b2b, rls, xcap) have been
218
+	included in this group due to interdependencies
219
+
220
+  - stable - Modules in this group satisfy specific or niche applications,
221
+    but are considered stable for production use. They may or may not have
222
+	dependencies
223
+
224
+  - experimental - Modules in this group are either not complete, untested, or
225
+    without enough reports of usage to allow the module into the stable group.
226
+	They may or may not have dependencies.
217 227
 
218
-  - stable - Modules in this group satisfy specific or niche applications, but are considered
219
-    stable for production use. They may or may not have dependencies
228
+There is another set of groups mainly used by Kamailio flavour, where modules
229
+are grouped based on Debian packaging rules. For example:
230
+   - kstandard - Kamailio flavour's standard modules
220 231
 
221
-  - experimental - Modules in this group are either not complete, untested, or without enough reports
222
-    of usage to allow the module into the stable group. They may or may not have dependencies.
232
+   - kpresence - Kamailio flavour's SIMPLE presence server modules
223 233
 
224 234
 * To compile core with standard modules:
225 235
 	make group_include="standard" all
... ...
@@ -242,18 +317,18 @@ Including groups of modules:
242 242
   to specify exactly the modules you want to include, ex.
243 243
 	make include_modules="mymodule" modules
244 244
 
245
-  You can also explicitly skip modules using skip_modules. Let's say you want all the standard
246
-  and standard-dep modules except domain:
245
+  You can also explicitly skip modules using skip_modules. Let's say you want all
246
+  the standard and standard-dep modules except domain:
247 247
 	make group_include="standard standard-dep" skip_modules="domain" all
248 248
 
249 249
   NOTE!!! As this mechanism is very powerful, you may be uncertain which
250
-  modules that will be included. Just replace all (or modules) with print-modules and you will 
251
-  see which modules will be included and excluded, ex:
250
+  modules that will be included. Just replace all (or modules) with print-modules
251
+  and you will see which modules will be included and excluded, ex:
252 252
 	make print-modules
253 253
   will show which modules are excluded by default.
254 254
 
255 255
   If you want to install or to build a binary package (a tar.gz with
256
-  sip-router and the modules), substitute "all" in the above command with
256
+  SIP server core and the modules), substitute "all" in the above command with
257 257
   "install" or "bin".
258 258
 
259 259
 
... ...
@@ -319,9 +394,9 @@ Configure:
319 319
   Note: if config.mak doesn't exist (e.g. initial checkout or after a make 
320 320
   proper) or if Makefile.defs was changed, the config will be re-generated
321 321
   automatically by the first make command. For example:
322
-  	make cfg  include_modules=mysql; make all
322
+  	make cfg  include_modules=db_mysql; make all
323 323
   is equivalent to 
324
- 	rm config.mak modules.lst; make include_modules=mysql.
324
+ 	rm config.mak modules.lst; make include_modules=db_mysql.
325 325
 
326 326
   * make cfg-defs  (force config regeneration, but don't touch the module list)
327 327
 
... ...
@@ -413,21 +488,21 @@ Install:
413 413
   to use this parameter in previous make commands, i.e. make, make modules,
414 414
   or make all. If you fail to do this then SIP Router will look for the default
415 415
   configuration file in a wrong directory, because the directory of the
416
-  default configuration file is hard coded into sip-router during compile time. 
416
+  default configuration file is hard coded into SIP server during compile time. 
417 417
   When you use a different prefix parameter when installing then the 
418
-  directory hard coded in sip-router and the directory in which the file will be 
418
+  directory hard coded in SIP server and the directory in which the file will be 
419 419
   installed by make install will not match. (You can specify exact location
420
-  of the configuration file using -f parameter of sip-router).
420
+  of the configuration file using -f parameter of SIP server).
421 421
 
422 422
   For example, if you do the following:
423 423
 	make all
424 424
 	make prefix=/ install
425 425
 
426 426
   Then the installation will put the default configuration file into
427
-  /etc/sip-router/sip-router.cfg (because prefix is /), but sip-router
428
-  will look for the file in /usr/local/etc/sip-router/sip-router.cfg
429
-  (because there was no prefix parameter make all and /usr/local is the
430
-  default value of prefix).
427
+  /etc/ser/ser.cfg or /etc/kamailio/kamailio.cfg (because prefix is /),
428
+  but SIP server will look for the file in /usr/local/etc/ser/ser.cfg or
429
+  /usr/local/etc/kamailio/kamailio.cfg (because there was no prefix parameter
430
+  make all and /usr/local is the default value of prefix).
431 431
 
432 432
   Workaround is trivial, use the same parameters in all make commands:
433 433
 	make prefix=/ all
... ...
@@ -443,23 +518,18 @@ Install:
443 443
 
444 444
 A) Getting Help
445 445
 
446
-  This guide gives you instructions on how to set up the SIP Router
447
-  (sip-router) on your box quickly. In case the default configuration
448
-  does not fly, please check the documentation at the sip-router web site
449
-  http://sip-router.org to learn how to configure SIP Router for your site.
446
+  This guide gives you instructions on how to set up the SIP server
447
+  (SER or Kamailio) on your box quickly. In case the default configuration
448
+  does not fly, please check the documentation at the SIP server web site
449
+  http://sip-router.org to learn how to configure SIP server for your site.
450 450
 
451 451
   If the documentation does not resolve your problem you may try contacting 
452 452
   our user forum by E-mail at sr-users@lists.sip-router.org -- that is the
453
-  mailing list of the sip-router community. To participate in the mailing list,
453
+  mailing list of the SIP server community. To participate in the mailing list,
454 454
   please subscribe at the following web address:
455 455
 
456 456
   http://lists.sip-router.org/cgi-bin/mailman/listinfo
457 457
 
458
-  To participate in our commercial support program, contact info@iptel.org.
459
-  The support program will provide you with most timely and accurate help
460
-  for configuration, integration, development and any other technical
461
-  activity.
462
-
463 458
 B) Disclaimers
464 459
  
465 460
   Note well the default "quick-start" configuration is very simple in order 
... ...
@@ -471,7 +541,7 @@ B) Disclaimers
471 471
 C) Quick Start
472 472
 
473 473
   The following step-by step guide gives you instructions how to install the 
474
-  SQL-free distribution of sip-router. If you need persistence and
474
+  SQL-free distribution of SIP server. If you need persistence and
475 475
   authentication, then you have to install additional database support --
476 476
   proceed to section D) after you are finished with C).
477 477
 
... ...
@@ -493,12 +563,15 @@ C) Quick Start
493 493
 	debian:
494 494
     		dpkg -i <package_name>
495 495
 	gentoo:
496
-    		emerge sip-router
497
-		(or if use only stable packets: ACCEPT_KEYWORDS="~x86" emerge sip-router)
496
+    		emerge ser
497
+			  or
498
+			emerge kamailio
499
+		(or if use only stable packets: ACCEPT_KEYWORDS="~x86" emerge ser
500
+		or ACCEPT_KEYWORDS="~x86" emerge kamailio)
498 501
 	tar.gz:
499 502
     		cd /; tar zxvf <package_name>_os_arch.tar.gz
500 503
     		(it will install in /usr/local/, and the configuration file in
501
-     		/usr/local/etc/sip-router/sip-router.cfg)
504
+     		/usr/local/etc/ser/ser.cfg or /usr/local/etc/kamailio/kamailio.cfg)
502 505
 	Solaris:
503 506
     		gunzip <package_name>.gz ; pkgadd -d <package_name>
504 507
 	*BSD:
... ...
@@ -507,19 +580,24 @@ C) Quick Start
507 507
 3) Start the server
508 508
 
509 509
 	RPM + gentoo:
510
-    		/etc/init.d/sip-router start
510
+    		/etc/init.d/ser start
511
+			  or
512
+    		/etc/init.d/kamailio start
511 513
 	debian:
512
-    		sip-router is started automatically after the install
513
-    		(in case something fails you can start it with /etc/init.d/sip-router start)
514
+    		SER or Kamailio is started automatically after the install
515
+    		(in case something fails you can start it with '/etc/init.d/ser start'
516
+			or '/etc/init.d/kamailio start')
514 517
 	tar.gz:
515 518
 	Solaris:
516 519
     		the tar.gz does not include an init.d script, you'll have to create one of
517
-    		your own or adapt one from the source distribution (debian/init.d,
518
-    		rpm/sip-router.init.*, gentoo/sip-router.init)
519
-    		You can start sip-router directly with /usr/local/sbin/sip-router.
520
+    		your own or adapt one from the source distribution (pkg/debian/init.d,
521
+    		pkg/rpm/ser.init.*, pkg/gentoo/ser.init, pkg/kamailio/rpm/kamailio.init,
522
+			pkg/kamailio/deb/debian/kamailio.init, a.s.o.)
523
+    		You can start SIP server directly with /usr/local/sbin/ser or
524
+			/usr/local/sbin/kamailio.
520 525
     
521 526
 4) optionally, watch server's health using the
522
-   	serctl utility
527
+   	serctl or kamctl utility
523 528
 
524 529
     - to do so, first set the environment variable SIP_DOMAIN to your domain 
525 530
       name, e.g., in Bourne shell, call
... ...
@@ -530,8 +608,13 @@ C) Quick Start
530 530
     - run the serctl utility
531 531
         /usr/sbin/serctl moni
532 532
       or
533
-        /usr/local/sbin/serctl moni (if you installed from a tar.gz or solaris
534
-        package)
533
+        /usr/sbin/kamctl moni
534
+      or
535
+        /usr/local/sbin/serctl moni (if you installed SER flavour from a tar.gz
536
+		or solaris package)
537
+      or
538
+        /usr/local/sbin/kamctl moni (if you installed Kamailio flavour from a
539
+		tar.gz or solaris package)
535 540
 
536 541
 5) Connect SIP phones
537 542
 
... ...
@@ -547,13 +630,13 @@ C) Quick Start
547 547
 	Auth user:	the ID used for authentication
548 548
 	Secret/Password:	The configured authentication password
549 549
 
550
-D) sip-router with Persistent Data Storage
550
+D) SIP Server with Persistent Data Storage
551 551
 ------------------------------------------
552 552
 
553 553
   The default configuration is very simple and features many simplifications. 
554 554
   In particular, it does not authenticate users and loses User Location database 
555 555
   on reboot. To provide persistence, keep user credentials and remember users' 
556
-  locations across reboots, sip-router can be configured to use a database, like MySQL. 
556
+  locations across reboots, SIP server can be configured to use a database, like MySQL. 
557 557
   Before you proceed, you need to make sure MySQL is installed on your box. Your
558 558
   MySQL server must be configured to deal with a large number of
559 559
   connection. To increase it, set the following line in [mysqld] section
... ...
@@ -561,7 +644,7 @@ D) sip-router with Persistent Data Storage
561 561
 
562 562
    set-variable    = max_connections=500
563 563
 
564
-1) Download the package containing mysql support for sip-router from: 
564
+1) Download the package containing mysql support for SIP server from: 
565 565
     
566 566
     **** site not available yet
567 567
 
... ...
@@ -576,32 +659,44 @@ D) sip-router with Persistent Data Storage
576 576
     or
577 577
     dpkg -i <package_name>
578 578
 	or
579
-	emerge sip-router
579
+	emerge ser
580
+	or
581
+	emerge kamailio
580 582
 	(if do not want to put 'mysql' into your USE variable you can type:
581
-	 USE="mysql" emerge sip-router)
583
+	 USE="mysql" emerge ser)
584
+
585
+3.1) create MySQL tables for SER flavour
586
+	- if you have a previously installed SER on your system, use
587
+    	/usr/sbin/ser_mysql.sh reinstall 
588
+	  to convert your SER database into new structures
589
+	- otherwise, if this is your very first installation, use
590
+    	/usr/sbin/ser_mysql.sh create
591
+	  to create SER database structures
592
+   (you will be prompted for password of MySql "root" user)
582 593
 
583
-3) create MySQL tables
584
-	- if you have a previously installed SIP Router on your system, use
585
-    	/usr/sbin/sip-router_mysql.sh reinstall 
586
-	  to convert your SIP Router database into new structures
594
+3.2) create MySQL tables for Kamailio flavour
595
+	- if you have a previously installed Kamailio on your system, use
596
+    	/usr/sbin/kamdbctl reinstall 
597
+	  to convert your Kamailio database into new structures
587 598
 	- otherwise, if this is your very first installation, use
588
-    	/usr/sbin/sip-router_mysql.sh create
589
-	  to create SIP Router database structures
599
+    	/usr/sbin/kamdbctl create
600
+	  to create Kamailio database structures
590 601
    (you will be prompted for password of MySql "root" user)
591 602
 
592
-4) configure sip-router to use SQL
593
-    uncomment all lines in configuration file sip-router.cfg which are related to 
594
-    authentication:
595
-    - loadmodule "/usr/lib/sip-router/modules/mysql.so"
596
-    - loadmodule "/usr/lib/sip-router/modules/auth.so"
597
-    - loadmodule "/usr/lib/sip-router/modules/auth_db.so"
603
+4) configure SIP server to use SQL
604
+    uncomment all lines in configuration file ser.cfg or kamilio.cfg which are
605
+	related to authentication:
606
+    - loadmodule "db_mysql.so"
607
+    - loadmodule "auth.so"
608
+    - loadmodule "auth_db.so"
598 609
     - modparam("usrloc", "db_mode", 2)
599 610
     - modparam("auth", "calculate_ha1", yes)
600 611
     - modparam("auth_db", "password_column", "password")
601
-    - if (!www_authorize("iptel.org", "subscriber")) {
602
-        www_challenge("iptel.org", "0"); 
612
+    - if (!www_authorize("sip-router.org", "subscriber")) {
613
+        www_challenge("sip-router.org", "0"); 
603 614
         break;
604
-      }; 
615
+      }
616
+
605 617
 5) be sure to replace realm, the first parameter in www_* actions, 
606 618
    with name of your server; some broken UAC implementations don't 
607 619
    authenticate otherwise; the authentication command in your
... ...
@@ -610,18 +705,23 @@ D) sip-router with Persistent Data Storage
610 610
         www_challenge("myserver.foobar.com", "0"); 
611 611
         break;
612 612
       }
613
+
613 614
 6) restart the server
614
-    /etc/init.d/sip-router restart
615
+    /etc/init.d/ser restart
616
+	  or
617
+    /etc/init.d/kamailio restart
615 618
 
616
-7) you can now start  managing the server using the serctl utility; 
619
+7) you can now start  managing the server using the serctl or kamctl utility; 
617 620
    you need to first set the environment variable SIP_DOMAIN to your 
618 621
    local SIP realm, e.g.,
619 622
        export SIP_DOMAIN="myserver.foobar.com"
620 623
 
621
-   a) watch the server status using 'serctl moni'
624
+   a) watch the server status using 'serctl moni' or 'kamctl moni'
622 625
    b) try to login with your SIP client as user 'admin' with password 'heslo'
623 626
    c) try adding new users using 
624 627
        'serctl add <name> <password> <email>'
628
+	     or
629
+       'kamctl add <username> <password>'
625 630
 
626 631
 
627 632
 4. Troubleshooting
... ...
@@ -636,7 +736,7 @@ challenged request at all and pops up authentication window again. If you
636 636
 want to authenticate WM, you need to set up your realm value to equal server 
637 637
 name. If your server has no name, IP address can be used as realm too.
638 638
 
639
-Q: SIP requests are replied by sip-router with "483 Too Many Hops" or 
639
+Q: SIP requests are replied by SIP server with "483 Too Many Hops" or 
640 640
    "513 Message Too Large"
641 641
 
642 642
 A: In both cases, the reason is probably an error in request routing script 
... ...
@@ -649,6 +749,6 @@ A: In both cases, the reason is probably an error in request routing script
649 649
    to happen until value of max_forwards header field reaches zero or
650 650
    the request grows too big. Solutions is easy: make sure that domain
651 651
    matching is correctly configured. A quick way to achieve that is to
652
-   introduce a config option to sip-router.cfg: alias=domainname, where
653
-   domainname shall be replaced with name of domain, which you wish to
652
+   introduce a config option to ser.cfg or kamailio.cfg: alias=domainname,
653
+   where domainname shall be replaced with name of domain, which you wish to
654 654
    server and which appears in request-URIs.