Browse code

INSTALL Remove flavours and ser/serctl

Olle E. Johansson authored on 12/02/2016 20:53:30
Showing 1 changed files
... ...
@@ -10,10 +10,9 @@
10 10
   Welcome! This is an amazingly flexible, robust and secure SIP server
11 11
   built on years of experience in several Open Source projects. It's a merge
12 12
   of the SIP Express Router (SER) and the Kamailio (OpenSER) products produced
13
-  by a joint development team. When not explicitely mentioned, SIP server refers
14
-  to any of these two applications.
13
+  by a joint development team. 
15 14
 
16
-  This memo gives you hints on how to set up the SIP server quickly.
15
+  This memo gives you hints on how to set up the Kamailio quickly.
17 16
   
18 17
   You can find a similar tutorial and many more on project's web site:
19 18
     - http://www.kamailio.org/w/documentation/
... ...
@@ -23,53 +22,21 @@
23 22
 Table of Contents
24 23
 =================
25 24
 
26
-1. SIP Server Flavours
27
-2. Supported Architectures And Requirements
28
-3. How-To Build SIP Server From The Source Code Distribution
29
-   3.1 Kamailio Fast Track Installation
30
-   3.2 Details Installing From Source Code
25
+1. Supported Architectures And Requirements
26
+2. How-To Build SIP Server From The Source Code Distribution
27
+   2.1 Kamailio Fast Track Installation
28
+   2.2 Details Installing From Source Code
31 29
      A) Set SIP Server Flavour
32 30
      B) Build Commands
33
-4. Quick-Start Installation Guide
31
+3. Quick-Start Installation Guide
34 32
    A) Getting Help
35 33
    B) Disclaimers
36 34
    C) Quick Atart
37 35
    D) SIP Server With Persistent Data Storage
38
-5. Troubleshooting
39
-
40
-
41
-
42
-1. SIP Server Flavours
43
-
44
-The two major SIP server flavours are:
45
-  - SIP Express Router (aka SER, the initial project name, started in 2001)
46
-  - Kamailio (former OpenSER)
47
-
48
-Starting with version 3.0.0, the two SIP server flavours are built from
49
-same source code tree. In version 4.0.0 the two source code trees were
50
-merged even more, so a combined module directory is now used.
51
-
52
-Kamailio flavour is the one built by default. SER is, historically speaking, the
53
-first open source SIP server started in 2001. Kamailio forked from SER in
54
-2005 under the initial name OpenSER.
55
-
56
-Starting with version 3.1.0 the differences between the two flavours are
57
-very few, Kamailio enabling next compile time flags:
58
-  - internal statistics
59
-  - application server extensions in tm module
60
-
61
-In version 4.0.0 the modules were merged into one set and the merger
62
-between the two products was completed.
63
-
64
-Kamailio is now the default flavour. Switching between flavours is a matter
65
-of 'make' command parameters.
66
-
67
-Several installation tutorials for Kamailio are available on the web wiki:
68
-  - http://www.kamailio.org/wiki/
36
+4. Troubleshooting
69 37
 
70 38
 
71
-2. Supported Architectures And Requirements
39
+1. Supported Architectures And Requirements
72 40
 -------------------------------------------
73 41
 
74 42
 Supported operating systems:
... ...
@@ -92,7 +59,6 @@ Experimental architectures:
92 59
 
93 60
 There are various configuration options defined in the Makefile.
94 61
 
95
-
96 62
 Requirements:
97 63
 
98 64
 - gcc or icc : gcc >= 2.9x; 3.[12] recommended (it will work with older version
... ...
@@ -187,9 +153,6 @@ OS Notes:
187 153
   add INSTALL=install either to the environment or to the make command line
188 154
   (e.g.: gmake INSTALL=install all).
189 155
   
190
-  Needed packages:
191
-  [TODO]
192
-  
193 156
   Compile example (all the modules and SIP server in a tar.gz):
194 157
      gmake bin INSTALL=install include_modules="mysql jabber cpl-c auth_radius group_radius uri_radius postgres pa"
195 158
 
... ...
@@ -204,8 +167,8 @@ OS Notes:
204 167
       - libradiusclient-ng-dev for libradiusclient
205 168
 	  - other libraries are needed for some other modules,
206 169
 	    see README of the module you want to use
207
-    Both SER and Kamailio flavours have APT deb repositories that allow you to
208
-	install the binaries easily - see the web sites for more details:
170
+    Kamailio have APT deb repositories that allow you to
171
+	install the binaries easily - see the web site for more details:
209 172
 	  - http://kamailio.org
210 173
 
211 174
  Cygwin  (alpha state, partial support)
... ...
@@ -213,7 +176,7 @@ OS Notes:
213 176
  make sure make, bison, flex, minires and minires-devel (needed for the
214 177
  resolver functions) are installed.
215 178
  
216
- Only building SIP server's core and some static modules is supported for now.
179
+ Only building Kamailio's core and some static modules is supported for now.
217 180
  Stuff known not to work:
218 181
            - IPv6 (cygwin doesn't support it yet)
219 182
            - TCP (the tcp code heavily depends on file descriptor passing 
... ...
@@ -222,16 +185,16 @@ OS Notes:
222 185
              backlinking doesn't work in windows by design)
223 186
 
224 187
 
225
-  Compile example (all the modules and SIP server in a tar.gz):
188
+  Compile example (all the modules and Kamailio in a tar.gz):
226 189
      make bin include_modules="mysql jabber cpl-c auth_radius group_radius uri_radius postgres pa"
227 190
 
228 191
 
229
-3. Howto Build SIP Server From Source Code Distribution
192
+2. Howto Build Kamailio From Source Code Distribution
230 193
 -------------------------------------------------------
231 194
 
232 195
 (NOTE: if make doesn't work try gmake instead)
233 196
 
234
-3.1 Kamailio Fast Track Installation
197
+2.1 Kamailio Fast Track Installation
235 198
 ....................................
236 199
 
237 200
 
... ...
@@ -239,7 +202,7 @@ If you are familiar with Unix/Linux build tools aready and you installed
239 202
 the required dependencies, then you can just follow this section, otherwise
240 203
 skip over it.
241 204
 
242
-To get the SIP server installed, in the folder with source code run:
205
+To get Kamailio installed, in the folder with source code run:
243 206
 
244 207
   make cfg
245 208
   make all
... ...
@@ -252,31 +215,16 @@ tls, run:
252 215
   make all
253 216
   make install
254 217
 
255
-3.2 Details Installing From Source Code
218
+2.2 Details Installing From Source Code
256 219
 .......................................
257 220
 
221
+Build Commands
258 222
 
259
-A) Set SIP Server Flavour
260
-
261
-If you don't have a clean source tree, first do:
262
-   make proper
263
-
264
-To build Kamailio flavour, you don't need to do anything special, continue to
265
-read the section 3.B).
266
-
267
-To build SER flavour, you have to run first:
268
-   make FLAVOUR=ser cfg
269
-
270
-The parameter 'FLAVOUR=ser' must be given all the time when make target
271
-is 'cfg'.
272
-
273
-B) Build Commands
274
-
275
-  The SIP server is split in four main parts: The core, the modules, the
223
+  Kamailio is split in four main parts: The core, the modules, the
276 224
   utilties, and scripts/examples.  When you build, you can decide to build
277 225
   only the core, the modules, both, or all.
278 226
 
279
-* Compile SIP server core only:
227
+* Compile Kamailio core only:
280 228
 	make
281 229
 
282 230
 Compile modules except some explicitly excepted (see below)
... ...
@@ -290,23 +238,23 @@ Compile modules except some explicitly excepted (see below)
290 238
   By default make all will not build modules that require external libraries or
291 239
   that are considered to be "experimental". For example, modules that have external
292 240
   dependencies are: db_mysql, jabber, cpl-c, auth_radius, group_radius, uri_radius,
293
-  avp_radius, db_postgres, db_berkely, carrierroute, ...
241
+  avp_radius, db_postgres, db_berkeley, carrierroute, ...
294 242
 
295 243
 Including groups of modules:
296 244
   Instead of compiling the default modules only, you can specify groups of
297 245
   modules to include, according to their status:
298
-  - standard - Modules in this group are considered a standard part of SIP server
246
+  - standard - Modules in this group are considered a standard part of Kamailio
299 247
     (due to widespread usage) but they have no dependencies (note that some of
300 248
     these interplay with external systems. However, they don't have compile
301 249
     or link dependencies).
302 250
 
303 251
   - db - Modules in this group use databases and need a database driver to run.
304 252
     Included are drivers for the text mode db (dbtext) and for dumping
305
-    large ammount of data to files (db_flatstore). See also the mysql or
253
+    large amount of data to files (db_flatstore). See also the mysql or
306 254
     postgres groups.
307 255
 
308
-  - standard_dep -  Modules in this group are considered a standard part of SIP
309
-    server (due to widespread usage) but they have dependencies that must be satisfied
256
+  - standard_dep -  Modules in this group are considered a standard part of Kamailio
257
+    (due to widespread usage) but they have dependencies that must be satisfied
310 258
     for compilation.
311 259
     NOTE! All presence modules (dialog, pa, presence_b2b, rls, xcap) have been
312 260
 	included in this group due to interdependencies
... ...
@@ -318,11 +266,11 @@ Including groups of modules:
318 266
     without enough reports of usage to allow the module into the stable group.
319 267
 	They may or may not have dependencies.
320 268
 
321
-There is another set of groups mainly used by Kamailio flavour, where modules
269
+There is another set of groups mainly used by Kamailio, where modules
322 270
 are grouped based on Debian packaging rules. For example:
323
-   - kstandard - Kamailio flavour's standard modules
271
+   - kstandard - Kamailio standard modules
324 272
 
325
-   - kpresence - Kamailio flavour's SIMPLE presence server modules
273
+   - kpresence - Kamailio SIMPLE presence server modules
326 274
 
327 275
 * To compile core with standard modules:
328 276
 	make group_include="standard" all
... ...
@@ -356,7 +304,7 @@ are grouped based on Debian packaging rules. For example:
356 304
   will show which modules are excluded by default.
357 305
 
358 306
   If you want to install or to build a binary package (a tar.gz with
359
-  SIP server core and the modules), substitute "all" in the above command with
307
+  Kamailio core and the modules), substitute "all" in the above command with
360 308
   "install" or "bin".
361 309
 
362 310
 
... ...
@@ -413,7 +361,6 @@ Make Local Build Config:
413 361
 ------------------------
414 362
 
415 363
   * make cfg or make config - force config and module list regeneration
416
-  
417 364
 
418 365
   Example: 
419 366
 	make cfg include_modules=mysql mode=debug
... ...
@@ -468,11 +415,11 @@ Clean:
468 415
 Compile:
469 416
 --------
470 417
   * make proper
471
-  optional: make cfg  <various cfg. options that should be saved>
418
+     optional: make cfg  <various cfg. options that should be saved>
472 419
   * make
473
-  or gmake on non-Linux systems
420
+     or gmake on non-Linux systems
474 421
   * make modules 
475
-  or make modules exclude_modules="CVS print" etc.
422
+     or make modules exclude_modules="CVS print" etc.
476 423
 
477 424
 Other Make Targets:
478 425
 -------------------
... ...
@@ -515,23 +462,22 @@ Install:
515 462
 
516 463
   Note: If you use prefix parameter in make install then you also need
517 464
   to use this parameter in previous make commands, i.e. make, make modules,
518
-  or make all. If you fail to do this then SIP server will look for the default
465
+  or make all. If you fail to do this then Kamailio will look for the default
519 466
   configuration file in a wrong directory, because the directory of the
520
-  default configuration file is hardcoded into SIP server during compile time. 
467
+  default configuration file is hardcoded into Kamailio during compile time. 
521 468
   When you use a different prefix parameter when installing then the 
522
-  directory hard coded in SIP server and the directory in which the file will be 
469
+  directory hard coded in Kamailio and the directory in which the file will be 
523 470
   installed by make install will not match. (You can specify exact location
524
-  of the configuration file using -f parameter of SIP server).
471
+  of the configuration file using -f parameter of Kamailio).
525 472
 
526 473
   For example, if you do the following:
527 474
 	make all
528 475
 	make prefix=/ install
529 476
 
530 477
   Then the installation will put the default configuration file into
531
-  /etc/ser/ser.cfg or /etc/kamailio/kamailio.cfg (because prefix is /),
532
-  but SIP server will look for the file in /usr/local/etc/ser/ser.cfg or
533
-  /usr/local/etc/kamailio/kamailio.cfg (because there was no prefix parameter
534
-  make all and /usr/local is the default value of prefix).
478
+  /etc/kamailio/kamailio.cfg (because prefix is /),
479
+  but Kamailio will look for the file in /usr/local/etc/kamailio/kamailio.cfg
480
+  (because there was no prefix parameter make all and /usr/local is the default value of prefix).
535 481
 
536 482
   The workaround is trivial, use the same parameters in all make commands:
537 483
 	make prefix=/ all
... ...
@@ -542,19 +488,19 @@ Install:
542 488
   "modules" or "excluded_modules").
543 489
 
544 490
 
545
-4. Quick-Start Installation Guide
491
+3. Quick-Start Installation Guide
546 492
 ---------------------------------
547 493
 
548 494
 A) Getting Help
549 495
 
550
-  This guide gives you instructions on how to set up the SIP server
551
-  (SER or Kamailio) on your box quickly. In case the default configuration
552
-  does not fly, please check the documentation at the SIP server web site
553
-  http://www.kamailio.org to learn how to configure SIP server for your site.
496
+  This guide gives you instructions on how to set up the Kamailio
497
+  on your box quickly. In case the default configuration does not fly, please
498
+  check the documentation at the Kamailio web site
499
+  http://www.kamailio.org to learn how to configure Kamailio for your site.
554 500
 
555 501
   If the documentation does not resolve your problem you may try contacting 
556 502
   our user forum by E-mail at sr-users@lists.sip-router.org -- that is the
557
-  mailing list of the SIP server community. To participate in the mailing list,
503
+  mailing list of the Kamailio community. To participate in the mailing list,
558 504
   please subscribe at the following web address:
559 505
 
560 506
   http://lists.sip-router.org/cgi-bin/mailman/listinfo
... ...
@@ -570,7 +516,7 @@ B) Disclaimers
570 516
 C) Quick Start
571 517
 
572 518
   The following step-by step guide gives you instructions how to install the 
573
-  SQL-free distribution of SIP server. If you need persistence and
519
+  SQL-free distribution of Kamailio. If you need persistence and
574 520
   authentication, then you have to install additional database support --
575 521
   proceed to section D) after you are finished with C).
576 522
 
... ...
@@ -608,24 +554,20 @@ C) Quick Start
608 554
   3) Start the server
609 555
 
610 556
 	RPM + gentoo:
611
-    		/etc/init.d/ser start
612
-			  or
613 557
     		/etc/init.d/kamailio start
614 558
 	debian:
615
-    		SER or Kamailio is started automatically after the install
616
-    		(in case something fails you can start it with '/etc/init.d/ser start'
617
-			or '/etc/init.d/kamailio start')
559
+    		Kamailio is started automatically after the install
560
+    		(in case something fails you can start it with '/etc/init.d/kamailio start')
618 561
 	tar.gz:
619 562
 	Solaris:
620 563
     		the tar.gz does not include an init.d script, you'll have to create one of
621 564
     		your own or adapt one from the source distribution (pkg/debian/init.d,
622 565
     		pkg/rpm/ser.init.*, pkg/gentoo/ser.init, pkg/kamailio/rpm/kamailio.init,
623 566
 			pkg/kamailio/deb/debian/kamailio.init, a.s.o.)
624
-    		You can start SIP server directly with /usr/local/sbin/ser or
567
+    		You can start Kamailio directly with
625 568
 			/usr/local/sbin/kamailio.
626 569
     
627
-  4) Optionally, watch server's health using the
628
-   	serctl or kamctl utility
570
+  4) Optionally, watch server's health using the kamctl utility
629 571
 
630 572
     - to do so, first set the environment variable SIP_DOMAIN to your domain 
631 573
       name, e.g., in Bourne shell, call
... ...
@@ -633,15 +575,10 @@ C) Quick Start
633 575
 	- if you are using other than 'localhost' mysql server for maintaining
634 576
 	  subscriber database, change the variable 'SQL_HOST' to the proper
635 577
 	  host name in the serctl script
636
-    - run the serctl utility
637
-        /usr/sbin/serctl moni
638
-      or
578
+    - run the kamctl utility
639 579
         /usr/sbin/kamctl moni
640 580
       or
641
-        /usr/local/sbin/serctl moni (if you installed SER flavour from a tar.gz
642
-		or solaris package)
643
-      or
644
-        /usr/local/sbin/kamctl moni (if you installed Kamailio flavour from a
581
+        /usr/local/sbin/kamctl moni (if you installed Kamailio from a
645 582
 		tar.gz or solaris package)
646 583
 
647 584
   5) Connect SIP phones
... ...
@@ -656,7 +593,7 @@ C) Quick Start
656 593
 	Auth user:	the ID used for authentication
657 594
 	Secret/Password:	The configured authentication password
658 595
 
659
-D) SIP Server With Persistent Data Storage
596
+D) Kamailio With Persistent Data Storage
660 597
 ------------------------------------------
661 598
 
662 599
   The default configuration is very simple and features many simplifications. 
... ...
@@ -671,7 +608,7 @@ D) SIP Server With Persistent Data Storage
671 608
 
672 609
    set-variable    = max_connections=500
673 610
 
674
-  1) Download the package containing mysql support for SIP server from the links
611
+  1) Download the package containin mysql support for Kamailio from the links
675 612
      you find on: 
676 613
         http://www.kamailio.org/wiki/
677 614
 
... ...
@@ -685,23 +622,12 @@ D) SIP Server With Persistent Data Storage
685 622
     rpm -i <package_name>
686 623
     or
687 624
     dpkg -i <package_name>
688
-	or
689
-	emerge ser
690 625
 	or
691 626
 	emerge kamailio
692 627
 	(if do not want to put 'mysql' into your USE variable you can type:
693
-	 USE="mysql" emerge ser)
628
+	 USE="mysql" emerge kamailio)
694 629
 
695
-  3.1) create MySQL tables for SER flavour
696
-	- if you have a previously installed SER on your system, use
697
-    	/usr/sbin/ser_mysql.sh reinstall 
698
-	  to convert your SER database into new structures
699
-	- otherwise, if this is your very first installation, use
700
-    	/usr/sbin/ser_mysql.sh create
701
-	  to create SER database structures
702
-   (you will be prompted for password of MySql "root" user)
703
-
704
-  3.2) create MySQL tables for Kamailio flavour
630
+  3) create MySQL tables for Kamailio 
705 631
 	- if you have a previously installed Kamailio on your system, use
706 632
     	/usr/local/sbin/kamdbctl reinstall 
707 633
 	  to convert your Kamailio database into new structures
... ...
@@ -710,9 +636,8 @@ D) SIP Server With Persistent Data Storage
710 636
 	  to create Kamailio database structures
711 637
    (you will be prompted for password of MySql "root" user)
712 638
 
713
-  4) configure SIP server to use SQL
714
-    uncomment all lines in configuration file ser.cfg or kamilio.cfg which are
715
-	related to authentication:
639
+  4) configure Kamailio to use SQL
640
+    uncomment all lines in configuration file kamailio.cfg which are related to authentication:
716 641
     - loadmodule "db_mysql.so"
717 642
     - loadmodule "auth.so"
718 643
     - loadmodule "auth_db.so"
... ...
@@ -734,27 +659,24 @@ D) SIP Server With Persistent Data Storage
734 659
       }
735 660
 
736 661
   6) restart the server
737
-    /etc/init.d/ser restart
738
-	  or
662
+
739 663
     /etc/init.d/kamailio restart
740 664
 
741
-  7) you can now start  managing the server using the serctl or kamctl utility; 
665
+  7) you can now start  managing the server using the kamctl utility; 
742 666
    you need to first set the environment variable SIP_DOMAIN to your 
743 667
    local SIP realm, e.g.,
744 668
        export SIP_DOMAIN="myserver.foobar.com"
745 669
 
746
-   a) watch the server status using 'serctl moni' or 'kamctl moni'
670
+   a) watch the server status using 'kamctl moni'
747 671
    b) try to login with your SIP client as user 'admin' with password 'heslo'
748 672
    c) try adding new users using 
749
-       'serctl add <name> <password> <email>'
750
-	     or
751 673
        'kamctl add <username> <password>'
752 674
 
753 675
 
754 676
 4. Troubleshooting
755 677
 ------------------
756 678
 
757
-Q: SIP requests are replied by SIP server with "483 Too Many Hops" or 
679
+Q: SIP requests are replied by Kamailio with "483 Too Many Hops" or 
758 680
    "513 Message Too Large"
759 681
 
760 682
 A: In both cases, the reason is probably an error in request routing script