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