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 23
 Table of Contents
24 24
 =================
25 25
 
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
26
+1. Supported Architectures And Requirements
27
+2. How-To Build SIP Server From The Source Code Distribution
28
+   2.1 Kamailio Fast Track Installation
29
+   2.2 Details Installing From Source Code
31 30
      A) Set SIP Server Flavour
32 31
      B) Build Commands
33
-4. Quick-Start Installation Guide
32
+3. Quick-Start Installation Guide
34 33
    A) Getting Help
35 34
    B) Disclaimers
36 35
    C) Quick Atart
37 36
    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/
37
+4. Troubleshooting
69 38
 
70 39
 
71
-2. Supported Architectures And Requirements
40
+1. Supported Architectures And Requirements
72 41
 -------------------------------------------
73 42
 
74 43
 Supported operating systems:
... ...
@@ -92,7 +59,6 @@ Experimental architectures:
92 92
 
93 93
 There are various configuration options defined in the Makefile.
94 94
 
95
-
96 95
 Requirements:
97 96
 
98 97
 - gcc or icc : gcc >= 2.9x; 3.[12] recommended (it will work with older version
... ...
@@ -187,9 +153,6 @@ OS Notes:
187 187
   add INSTALL=install either to the environment or to the make command line
188 188
   (e.g.: gmake INSTALL=install all).
189 189
   
190
-  Needed packages:
191
-  [TODO]
192
-  
193 190
   Compile example (all the modules and SIP server in a tar.gz):
194 191
      gmake bin INSTALL=install include_modules="mysql jabber cpl-c auth_radius group_radius uri_radius postgres pa"
195 192
 
... ...
@@ -204,8 +167,8 @@ OS Notes:
204 204
       - libradiusclient-ng-dev for libradiusclient
205 205
 	  - other libraries are needed for some other modules,
206 206
 	    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:
207
+    Kamailio have APT deb repositories that allow you to
208
+	install the binaries easily - see the web site for more details:
209 209
 	  - http://kamailio.org
210 210
 
211 211
  Cygwin  (alpha state, partial support)
... ...
@@ -213,7 +176,7 @@ OS Notes:
213 213
  make sure make, bison, flex, minires and minires-devel (needed for the
214 214
  resolver functions) are installed.
215 215
  
216
- Only building SIP server's core and some static modules is supported for now.
216
+ Only building Kamailio's core and some static modules is supported for now.
217 217
  Stuff known not to work:
218 218
            - IPv6 (cygwin doesn't support it yet)
219 219
            - TCP (the tcp code heavily depends on file descriptor passing 
... ...
@@ -222,16 +185,16 @@ OS Notes:
222 222
              backlinking doesn't work in windows by design)
223 223
 
224 224
 
225
-  Compile example (all the modules and SIP server in a tar.gz):
225
+  Compile example (all the modules and Kamailio in a tar.gz):
226 226
      make bin include_modules="mysql jabber cpl-c auth_radius group_radius uri_radius postgres pa"
227 227
 
228 228
 
229
-3. Howto Build SIP Server From Source Code Distribution
229
+2. Howto Build Kamailio From Source Code Distribution
230 230
 -------------------------------------------------------
231 231
 
232 232
 (NOTE: if make doesn't work try gmake instead)
233 233
 
234
-3.1 Kamailio Fast Track Installation
234
+2.1 Kamailio Fast Track Installation
235 235
 ....................................
236 236
 
237 237
 
... ...
@@ -239,7 +202,7 @@ If you are familiar with Unix/Linux build tools aready and you installed
239 239
 the required dependencies, then you can just follow this section, otherwise
240 240
 skip over it.
241 241
 
242
-To get the SIP server installed, in the folder with source code run:
242
+To get Kamailio installed, in the folder with source code run:
243 243
 
244 244
   make cfg
245 245
   make all
... ...
@@ -252,31 +215,16 @@ tls, run:
252 252
   make all
253 253
   make install
254 254
 
255
-3.2 Details Installing From Source Code
255
+2.2 Details Installing From Source Code
256 256
 .......................................
257 257
 
258
+Build Commands
258 259
 
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
260
+  Kamailio is split in four main parts: The core, the modules, the
276 261
   utilties, and scripts/examples.  When you build, you can decide to build
277 262
   only the core, the modules, both, or all.
278 263
 
279
-* Compile SIP server core only:
264
+* Compile Kamailio core only:
280 265
 	make
281 266
 
282 267
 Compile modules except some explicitly excepted (see below)
... ...
@@ -290,23 +238,23 @@ Compile modules except some explicitly excepted (see below)
290 290
   By default make all will not build modules that require external libraries or
291 291
   that are considered to be "experimental". For example, modules that have external
292 292
   dependencies are: db_mysql, jabber, cpl-c, auth_radius, group_radius, uri_radius,
293
-  avp_radius, db_postgres, db_berkely, carrierroute, ...
293
+  avp_radius, db_postgres, db_berkeley, carrierroute, ...
294 294
 
295 295
 Including groups of modules:
296 296
   Instead of compiling the default modules only, you can specify groups of
297 297
   modules to include, according to their status:
298
-  - standard - Modules in this group are considered a standard part of SIP server
298
+  - standard - Modules in this group are considered a standard part of Kamailio
299 299
     (due to widespread usage) but they have no dependencies (note that some of
300 300
     these interplay with external systems. However, they don't have compile
301 301
     or link dependencies).
302 302
 
303 303
   - db - Modules in this group use databases and need a database driver to run.
304 304
     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
305
+    large amount of data to files (db_flatstore). See also the mysql or
306 306
     postgres groups.
307 307
 
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
308
+  - standard_dep -  Modules in this group are considered a standard part of Kamailio
309
+    (due to widespread usage) but they have dependencies that must be satisfied
310 310
     for compilation.
311 311
     NOTE! All presence modules (dialog, pa, presence_b2b, rls, xcap) have been
312 312
 	included in this group due to interdependencies
... ...
@@ -318,11 +266,11 @@ Including groups of modules:
318 318
     without enough reports of usage to allow the module into the stable group.
319 319
 	They may or may not have dependencies.
320 320
 
321
-There is another set of groups mainly used by Kamailio flavour, where modules
321
+There is another set of groups mainly used by Kamailio, where modules
322 322
 are grouped based on Debian packaging rules. For example:
323
-   - kstandard - Kamailio flavour's standard modules
323
+   - kstandard - Kamailio standard modules
324 324
 
325
-   - kpresence - Kamailio flavour's SIMPLE presence server modules
325
+   - kpresence - Kamailio SIMPLE presence server modules
326 326
 
327 327
 * To compile core with standard modules:
328 328
 	make group_include="standard" all
... ...
@@ -356,7 +304,7 @@ are grouped based on Debian packaging rules. For example:
356 356
   will show which modules are excluded by default.
357 357
 
358 358
   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
359
+  Kamailio core and the modules), substitute "all" in the above command with
360 360
   "install" or "bin".
361 361
 
362 362
 
... ...
@@ -413,7 +361,6 @@ Make Local Build Config:
413 413
 ------------------------
414 414
 
415 415
   * make cfg or make config - force config and module list regeneration
416
-  
417 416
 
418 417
   Example: 
419 418
 	make cfg include_modules=mysql mode=debug
... ...
@@ -468,11 +415,11 @@ Clean:
468 468
 Compile:
469 469
 --------
470 470
   * make proper
471
-  optional: make cfg  <various cfg. options that should be saved>
471
+     optional: make cfg  <various cfg. options that should be saved>
472 472
   * make
473
-  or gmake on non-Linux systems
473
+     or gmake on non-Linux systems
474 474
   * make modules 
475
-  or make modules exclude_modules="CVS print" etc.
475
+     or make modules exclude_modules="CVS print" etc.
476 476
 
477 477
 Other Make Targets:
478 478
 -------------------
... ...
@@ -515,23 +462,22 @@ Install:
515 515
 
516 516
   Note: If you use prefix parameter in make install then you also need
517 517
   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
518
+  or make all. If you fail to do this then Kamailio will look for the default
519 519
   configuration file in a wrong directory, because the directory of the
520
-  default configuration file is hardcoded into SIP server during compile time. 
520
+  default configuration file is hardcoded into Kamailio during compile time. 
521 521
   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 
522
+  directory hard coded in Kamailio and the directory in which the file will be 
523 523
   installed by make install will not match. (You can specify exact location
524
-  of the configuration file using -f parameter of SIP server).
524
+  of the configuration file using -f parameter of Kamailio).
525 525
 
526 526
   For example, if you do the following:
527 527
 	make all
528 528
 	make prefix=/ install
529 529
 
530 530
   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).
531
+  /etc/kamailio/kamailio.cfg (because prefix is /),
532
+  but Kamailio will look for the file in /usr/local/etc/kamailio/kamailio.cfg
533
+  (because there was no prefix parameter make all and /usr/local is the default value of prefix).
535 534
 
536 535
   The workaround is trivial, use the same parameters in all make commands:
537 536
 	make prefix=/ all
... ...
@@ -542,19 +488,19 @@ Install:
542 542
   "modules" or "excluded_modules").
543 543
 
544 544
 
545
-4. Quick-Start Installation Guide
545
+3. Quick-Start Installation Guide
546 546
 ---------------------------------
547 547
 
548 548
 A) Getting Help
549 549
 
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.
550
+  This guide gives you instructions on how to set up the Kamailio
551
+  on your box quickly. In case the default configuration does not fly, please
552
+  check the documentation at the Kamailio web site
553
+  http://www.kamailio.org to learn how to configure Kamailio for your site.
554 554
 
555 555
   If the documentation does not resolve your problem you may try contacting 
556 556
   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,
557
+  mailing list of the Kamailio community. To participate in the mailing list,
558 558
   please subscribe at the following web address:
559 559
 
560 560
   http://lists.sip-router.org/cgi-bin/mailman/listinfo
... ...
@@ -570,7 +516,7 @@ B) Disclaimers
570 570
 C) Quick Start
571 571
 
572 572
   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
573
+  SQL-free distribution of Kamailio. If you need persistence and
574 574
   authentication, then you have to install additional database support --
575 575
   proceed to section D) after you are finished with C).
576 576
 
... ...
@@ -608,24 +554,20 @@ C) Quick Start
608 608
   3) Start the server
609 609
 
610 610
 	RPM + gentoo:
611
-    		/etc/init.d/ser start
612
-			  or
613 611
     		/etc/init.d/kamailio start
614 612
 	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')
613
+    		Kamailio is started automatically after the install
614
+    		(in case something fails you can start it with '/etc/init.d/kamailio start')
618 615
 	tar.gz:
619 616
 	Solaris:
620 617
     		the tar.gz does not include an init.d script, you'll have to create one of
621 618
     		your own or adapt one from the source distribution (pkg/debian/init.d,
622 619
     		pkg/rpm/ser.init.*, pkg/gentoo/ser.init, pkg/kamailio/rpm/kamailio.init,
623 620
 			pkg/kamailio/deb/debian/kamailio.init, a.s.o.)
624
-    		You can start SIP server directly with /usr/local/sbin/ser or
621
+    		You can start Kamailio directly with
625 622
 			/usr/local/sbin/kamailio.
626 623
     
627
-  4) Optionally, watch server's health using the
628
-   	serctl or kamctl utility
624
+  4) Optionally, watch server's health using the kamctl utility
629 625
 
630 626
     - to do so, first set the environment variable SIP_DOMAIN to your domain 
631 627
       name, e.g., in Bourne shell, call
... ...
@@ -633,15 +575,10 @@ C) Quick Start
633 633
 	- if you are using other than 'localhost' mysql server for maintaining
634 634
 	  subscriber database, change the variable 'SQL_HOST' to the proper
635 635
 	  host name in the serctl script
636
-    - run the serctl utility
637
-        /usr/sbin/serctl moni
638
-      or
636
+    - run the kamctl utility
639 637
         /usr/sbin/kamctl moni
640 638
       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
639
+        /usr/local/sbin/kamctl moni (if you installed Kamailio from a
645 640
 		tar.gz or solaris package)
646 641
 
647 642
   5) Connect SIP phones
... ...
@@ -656,7 +593,7 @@ C) Quick Start
656 656
 	Auth user:	the ID used for authentication
657 657
 	Secret/Password:	The configured authentication password
658 658
 
659
-D) SIP Server With Persistent Data Storage
659
+D) Kamailio With Persistent Data Storage
660 660
 ------------------------------------------
661 661
 
662 662
   The default configuration is very simple and features many simplifications. 
... ...
@@ -671,7 +608,7 @@ D) SIP Server With Persistent Data Storage
671 671
 
672 672
    set-variable    = max_connections=500
673 673
 
674
-  1) Download the package containing mysql support for SIP server from the links
674
+  1) Download the package containin mysql support for Kamailio from the links
675 675
      you find on: 
676 676
         http://www.kamailio.org/wiki/
677 677
 
... ...
@@ -686,22 +623,11 @@ D) SIP Server With Persistent Data Storage
686 686
     or
687 687
     dpkg -i <package_name>
688 688
 	or
689
-	emerge ser
690
-	or
691 689
 	emerge kamailio
692 690
 	(if do not want to put 'mysql' into your USE variable you can type:
693
-	 USE="mysql" emerge ser)
691
+	 USE="mysql" emerge kamailio)
694 692
 
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
693
+  3) create MySQL tables for Kamailio 
705 694
 	- if you have a previously installed Kamailio on your system, use
706 695
     	/usr/local/sbin/kamdbctl reinstall 
707 696
 	  to convert your Kamailio database into new structures
... ...
@@ -710,9 +636,8 @@ D) SIP Server With Persistent Data Storage
710 710
 	  to create Kamailio database structures
711 711
    (you will be prompted for password of MySql "root" user)
712 712
 
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:
713
+  4) configure Kamailio to use SQL
714
+    uncomment all lines in configuration file kamailio.cfg which are related to authentication:
716 715
     - loadmodule "db_mysql.so"
717 716
     - loadmodule "auth.so"
718 717
     - loadmodule "auth_db.so"
... ...
@@ -734,27 +659,24 @@ D) SIP Server With Persistent Data Storage
734 734
       }
735 735
 
736 736
   6) restart the server
737
-    /etc/init.d/ser restart
738
-	  or
737
+
739 738
     /etc/init.d/kamailio restart
740 739
 
741
-  7) you can now start  managing the server using the serctl or kamctl utility; 
740
+  7) you can now start  managing the server using the kamctl utility; 
742 741
    you need to first set the environment variable SIP_DOMAIN to your 
743 742
    local SIP realm, e.g.,
744 743
        export SIP_DOMAIN="myserver.foobar.com"
745 744
 
746
-   a) watch the server status using 'serctl moni' or 'kamctl moni'
745
+   a) watch the server status using 'kamctl moni'
747 746
    b) try to login with your SIP client as user 'admin' with password 'heslo'
748 747
    c) try adding new users using 
749
-       'serctl add <name> <password> <email>'
750
-	     or
751 748
        'kamctl add <username> <password>'
752 749
 
753 750
 
754 751
 4. Troubleshooting
755 752
 ------------------
756 753
 
757
-Q: SIP requests are replied by SIP server with "483 Too Many Hops" or 
754
+Q: SIP requests are replied by Kamailio with "483 Too Many Hops" or 
758 755
    "513 Message Too Large"
759 756
 
760 757
 A: In both cases, the reason is probably an error in request routing script