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 102
 - GNU install, BSD install or Solaris install if you want "make
69 103
   install", "make bin", "make sunpkg" to work
70 104
 - 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 105
 - libxml2 if you want to compile the cpl-c (CPL support) or pa (presence) 
73 106
    modules
74 107
 - libradiusclient-ng (> 5.0) if you need radius support (the auth_radius,
75 108
   group_radius, uri_radius and avp_radius modules)
76 109
 - libpq if you need PostgreSQL support (the db_postgres module)
110
+- libexpat if you want the jabber gateway support (the jabber module) or the
111
+  XMPP gateway support
112
+- libxml2 if you want to use the cpl-c (Call Processing Language) or
113
+  the presence modules (presence and pua*)
114
+- libradius-ng -libs and devel headers- if you want to use functionalities
115
+  with radius support - authentication, accounting, group support, etc
116
+- unixodbc - libs and devel headers - if you want UNIXODBC support as
117
+  DB underlayer
118
+- libxmlrpc-c3 - libs and devel headers - if you want to have XML-RPC support
119
+  for the Management interface (MI)
120
+- libperl - libs and devel headers - if you want PERL connector to support
121
+  perl scripting from you config file (perl module)
122
+- libsnmp9 - libs and devel headers - if you want SNMP client functionality 
123
+  (SNMP AgentX subagent) for Kamailio
124
+- libldap libs and devel headers v2.1 or greater - if you want LDAP support
125
+- libconfuse and devel headers - if you want to compile the carrierroute
126
+  module
127
+- libpcre libs and devel headers - if you want to compile the lcr and dialplan
128
+  modules
77 129
 
78 130
 
79 131
 OS Notes:
... ...
@@ -93,7 +145,7 @@ OS Notes:
93 145
   NOTE: you'll need to add radiusclient_ng=4 to the gmake command line if you
94 146
   use the 0.4.* version.
95 147
   
96
-  Compile example (all the modules and sip-router in a tar.gz):
148
+  Compile example (all the modules and SIP server core in a tar.gz):
97 149
      gmake bin radiusclient_ng=4 include_modules="mysql jabber cpl-c auth_radius group_radius uri_radius postgres pa"
98 150
 
99 151
   OpenBSD 3.7
... ...
@@ -106,7 +158,7 @@ OS Notes:
106 158
    (you need to download and install it, since there is no "official" 
107 159
    openbsd port for it) for libradiusclient-ng 
108 160
 
109
-  Compile example (all the modules and sip-router in a tar.gz):
161
+  Compile example (all the modules and SIP server core in a tar.gz):
110 162
      gmake bin include_modules="mysql jabber cpl-c auth_radius group_radius uri_radius pa"
111 163
 
112 164
   NetBSD 2.0
... ...
@@ -116,7 +168,7 @@ OS Notes:
116 168
   - libxml2-2.6.19 (/usr/pkgsrc/textproc/libxml2) for libxml2
117 169
   - radiusclient-ng-0.5.1 (see OpenBSD)
118 170
   
119
-  Compile example (all the modules and sip-router in a tar.gz):
171
+  Compile example (all the modules and SIP server in a tar.gz):
120 172
      gmake bin include_modules="mysql jabber cpl-c auth_radius group_radius uri_radius pa"
121 173
 
122 174
   Solaris 10
... ...
@@ -130,7 +182,7 @@ OS Notes:
130 182
   Needed packages:
131 183
   [TODO]
132 184
   
133
-  Compile example (all the modules and sip-router in a tar.gz):
185
+  Compile example (all the modules and SIP server in a tar.gz):
134 186
      gmake bin INSTALL=install include_modules="mysql jabber cpl-c auth_radius group_radius uri_radius postgres pa"
135 187
 
136 188
   Linux
... ...
@@ -141,23 +193,20 @@ OS Notes:
141 193
       - libpq-dev for libpq
142 194
       - libexpat1-dev for libexpat
143 195
       - 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 )
196
+      - libradiusclient-ng-dev for libradiusclient
197
+	  - other libraries are needed for some other modules,
198
+	    see README of the module you want to use
199
+    Both SER and Kamailio flavours have APT deb repositories that allow you to
200
+	install the binaries easily - see the web sites for more details:
201
+	  - http://iptel.org/ser
202
+	  - http://kamailio.org
154 203
 
155 204
  Cygwin  (alpha state, partial support)
156 205
  --------------------------------------
157 206
  make sure make, bison, flex, minires and minires-devel (needed for the
158 207
  resolver functions) are installed.
159 208
  
160
- Only building sip-router's core and some static modules is supported for now.
209
+ Only building SIP server's core and some static modules is supported for now.
161 210
  Stuff known not to work:
162 211
            - IPv6 (cygwin doesn't support it yet)
163 212
            - TCP (the tcp code heavily depends on file descriptor passing 
... ...
@@ -166,21 +215,37 @@ OS Notes:
166 215
              backlinking doesn't work in windows by design)
167 216
 
168 217
 
169
-  Compile example (all the modules and sip-router in a tar.gz):
218
+  Compile example (all the modules and SIP server in a tar.gz):
170 219
      make bin include_modules="mysql jabber cpl-c auth_radius group_radius uri_radius postgres pa"
171 220
 
172 221
 
173
-2. Howto Build sip-router From Source Distribution
222
+3. Howto Build SIP Server From Source Distribution
174 223
 -------------------------------------------
175 224
 
176 225
 (NOTE: if make doesn't work try gmake  instead)
177 226
 
178
-  SIP Router is split in four main parts: The core, the modules, the
227
+A) Set SIP Server Flavour
228
+
229
+If you don't have a clean source tree, first do:
230
+   make proper
231
+
232
+To build SER flavour, you don't need to do anything special, continue to
233
+read the section 3.B).
234
+
235
+To build Kamailio flavour, you have to run first:
236
+   make FLAVOUR=kamailio cfg
237
+
238
+The parameter 'FLAVOUR=kamailio' must be given all the time when make target
239
+is 'cfg'.
240
+
241
+B) Build Commands
242
+
243
+  SIP server is split in four main parts: The core, the modules, the
179 244
   utilties, and scripts/examples.  When you build, you can decide to build
180 245
   only the core, the modules, both, or all.
181 246
 
182
-* Compile SIP Router core only:
183
-	make   #builds only sip-router core, equivalent to make sip-router
247
+* Compile SIP server core only:
248
+	make
184 249
 
185 250
 Compile modules except some explicitly excepted (see below)
186 251
 	make modules  - all modules in the modules/ directory (common modules)
... ...
@@ -194,32 +259,42 @@ Compile modules except some explicitly excepted (see below)
194 259
 
195 260
 * Explicitly excepted modules:
196 261
   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
262
+  that are considered to be "experimental". For example, modules that have external
198 263
   dependencies are: db_mysql, jabber, cpl-c, auth_radius, group_radius, uri_radius,
199
-  avp_radius, db_postgres, db_berkely, carrierroute, pa.
264
+  avp_radius, db_postgres, db_berkely, carrierroute, ...
200 265
 
201 266
 Including groups of modules:
202 267
   Instead of compiling the default modules only, you can specify groups of
203 268
   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.
269
+  - standard - Modules in this group are considered a standard part of SIP server
270
+    (due to widespread usage) but they have no dependencies (note that some of
271
+	these interplay with external systems.
206 272
     However, they don't have compile or link dependencies).
207 273
 
208 274
   - 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.
275
+    Included are drivers for the text mode db (dbtext) and for dumping
276
+    large ammount of data to files (db_flatstore). See also the mysql or
277
+    postgres groups.
212 278
 
213
-  - standard_dep -  Modules in this group are considered a standard part of SIP Router (due to widespread usage)
279
+  - standard_dep -  Modules in this group are considered a standard part of SIP
280
+    server(due to widespread usage)
214 281
     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
282
+    NOTE! All presence modules (dialog, pa, presence_b2b, rls, xcap) have been
283
+	included in this group due to interdependencies
284
+
285
+  - stable - Modules in this group satisfy specific or niche applications,
286
+    but are considered stable for production use. They may or may not have
287
+	dependencies
288
+
289
+  - experimental - Modules in this group are either not complete, untested, or
290
+    without enough reports of usage to allow the module into the stable group.
291
+	They may or may not have dependencies.
217 292
 
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
293
+There is another set of groups mainly used by Kamailio flavour, where modules
294
+are grouped based on Debian packaging rules. For example:
295
+   - kstandard - Kamailio flavour's standard modules
220 296
 
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.
297
+   - kpresence - Kamailio flavour's SIMPLE presence server modules
223 298
 
224 299
 * To compile core with standard modules:
225 300
 	make group_include="standard" all
... ...
@@ -242,18 +317,18 @@ Including groups of modules:
242 317
   to specify exactly the modules you want to include, ex.
243 318
 	make include_modules="mymodule" modules
244 319
 
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:
320
+  You can also explicitly skip modules using skip_modules. Let's say you want all
321
+  the standard and standard-dep modules except domain:
247 322
 	make group_include="standard standard-dep" skip_modules="domain" all
248 323
 
249 324
   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:
325
+  modules that will be included. Just replace all (or modules) with print-modules
326
+  and you will see which modules will be included and excluded, ex:
252 327
 	make print-modules
253 328
   will show which modules are excluded by default.
254 329
 
255 330
   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
331
+  SIP server core and the modules), substitute "all" in the above command with
257 332
   "install" or "bin".
258 333
 
259 334
 
... ...
@@ -319,9 +394,9 @@ Configure:
319 394
   Note: if config.mak doesn't exist (e.g. initial checkout or after a make 
320 395
   proper) or if Makefile.defs was changed, the config will be re-generated
321 396
   automatically by the first make command. For example:
322
-  	make cfg  include_modules=mysql; make all
397
+  	make cfg  include_modules=db_mysql; make all
323 398
   is equivalent to 
324
- 	rm config.mak modules.lst; make include_modules=mysql.
399
+ 	rm config.mak modules.lst; make include_modules=db_mysql.
325 400
 
326 401
   * make cfg-defs  (force config regeneration, but don't touch the module list)
327 402
 
... ...
@@ -413,21 +488,21 @@ Install:
413 488
   to use this parameter in previous make commands, i.e. make, make modules,
414 489
   or make all. If you fail to do this then SIP Router will look for the default
415 490
   configuration file in a wrong directory, because the directory of the
416
-  default configuration file is hard coded into sip-router during compile time. 
491
+  default configuration file is hard coded into SIP server during compile time. 
417 492
   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 
493
+  directory hard coded in SIP server and the directory in which the file will be 
419 494
   installed by make install will not match. (You can specify exact location
420
-  of the configuration file using -f parameter of sip-router).
495
+  of the configuration file using -f parameter of SIP server).
421 496
 
422 497
   For example, if you do the following:
423 498
 	make all
424 499
 	make prefix=/ install
425 500
 
426 501
   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).
502
+  /etc/ser/ser.cfg or /etc/kamailio/kamailio.cfg (because prefix is /),
503
+  but SIP server will look for the file in /usr/local/etc/ser/ser.cfg or
504
+  /usr/local/etc/kamailio/kamailio.cfg (because there was no prefix parameter
505
+  make all and /usr/local is the default value of prefix).
431 506
 
432 507
   Workaround is trivial, use the same parameters in all make commands:
433 508
 	make prefix=/ all
... ...
@@ -443,23 +518,18 @@ Install:
443 518
 
444 519
 A) Getting Help
445 520
 
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.
521
+  This guide gives you instructions on how to set up the SIP server
522
+  (SER or Kamailio) on your box quickly. In case the default configuration
523
+  does not fly, please check the documentation at the SIP server web site
524
+  http://sip-router.org to learn how to configure SIP server for your site.
450 525
 
451 526
   If the documentation does not resolve your problem you may try contacting 
452 527
   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,
528
+  mailing list of the SIP server community. To participate in the mailing list,
454 529
   please subscribe at the following web address:
455 530
 
456 531
   http://lists.sip-router.org/cgi-bin/mailman/listinfo
457 532
 
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 533
 B) Disclaimers
464 534
  
465 535
   Note well the default "quick-start" configuration is very simple in order 
... ...
@@ -471,7 +541,7 @@ B) Disclaimers
471 541
 C) Quick Start
472 542
 
473 543
   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
544
+  SQL-free distribution of SIP server. If you need persistence and
475 545
   authentication, then you have to install additional database support --
476 546
   proceed to section D) after you are finished with C).
477 547
 
... ...
@@ -493,12 +563,15 @@ C) Quick Start
493 563
 	debian:
494 564
     		dpkg -i <package_name>
495 565
 	gentoo:
496
-    		emerge sip-router
497
-		(or if use only stable packets: ACCEPT_KEYWORDS="~x86" emerge sip-router)
566
+    		emerge ser
567
+			  or
568
+			emerge kamailio
569
+		(or if use only stable packets: ACCEPT_KEYWORDS="~x86" emerge ser
570
+		or ACCEPT_KEYWORDS="~x86" emerge kamailio)
498 571
 	tar.gz:
499 572
     		cd /; tar zxvf <package_name>_os_arch.tar.gz
500 573
     		(it will install in /usr/local/, and the configuration file in
501
-     		/usr/local/etc/sip-router/sip-router.cfg)
574
+     		/usr/local/etc/ser/ser.cfg or /usr/local/etc/kamailio/kamailio.cfg)
502 575
 	Solaris:
503 576
     		gunzip <package_name>.gz ; pkgadd -d <package_name>
504 577
 	*BSD:
... ...
@@ -507,19 +580,24 @@ C) Quick Start
507 580
 3) Start the server
508 581
 
509 582
 	RPM + gentoo:
510
-    		/etc/init.d/sip-router start
583
+    		/etc/init.d/ser start
584
+			  or
585
+    		/etc/init.d/kamailio start
511 586
 	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)
587
+    		SER or Kamailio is started automatically after the install
588
+    		(in case something fails you can start it with '/etc/init.d/ser start'
589
+			or '/etc/init.d/kamailio start')
514 590
 	tar.gz:
515 591
 	Solaris:
516 592
     		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.
593
+    		your own or adapt one from the source distribution (pkg/debian/init.d,
594
+    		pkg/rpm/ser.init.*, pkg/gentoo/ser.init, pkg/kamailio/rpm/kamailio.init,
595
+			pkg/kamailio/deb/debian/kamailio.init, a.s.o.)
596
+    		You can start SIP server directly with /usr/local/sbin/ser or
597
+			/usr/local/sbin/kamailio.
520 598
     
521 599
 4) optionally, watch server's health using the
522
-   	serctl utility
600
+   	serctl or kamctl utility
523 601
 
524 602
     - to do so, first set the environment variable SIP_DOMAIN to your domain 
525 603
       name, e.g., in Bourne shell, call
... ...
@@ -530,8 +608,13 @@ C) Quick Start
530 608
     - run the serctl utility
531 609
         /usr/sbin/serctl moni
532 610
       or
533
-        /usr/local/sbin/serctl moni (if you installed from a tar.gz or solaris
534
-        package)
611
+        /usr/sbin/kamctl moni
612
+      or
613
+        /usr/local/sbin/serctl moni (if you installed SER flavour from a tar.gz
614
+		or solaris package)
615
+      or
616
+        /usr/local/sbin/kamctl moni (if you installed Kamailio flavour from a
617
+		tar.gz or solaris package)
535 618
 
536 619
 5) Connect SIP phones
537 620
 
... ...
@@ -547,13 +630,13 @@ C) Quick Start
547 630
 	Auth user:	the ID used for authentication
548 631
 	Secret/Password:	The configured authentication password
549 632
 
550
-D) sip-router with Persistent Data Storage
633
+D) SIP Server with Persistent Data Storage
551 634
 ------------------------------------------
552 635
 
553 636
   The default configuration is very simple and features many simplifications. 
554 637
   In particular, it does not authenticate users and loses User Location database 
555 638
   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. 
639
+  locations across reboots, SIP server can be configured to use a database, like MySQL. 
557 640
   Before you proceed, you need to make sure MySQL is installed on your box. Your
558 641
   MySQL server must be configured to deal with a large number of
559 642
   connection. To increase it, set the following line in [mysqld] section
... ...
@@ -561,7 +644,7 @@ D) sip-router with Persistent Data Storage
561 644
 
562 645
    set-variable    = max_connections=500
563 646
 
564
-1) Download the package containing mysql support for sip-router from: 
647
+1) Download the package containing mysql support for SIP server from: 
565 648
     
566 649
     **** site not available yet
567 650
 
... ...
@@ -576,32 +659,44 @@ D) sip-router with Persistent Data Storage
576 659
     or
577 660
     dpkg -i <package_name>
578 661
 	or
579
-	emerge sip-router
662
+	emerge ser
663
+	or
664
+	emerge kamailio
580 665
 	(if do not want to put 'mysql' into your USE variable you can type:
581
-	 USE="mysql" emerge sip-router)
666
+	 USE="mysql" emerge ser)
667
+
668
+3.1) create MySQL tables for SER flavour
669
+	- if you have a previously installed SER on your system, use
670
+    	/usr/sbin/ser_mysql.sh reinstall 
671
+	  to convert your SER database into new structures
672
+	- otherwise, if this is your very first installation, use
673
+    	/usr/sbin/ser_mysql.sh create
674
+	  to create SER database structures
675
+   (you will be prompted for password of MySql "root" user)
582 676
 
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
677
+3.2) create MySQL tables for Kamailio flavour
678
+	- if you have a previously installed Kamailio on your system, use
679
+    	/usr/sbin/kamdbctl reinstall 
680
+	  to convert your Kamailio database into new structures
587 681
 	- otherwise, if this is your very first installation, use
588
-    	/usr/sbin/sip-router_mysql.sh create
589
-	  to create SIP Router database structures
682
+    	/usr/sbin/kamdbctl create
683
+	  to create Kamailio database structures
590 684
    (you will be prompted for password of MySql "root" user)
591 685
 
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"
686
+4) configure SIP server to use SQL
687
+    uncomment all lines in configuration file ser.cfg or kamilio.cfg which are
688
+	related to authentication:
689
+    - loadmodule "db_mysql.so"
690
+    - loadmodule "auth.so"
691
+    - loadmodule "auth_db.so"
598 692
     - modparam("usrloc", "db_mode", 2)
599 693
     - modparam("auth", "calculate_ha1", yes)
600 694
     - modparam("auth_db", "password_column", "password")
601
-    - if (!www_authorize("iptel.org", "subscriber")) {
602
-        www_challenge("iptel.org", "0"); 
695
+    - if (!www_authorize("sip-router.org", "subscriber")) {
696
+        www_challenge("sip-router.org", "0"); 
603 697
         break;
604
-      }; 
698
+      }
699
+
605 700
 5) be sure to replace realm, the first parameter in www_* actions, 
606 701
    with name of your server; some broken UAC implementations don't 
607 702
    authenticate otherwise; the authentication command in your
... ...
@@ -610,18 +705,23 @@ D) sip-router with Persistent Data Storage
610 705
         www_challenge("myserver.foobar.com", "0"); 
611 706
         break;
612 707
       }
708
+
613 709
 6) restart the server
614
-    /etc/init.d/sip-router restart
710
+    /etc/init.d/ser restart
711
+	  or
712
+    /etc/init.d/kamailio restart
615 713
 
616
-7) you can now start  managing the server using the serctl utility; 
714
+7) you can now start  managing the server using the serctl or kamctl utility; 
617 715
    you need to first set the environment variable SIP_DOMAIN to your 
618 716
    local SIP realm, e.g.,
619 717
        export SIP_DOMAIN="myserver.foobar.com"
620 718
 
621
-   a) watch the server status using 'serctl moni'
719
+   a) watch the server status using 'serctl moni' or 'kamctl moni'
622 720
    b) try to login with your SIP client as user 'admin' with password 'heslo'
623 721
    c) try adding new users using 
624 722
        'serctl add <name> <password> <email>'
723
+	     or
724
+       'kamctl add <username> <password>'
625 725
 
626 726
 
627 727
 4. Troubleshooting
... ...
@@ -636,7 +736,7 @@ challenged request at all and pops up authentication window again. If you
636 736
 want to authenticate WM, you need to set up your realm value to equal server 
637 737
 name. If your server has no name, IP address can be used as realm too.
638 738
 
639
-Q: SIP requests are replied by sip-router with "483 Too Many Hops" or 
739
+Q: SIP requests are replied by SIP server with "483 Too Many Hops" or 
640 740
    "513 Message Too Large"
641 741
 
642 742
 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 749
    to happen until value of max_forwards header field reaches zero or
650 750
    the request grows too big. Solutions is easy: make sure that domain
651 751
    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
752
+   introduce a config option to ser.cfg or kamailio.cfg: alias=domainname,
753
+   where domainname shall be replaced with name of domain, which you wish to
654 754
    server and which appears in request-URIs.