Browse code

INSTALL: updates for v4.0.0

Daniel-Constantin Mierla authored on 10/03/2013 21:07:11
Showing 1 changed files
... ...
@@ -1,12 +1,9 @@
1
-$Id$
2
-
3 1
 
4 2
      ==================================================
5 3
 
6
-          Kamailio Installation Notes
4
+          Kamailio SIP Server Installation Notes
7 5
 
8
-	     http://www.kamailio.org
9
-             http://sip-router.org
6
+                 http://www.kamailio.org
10 7
 
11 8
      ==================================================
12 9
 
... ...
@@ -17,15 +14,11 @@ $Id$
17 17
   not explicitely mentioned, SIP server refers to any of these two
18 18
   applications.
19 19
 
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.
24
-
25
-  We also urge you to read latest ISSUES (available from website
26
-  too) and check for potential problems in this release.
27
-  Users of previous releases are encouraged to read NEWS to learn how to move
28
-  to this new SIP server version.
20
+  This memo gives you hints how to set up the SIP server quickly.
21
+  
22
+  You can find similar tutorial and many more on project's web site:
23
+    - http://www.kamailio.org/w/documentation/
24
+    - http://www.kamailio.org/wiki/
29 25
   
30 26
 
31 27
 Table of Contents
... ...
@@ -34,6 +27,10 @@ Table of Contents
34 34
 1. SIP Server Flavours
35 35
 2. Supported Architectures and Requirements
36 36
 3. Howto Build SIP Server From the Source Distribution
37
+   3.1 Kamailio Fast Track Installation
38
+   3.2 Details Installing from Source Code
39
+     A) Set SIP Server Flavour
40
+     B) Build Commands
37 41
 4. Quick-Start Installation Guide
38 42
    A) Getting Help
39 43
    B) Disclaimers
... ...
@@ -51,7 +48,7 @@ The two major SIP server flavours are:
51 51
   - Kamailio (former OpenSER)
52 52
 
53 53
 Starting with version 3.0.0, the two SIP server flavours are built from
54
-same source code tree. In version 4.0.0 the two source code trees was
54
+same source code tree. In version 4.0.0 the two source code trees were
55 55
 merged even more, so a combined module directory is now used.
56 56
 
57 57
 Kamailio flavor is the one built by default. SER is, historically speaking, the
... ...
@@ -64,10 +61,10 @@ very few, Kamailio enabling next compile time flags:
64 64
   - application server extensions in tm module
65 65
 
66 66
 In version 4.0.0 the modules were merged into one set and the merger
67
-between the two products was completed. Kamailio is now the main
68
-flavour.
67
+between the two products was completed.
69 68
 
70
-Switching between flavours is a matter of 'make' command parameters.
69
+Kamailio is now the default flavour. Switching between flavours is a matter
70
+of 'make' command parameters.
71 71
 
72 72
 Several installation tutorials for Kamailio are available on the web wiki:
73 73
   - http://www.kamailio.org/wiki/
... ...
@@ -135,6 +132,7 @@ Requirements:
135 135
 - libpcre libs and devel headers - if you want to compile the lcr and dialplan
136 136
   modules
137 137
 - libsctp devel headers - if you want to compile the SCTP transport in the core
138
+- libssl devel headers (openssl project) - if you want to compule the TLS module
138 139
 - linunistring - for the Websockets module
139 140
 
140 141
 
... ...
@@ -208,7 +206,6 @@ OS Notes:
208 208
 	    see README of the module you want to use
209 209
     Both SER and Kamailio flavours have APT deb repositories that allow you to
210 210
 	install the binaries easily - see the web sites for more details:
211
-	  - http://iptel.org/ser
212 211
 	  - http://kamailio.org
213 212
 
214 213
  Cygwin  (alpha state, partial support)
... ...
@@ -230,22 +227,47 @@ OS Notes:
230 230
 
231 231
 
232 232
 3. Howto Build SIP Server From Source Distribution
233
+--------------------------------------------------
234
+
235
+(NOTE: if make doesn't work try gmake instead)
236
+
237
+3.1 Kamailio Fast Track Installation
238
+....................................
239
+
240
+
241
+If you are familiar with Unix/Linux  build tools aready and you installed
242
+required dependency, then you can just follow this section, otherwise
243
+skip over it.
244
+
245
+To get the SIP server installed, in the folder with source code run:
246
+
247
+  make cfg
248
+  make all
249
+  make install
250
+
251
+If you want to install with additional modules, for example with mysql and
252
+tls, run:
253
+
254
+  make include_modules="db_mysql tls" cfg
255
+  make all
256
+  make install
257
+
258
+3.2 Details Installing from Source Code
259
+.......................................
233 260
 
234
-(NOTE: if make doesn't work try gmake  instead)
235 261
 
236 262
 A) Set SIP Server Flavour
237 263
 
238 264
 If you don't have a clean source tree, first do:
239 265
    make proper
240 266
 
241
-To build SER flavour, you don't need to do anything special, continue to
267
+To build Kamailio flavour, you don't need to do anything special, continue to
242 268
 read the section 3.B).
243 269
 
244
-To build Kamailio flavour, you have to run first:
245
-   make FLAVOUR=kamailio cfg
270
+To build SER flavour, you have to run first:
271
+   make FLAVOUR=ser cfg
246 272
 
247
-The parameter 'FLAVOUR=kamailio' must be given all the time when make target
273
+The parameter 'FLAVOUR=ser' must be given all the time when make target
248 274
 is 'cfg'.
249 275
 
250 276
 B) Build Commands
... ...
@@ -520,15 +542,15 @@ Install:
520 520
   "modules" or "excluded_modules").
521 521
 
522 522
 
523
-3. Quick-Start Installation Guide
523
+4. Quick-Start Installation Guide
524
+---------------------------------
524 525
 
525 526
 A) Getting Help
526 527
 
527 528
   This guide gives you instructions on how to set up the SIP server
528 529
   (SER or Kamailio) on your box quickly. In case the default configuration
529 530
   does not fly, please check the documentation at the SIP server web site
530
-  http://sip-router.org to learn how to configure SIP server for your site.
531
+  http://www.kamailio.org to learn how to configure SIP server for your site.
531 532
 
532 533
   If the documentation does not resolve your problem you may try contacting 
533 534
   our user forum by E-mail at sr-users@lists.sip-router.org -- that is the
... ...
@@ -564,7 +586,7 @@ C) Quick Start
564 564
   If you use Solaris 8 you can try our solaris package.
565 565
   If you use Gentoo Linux you do not have to download a package.
566 566
 
567
-2) Install the package
567
+  2) Install the package
568 568
 	RPM:
569 569
     		rpm -i <package_name>
570 570
 	debian:
... ...
@@ -584,7 +606,7 @@ C) Quick Start
584 584
 	*BSD:
585 585
     		pkg_add package_name
586 586
     
587
-3) Start the server
587
+  3) Start the server
588 588
 
589 589
 	RPM + gentoo:
590 590
     		/etc/init.d/ser start
... ...
@@ -603,7 +625,7 @@ C) Quick Start
603 603
     		You can start SIP server directly with /usr/local/sbin/ser or
604 604
 			/usr/local/sbin/kamailio.
605 605
     
606
-4) optionally, watch server's health using the
606
+  4) optionally, watch server's health using the
607 607
    	serctl or kamctl utility
608 608
 
609 609
     - to do so, first set the environment variable SIP_DOMAIN to your domain 
... ...
@@ -623,7 +645,7 @@ C) Quick Start
623 623
         /usr/local/sbin/kamctl moni (if you installed Kamailio flavour from a
624 624
 		tar.gz or solaris package)
625 625
 
626
-5) Connect SIP phones
626
+  5) Connect SIP phones
627 627
 
628 628
   Register with the server using your favorite SIP User Agent. You may want to look 
629 629
   at configuration hints for use of various clients on iptel.org site at
... ...
@@ -651,7 +673,7 @@ D) SIP Server with Persistent Data Storage
651 651
 
652 652
    set-variable    = max_connections=500
653 653
 
654
-1) Download the package containing mysql support for SIP server from: 
654
+  1) Download the package containing mysql support for SIP server from: 
655 655
     
656 656
     **** site not available yet
657 657
 
... ...
@@ -661,7 +683,7 @@ D) SIP Server with Persistent Data Storage
661 661
 	For gentoo please include 'mysql' to your USE variable in /etc/make.conf
662 662
 	or give it as variable to the emerge command.
663 663
 
664
-2) install the package
664
+  2) install the package
665 665
     rpm -i <package_name>
666 666
     or
667 667
     dpkg -i <package_name>
... ...
@@ -672,7 +694,7 @@ D) SIP Server with Persistent Data Storage
672 672
 	(if do not want to put 'mysql' into your USE variable you can type:
673 673
 	 USE="mysql" emerge ser)
674 674
 
675
-3.1) create MySQL tables for SER flavour
675
+  3.1) create MySQL tables for SER flavour
676 676
 	- if you have a previously installed SER on your system, use
677 677
     	/usr/sbin/ser_mysql.sh reinstall 
678 678
 	  to convert your SER database into new structures
... ...
@@ -681,7 +703,7 @@ D) SIP Server with Persistent Data Storage
681 681
 	  to create SER database structures
682 682
    (you will be prompted for password of MySql "root" user)
683 683
 
684
-3.2) create MySQL tables for Kamailio flavour
684
+  3.2) create MySQL tables for Kamailio flavour
685 685
 	- if you have a previously installed Kamailio on your system, use
686 686
     	/usr/local/sbin/kamdbctl reinstall 
687 687
 	  to convert your Kamailio database into new structures
... ...
@@ -690,7 +712,7 @@ D) SIP Server with Persistent Data Storage
690 690
 	  to create Kamailio database structures
691 691
    (you will be prompted for password of MySql "root" user)
692 692
 
693
-4) configure SIP server to use SQL
693
+  4) configure SIP server to use SQL
694 694
     uncomment all lines in configuration file ser.cfg or kamilio.cfg which are
695 695
 	related to authentication:
696 696
     - loadmodule "db_mysql.so"
... ...
@@ -704,7 +726,7 @@ D) SIP Server with Persistent Data Storage
704 704
         break;
705 705
       }
706 706
 
707
-5) be sure to replace realm, the first parameter in www_* actions, 
707
+  5) be sure to replace realm, the first parameter in www_* actions, 
708 708
    with name of your server; some broken UAC implementations don't 
709 709
    authenticate otherwise; the authentication command in your
710 710
    configuration script should look then like this:
... ...
@@ -713,12 +735,12 @@ D) SIP Server with Persistent Data Storage
713 713
         break;
714 714
       }
715 715
 
716
-6) restart the server
716
+  6) restart the server
717 717
     /etc/init.d/ser restart
718 718
 	  or
719 719
     /etc/init.d/kamailio restart
720 720
 
721
-7) you can now start  managing the server using the serctl or kamctl utility; 
721
+  7) you can now start  managing the server using the serctl or kamctl utility; 
722 722
    you need to first set the environment variable SIP_DOMAIN to your 
723 723
    local SIP realm, e.g.,
724 724
        export SIP_DOMAIN="myserver.foobar.com"