Browse code

INSTALL Various updates

Olle E. Johansson authored on 09/01/2017 19:58:58
Showing 1 changed files
... ...
@@ -23,16 +23,15 @@ Table of Contents
23 23
 =================
24 24
 
25 25
 1. Supported Architectures And Requirements
26
-2. How-To Build SIP Server From The Source Code Distribution
26
+2. How-To Build Kamailio From The Source Code Distribution
27 27
    2.1 Kamailio Fast Track Installation
28 28
    2.2 Details Installing From Source Code
29
-     A) Set SIP Server Flavour
30
-     B) Build Commands
29
+     A) Build Commands
31 30
 3. Quick-Start Installation Guide
32 31
    A) Getting Help
33 32
    B) Disclaimers
34
-   C) Quick Atart
35
-   D) SIP Server With Persistent Data Storage
33
+   C) Quick Start
34
+   D) Kamailio With Persistent Data Storage
36 35
 4. Troubleshooting
37 36
 
38 37
 
... ...
@@ -45,6 +44,9 @@ Supported operating systems:
45 45
  - Solaris
46 46
  - OS/X, Darwin
47 47
 
48
+Note that some modules have dependencies on the Linux operating system.
49
+This is clearly noted in the README files.
50
+
48 51
 Partially supported
49 52
  - Windows+Cygwin (core + static modules only, no IPv6, no
50 53
    TCP, no dynamic modules)
... ...
@@ -74,7 +76,7 @@ Requirements:
74 74
 - libmysqlclient & libz (zlib) if you want MySQL support (the db_mysql module)
75 75
 - libxml2 if you want to compile the cpl-c (CPL support) or pa (presence) 
76 76
    modules
77
-- libradiusclient-ng (> 5.0) if you need RADIUS support (the auth_radius,
77
+- freeradius or libradiusclient-ng (> 5.0) if you need RADIUS support (the auth_radius,
78 78
   group_radius, uri_radius and avp_radius modules)
79 79
 - libpq if you need PostgreSQL support (the db_postgres module)
80 80
 - libexpat if you want the jabber gateway support (the jabber module) or the
... ...
@@ -85,8 +87,6 @@ Requirements:
85 85
   with radius support - authentication, accounting, group support, etc
86 86
 - unixodbc - libs and devel headers - if you want UNIXODBC support as
87 87
   DB underlayer
88
-- libxmlrpc-c3 - libs and devel headers - if you want to have XML-RPC support
89
-  for the management interface (MI)
90 88
 - libperl - libs and devel headers - if you want the perl connector to support
91 89
   perl scripting from your config file (perl module)
92 90
 - libsnmp9 - libs and devel headers - if you want SNMP client functionality 
... ...
@@ -101,6 +101,8 @@ Requirements:
101 101
 - jdk and gcj for Java module
102 102
 - the jansson library for the jansson module used for JSON document handling
103 103
 
104
+Some modules have other requirements on third-party libraries. This is documented
105
+in the README for the specific module.
104 106
 
105 107
 OS Notes:
106 108
 
... ...
@@ -158,6 +160,9 @@ OS Notes:
158 158
 
159 159
   Linux
160 160
   -----
161
+  Kamailio is part of the official Debian distribution. You can download binary modules
162
+  directly using normal packet management.
163
+
161 164
   Needed packages for compiling all the modules:
162 165
   * Debian:
163 166
       - libmysqlclient-dev for libmysqlclient
... ...
@@ -171,6 +176,7 @@ OS Notes:
171 171
 	install the binaries easily - see the web site for more details:
172 172
 	  - http://kamailio.org
173 173
 
174
+
174 175
  Cygwin  (alpha state, partial support)
175 176
  --------------------------------------
176 177
  make sure make, bison, flex, minires and minires-devel (needed for the
... ...
@@ -215,13 +221,13 @@ tls, run:
215 215
   make all
216 216
   make install
217 217
 
218
-2.2 Details Installing From Source Code
218
+2.2 Details - Installing From Source Code
219 219
 .......................................
220 220
 
221 221
 Build Commands
222 222
 
223 223
   Kamailio is split in four main parts: The core, the modules, the
224
-  utilties, and scripts/examples.  When you build, you can decide to build
224
+  utilities, and the various scripts/examples.  When you build, you can decide to build
225 225
   only the core, the modules, both, or all.
226 226
 
227 227
 * Compile Kamailio core only:
... ...
@@ -399,23 +405,24 @@ Clean:
399 399
 
400 400
   Config clean:
401 401
 
402
-  * make clean-cfg (cleans the compile config)
403
-  * make clean-modules-cfg (cleans the modules list)
402
+  * make clean-cfg       - cleans the compile config
403
+  * make clean-modules-cfg  - cleans the modules list
404 404
 
405
-  Reduced" clean:
405
+  Reduced clean:
406 406
 
407 407
   * make local-clean  	- cleans only the core, no libs, utils or modules
408 408
   * make clean-modules  - like make clean, but cleans only the modules
409 409
   * make clean-libs     - like make clean, but cleans only the libs
410 410
   * make clean-utils    - like make clean, but cleans only the utils
411
-  * make proper-modules - like make proper, but only for modules
412
-  * make proper-libs    - like make proper, but only for libs
413
-  * make proper-utils   - like make proper, but only for utils
411
+
414 412
 
415 413
 Compile:
416 414
 --------
417 415
   * make proper
418 416
      optional: make cfg  <various cfg. options that should be saved>
417
+  * make proper-modules - like make proper, but only for modules
418
+  * make proper-libs    - like make proper, but only for libs
419
+  * make proper-utils   - like make proper, but only for utils
419 420
   * make
420 421
      or gmake on non-Linux systems
421 422
   * make modules 
... ...
@@ -503,7 +510,7 @@ A) Getting Help
503 503
   mailing list of the Kamailio community. To participate in the mailing list,
504 504
   please subscribe at the following web address:
505 505
 
506
-  http://lists.sip-router.org/cgi-bin/mailman/listinfo
506
+  https://lists.sip-router.org/cgi-bin/mailman/listinfo
507 507
 
508 508
 B) Disclaimers
509 509
  
... ...
@@ -522,11 +529,11 @@ C) Quick Start
522 522
 
523 523
   1) Download an RPM or Debian package from the links on the wiki
524 524
 
525
-    http://www.kamailio.org/wiki/
525
+    https://www.kamailio.org/wiki/
526 526
 
527 527
   If you don't use an rpm or debian based distribution, try our tar.gz'ed
528 528
   binaries
529
-    http://www.kamailio.org/pub/kamailio/latest/src/
529
+    https://www.kamailio.org/pub/kamailio/latest/src/
530 530
 
531 531
   If you use Solaris 8 you can try our solaris package.
532 532
   If you use Gentoo Linux you do not have to download a package.
... ...
@@ -537,15 +544,13 @@ C) Quick Start
537 537
 	debian:
538 538
     		dpkg -i <package_name>
539 539
 	gentoo:
540
-    		emerge ser
541
-			  or
542
-			emerge kamailio
543
-		(or if use only stable packets: ACCEPT_KEYWORDS="~x86" emerge ser
544
-		or ACCEPT_KEYWORDS="~x86" emerge kamailio)
540
+		emerge kamailio
541
+		(or if use only stable packets: 
542
+		ACCEPT_KEYWORDS="~x86" emerge kamailio )
545 543
 	tar.gz:
546 544
     		cd /; tar zxvf <package_name>_os_arch.tar.gz
547 545
     		(it will install in /usr/local/, and the configuration file in
548
-     		/usr/local/etc/ser/ser.cfg or /usr/local/etc/kamailio/kamailio.cfg)
546
+		/usr/local/etc/kamailio/kamailio.cfg)
549 547
 	Solaris:
550 548
     		gunzip <package_name>.gz ; pkgadd -d <package_name>
551 549
 	*BSD:
... ...
@@ -562,8 +567,7 @@ C) Quick Start
562 562
 	Solaris:
563 563
     		the tar.gz does not include an init.d script, you'll have to create one of
564 564
     		your own or adapt one from the source distribution (pkg/debian/init.d,
565
-    		pkg/rpm/ser.init.*, pkg/gentoo/ser.init, pkg/kamailio/rpm/kamailio.init,
566
-			pkg/kamailio/deb/debian/kamailio.init, a.s.o.)
565
+    		pkg/kamailio/rpm/kamailio.init, pkg/kamailio/deb/debian/kamailio.init, a.s.o.)
567 566
     		You can start Kamailio directly with
568 567
 			/usr/local/sbin/kamailio.
569 568
     
... ...
@@ -574,7 +578,7 @@ C) Quick Start
574 574
         export SIP_DOMAIN="myserver.foobar.com"
575 575
 	- if you are using other than 'localhost' mysql server for maintaining
576 576
 	  subscriber database, change the variable 'SQL_HOST' to the proper
577
-	  host name in the serctl script
577
+	  host name in the kamctl script
578 578
     - run the kamctl utility
579 579
         /usr/sbin/kamctl moni
580 580
       or
... ...
@@ -608,9 +612,9 @@ D) Kamailio With Persistent Data Storage
608 608
 
609 609
    set-variable    = max_connections=500
610 610
 
611
-  1) Download the package containin mysql support for Kamailio from the links
611
+  1) Download the package containing mysql support for Kamailio from the links
612 612
      you find on: 
613
-        http://www.kamailio.org/wiki/
613
+        https://www.kamailio.org/wiki/
614 614
 
615 615
     (rpm and deb provided, most of the binary tar.gz distributions and the 
616 616
      solaris package include it; if it is not present you'll have to rebuild
... ...
@@ -634,7 +638,7 @@ D) Kamailio With Persistent Data Storage
634 634
 	- otherwise, if this is your very first installation, use
635 635
     	/usr/local/sbin/kamdbctl create
636 636
 	  to create Kamailio database structures
637
-   (you will be prompted for password of MySql "root" user)
637
+     (you will be prompted for password of MySql "root" user)
638 638
 
639 639
   4) configure Kamailio to use SQL
640 640
     uncomment all lines in configuration file kamailio.cfg which are related to authentication:
... ...
@@ -644,33 +648,33 @@ D) Kamailio With Persistent Data Storage
644 644
     - modparam("usrloc", "db_mode", 2)
645 645
     - modparam("auth", "calculate_ha1", yes)
646 646
     - modparam("auth_db", "password_column", "password")
647
-    - if (!www_authorize("sip-router.org", "subscriber")) {
648
-        www_challenge("sip-router.org", "0"); 
647
+    - if (!www_authorize("example.com", "subscriber")) {
648
+        www_challenge("example.com", "0"); 
649 649
         break;
650 650
       }
651 651
 
652 652
   5) be sure to replace realm, the first parameter in www_* actions, 
653
-   with name of your server; some broken UAC implementations don't 
654
-   authenticate otherwise; the authentication command in your
655
-   configuration script should look then like this:
656
-      if (!www_authorize("myserver.foobar.com", "subscriber")) {
657
-        www_challenge("myserver.foobar.com", "0"); 
658
-        break;
659
-      }
653
+     with name of your server; some broken UAC implementations don't 
654
+     authenticate otherwise; the authentication command in your
655
+     configuration script should look then like this:
656
+        if (!www_authorize("myserver.foobar.com", "subscriber")) {
657
+            www_challenge("myserver.foobar.com", "0"); 
658
+            break;
659
+        }
660 660
 
661 661
   6) restart the server
662 662
 
663
-    /etc/init.d/kamailio restart
663
+      /etc/init.d/kamailio restart
664 664
 
665
-  7) you can now start  managing the server using the kamctl utility; 
666
-   you need to first set the environment variable SIP_DOMAIN to your 
667
-   local SIP realm, e.g.,
668
-       export SIP_DOMAIN="myserver.foobar.com"
665
+  7) you can now start managing the server using the kamctl utility; 
666
+     you need to first set the environment variable SIP_DOMAIN to your 
667
+     local SIP realm, e.g.,
668
+       export SIP_DOMAIN="myserver.example.com"
669 669
 
670
-   a) watch the server status using 'kamctl moni'
671
-   b) try to login with your SIP client as user 'admin' with password 'heslo'
672
-   c) try adding new users using 
673
-       'kamctl add <username> <password>'
670
+   	a) watch the server status using 'kamctl moni'
671
+   	b) try to login with your SIP client as user 'admin' with password 'heslo'
672
+   	c) try adding new users using 
673
+       		'kamctl add <username> <password>'
674 674
 
675 675
 
676 676
 4. Troubleshooting
... ...
@@ -699,4 +703,4 @@ A: Use bug tracker at: https://github.com/kamailio/kamailio/issues
699 699
 
700 700
 Q: Any F.A.Q. that could be helpful to check before reporting an issue?
701 701
 
702
-A: See: http://www.kamailio.org/wiki/tutorials/faq/main
702
+A: See: https://www.kamailio.org/wiki/tutorials/faq/main