Browse code

update mailing list URL

Victor Seva authored on 23/08/2018 14:59:11
Showing 1 changed files
... ...
@@ -508,11 +508,11 @@ A) Getting Help
508 508
   http://www.kamailio.org to learn how to configure Kamailio for your site.
509 509
 
510 510
   If the documentation does not resolve your problem you may try contacting
511
-  our user forum by E-mail at sr-users@lists.sip-router.org -- that is the
511
+  our user forum by E-mail at sr-users@lists.kamailio.org -- that is the
512 512
   mailing list of the Kamailio community. To participate in the mailing list,
513 513
   please subscribe at the following web address:
514 514
 
515
-  https://lists.sip-router.org/cgi-bin/mailman/listinfo
515
+  https://lists.kamailio.org/cgi-bin/mailman/listinfo
516 516
 
517 517
 B) Disclaimers
518 518
 
Browse code

INSTALL: removed notes for gentoo

- GH #1530

Daniel-Constantin Mierla authored on 04/07/2018 08:06:16
Showing 1 changed files
... ...
@@ -545,14 +545,6 @@ C) Quick Start
545 545
     		rpm -i <package_name>
546 546
 	debian:
547 547
     		dpkg -i <package_name>
548
-	gentoo:
549
-		emerge kamailio
550
-		(or if use only stable packets:
551
-		ACCEPT_KEYWORDS="~x86" emerge kamailio )
552
-	tar.gz:
553
-    		cd /; tar zxvf <package_name>_os_arch.tar.gz
554
-    		(it will install in /usr/local/, and the configuration file in
555
-		/usr/local/etc/kamailio/kamailio.cfg)
556 548
 	Solaris:
557 549
     		gunzip <package_name>.gz ; pkgadd -d <package_name>
558 550
 	*BSD:
... ...
@@ -560,7 +552,7 @@ C) Quick Start
560 552
 
561 553
   3) Start the server
562 554
 
563
-	RPM + gentoo:
555
+	RPM:
564 556
     		/etc/init.d/kamailio start
565 557
 	debian:
566 558
     		Kamailio is started automatically after the install
... ...
@@ -621,8 +613,6 @@ D) Kamailio With Persistent Data Storage
621 613
     (rpm and deb provided, most of the binary tar.gz distributions and the
622 614
      solaris package include it; if it is not present you'll have to rebuild
623 615
      from the source).
624
-	For gentoo please include 'mysql' to your USE variable in /etc/make.conf
625
-	or give it as variable to the emerge command.
626 616
 
627 617
   2) install the package
628 618
     rpm -i <package_name>
Browse code

core: README - INSTALL small updates for development v5.2

Daniel-Constantin Mierla authored on 11/12/2017 13:42:22
Showing 1 changed files
... ...
@@ -10,14 +10,14 @@
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. 
13
+  by a joint development team.
14 14
 
15 15
   This memo gives you hints on how to set up the Kamailio quickly.
16
-  
16
+
17 17
   You can find a similar tutorial and many more on project's web site:
18
-    - http://www.kamailio.org/w/documentation/
19
-    - http://www.kamailio.org/wiki/
20
-  
18
+    - https://www.kamailio.org/w/documentation/
19
+    - https://www.kamailio.org/wiki/
20
+
21 21
 
22 22
 Table of Contents
23 23
 =================
... ...
@@ -63,7 +63,7 @@ There are various configuration options defined in the Makefile.
63 63
 
64 64
 Requirements:
65 65
 
66
-- gcc or clang: 
66
+- gcc or clang:
67 67
      gcc >= 2.9x; 3.[12] recommended (it will work with older version
68 68
      but it might require some options tweaking for best performance)
69 69
      clang >= version 3.3
... ...
@@ -76,10 +76,10 @@ Requirements:
76 76
 - GNU install, BSD install or Solaris install if you want "make
77 77
   install", "make bin", "make sunpkg" to work
78 78
 - libmysqlclient & libz (zlib) if you want MySQL support (the db_mysql module)
79
-- libxml2 if you want to compile the cpl-c (CPL support) or pa (presence) 
79
+- libxml2 if you want to compile the cpl-c (CPL support) or pa (presence)
80 80
    modules
81
-- freeradius or libradiusclient-ng (> 5.0) if you need RADIUS support (the auth_radius,
82
-  group_radius, uri_radius and avp_radius modules)
81
+- freeradius, radcli or libradiusclient-ng (> 5.0) if you need RADIUS support
82
+  (the auth_radius, acc_radius and misc_radius modules)
83 83
 - libpq if you need PostgreSQL support (the db_postgres module)
84 84
 - libexpat if you want the jabber gateway support (the jabber module) or the
85 85
   XMPP gateway support
... ...
@@ -91,7 +91,7 @@ Requirements:
91 91
   DB underlayer
92 92
 - libperl - libs and devel headers - if you want the perl connector to support
93 93
   perl scripting from your config file (perl module)
94
-- libsnmp9 - libs and devel headers - if you want SNMP client functionality 
94
+- libsnmp9 - libs and devel headers - if you want SNMP client functionality
95 95
   (SNMP AgentX subagent) for Kamailio
96 96
 - libldap libs and devel headers v2.1 or greater - if you want LDAP support
97 97
 - libpcre libs and devel headers - if you want to compile the lcr and dialplan
... ...
@@ -109,7 +109,7 @@ in the README for the specific module.
109 109
 OS Notes:
110 110
 
111 111
  FreeBSD/OpenBSD/NetBSD: make sure gmake, bison or yacc & flex are installed.
112
-  
112
+
113 113
   FreeBSD 5.4:
114 114
   ------------
115 115
   If you want to compile all the modules, you will need the following packages:
... ...
@@ -119,10 +119,10 @@ OS Notes:
119 119
     libpq
120 120
   - expat-1.95.8 (/usr/ports/textproc/expat2) for libexpat
121 121
   - libxml2-2.6.18 (/usr/ports/textproc/libxml2) for libxml2
122
-  - radiusclient-0.4.7 (/usr/ports/net/radiusclient) for libradiusclient-ng 
122
+  - radiusclient-0.4.7 (/usr/ports/net/radiusclient) for libradiusclient-ng
123 123
   NOTE: you'll need to add radiusclient_ng=4 to the gmake command line if you
124 124
   use the 0.4.* version.
125
-  
125
+
126 126
   Compile example (all the modules and SIP server core in a tar.gz):
127 127
      gmake bin radiusclient_ng=4 include_modules="mysql jabber cpl-c auth_radius group_radius uri_radius postgres pa"
128 128
 
... ...
@@ -131,10 +131,10 @@ OS Notes:
131 131
   - mysql-client-4.0.23 (/usr/ports/databases/mysql) for libmysqlclient
132 132
   - expat-1.95.6 (/usr/ports/textproc/expat) for libexpat
133 133
   - libxml-2.6.16p0 (/usr/ports/textproc/libxml) for libxml2
134
-  - radiusclient-ng-0.5.1 from 
134
+  - radiusclient-ng-0.5.1 from
135 135
    http://download.berlios.de/radiusclient-ng/radiusclient-ng-0.5.1.tar.gz
136
-   (you need to download and install it, since there is no "official" 
137
-   openbsd port for it) for libradiusclient-ng 
136
+   (you need to download and install it, since there is no "official"
137
+   openbsd port for it) for libradiusclient-ng
138 138
 
139 139
   Compile example (all the modules and SIP server core in a tar.gz):
140 140
      gmake bin include_modules="mysql jabber cpl-c auth_radius group_radius uri_radius pa"
... ...
@@ -145,7 +145,7 @@ OS Notes:
145 145
   - expat-1.95.8nb2 (/usr/pkgsrc/textproc/expat) for libexpat
146 146
   - libxml2-2.6.19 (/usr/pkgsrc/textproc/libxml2) for libxml2
147 147
   - radiusclient-ng-0.5.1 (see OpenBSD)
148
-  
148
+
149 149
   Compile example (all the modules and SIP server in a tar.gz):
150 150
      gmake bin include_modules="mysql jabber cpl-c auth_radius group_radius uri_radius pa"
151 151
 
... ...
@@ -156,7 +156,7 @@ OS Notes:
156 156
   install, just make sure it's in the PATH (it's usually in /usr/sbin) and
157 157
   add INSTALL=install either to the environment or to the make command line
158 158
   (e.g.: gmake INSTALL=install all).
159
-  
159
+
160 160
   Compile example (all the modules and SIP server in a tar.gz):
161 161
      gmake bin INSTALL=install include_modules="mysql jabber cpl-c auth_radius group_radius uri_radius postgres pa"
162 162
 
... ...
@@ -183,11 +183,11 @@ OS Notes:
183 183
  --------------------------------------
184 184
  make sure make, bison, flex, minires and minires-devel (needed for the
185 185
  resolver functions) are installed.
186
- 
186
+
187 187
  Only building Kamailio's core and some static modules is supported for now.
188 188
  Stuff known not to work:
189 189
            - IPv6 (cygwin doesn't support it yet)
190
-           - TCP (the tcp code heavily depends on file descriptor passing 
190
+           - TCP (the tcp code heavily depends on file descriptor passing
191 191
              between processes, which is not yet supported by cygwin)
192 192
            - dynamic modules (non statically linked -- not supported because
193 193
              backlinking doesn't work in windows by design)
... ...
@@ -224,7 +224,7 @@ tls, run:
224 224
   make install
225 225
 
226 226
 2.2 Details - Installing From Source Code
227
-.......................................
227
+.........................................
228 228
 
229 229
 Build Commands
230 230
 
... ...
@@ -236,8 +236,8 @@ Build Commands
236 236
 	make
237 237
 
238 238
 Compile modules except some explicitly excepted (see below)
239
-	make modules  - all modules in the modules/ directory 
240
-	make modules-all or make every-module  - all the modules 
239
+	make modules  - all modules in the modules/ directory
240
+	make modules-all or make every-module  - all the modules
241 241
 
242 242
 * Compile all:
243 243
 	make all
... ...
@@ -296,7 +296,7 @@ are grouped based on Debian packaging rules. For example:
296 296
   Ex. to make a standard installation with MySQL, use:
297 297
 	make group_include="standard mysql" all
298 298
 
299
-  In addition to group_include (or instead), you can use 
299
+  In addition to group_include (or instead), you can use
300 300
 	include_modules="modA modB"
301 301
   to specify exactly the modules you want to include, ex.
302 302
 	make include_modules="mymodule" modules
... ...
@@ -326,18 +326,18 @@ are grouped based on Debian packaging rules. For example:
326 326
 	make mode=debug PROFILE=-pg all
327 327
   - compile only the print module
328 328
 	make modules=modules/print modules
329
-  - compile by default only the print module, in debuging mode and with 
329
+  - compile by default only the print module, in debuging mode and with
330 330
     profiling:
331 331
 	make cfg modules=modules/print mode=debug PROFILE=-pg
332 332
 	make all
333 333
   - change & save the  modules list without rebuilding the whole config
334
-    (so that already compiled modules won't be re-compiled by 
334
+    (so that already compiled modules won't be re-compiled by
335 335
     make all/make modules):
336 336
 	make modules-cfg include_modules="mysql postgress"
337 337
   - change only the compile/build options, without changing the modules list:
338 338
 	make cfg-defs CPU=ultrasparc PROFILE=-pg
339
-  - compile by default all the usual modules + mysql and postgres, optimized 
340
-     for pentium-m and for space (saves both the build options and the module 
339
+  - compile by default all the usual modules + mysql and postgres, optimized
340
+     for pentium-m and for space (saves both the build options and the module
341 341
      list)
342 342
 	make cfg include_modules="mysql postgres" CPU=pentium-m CC_EXTRA_OPTS=-Os
343 343
 	make all
... ...
@@ -370,16 +370,16 @@ Make Local Build Config:
370 370
 
371 371
   * make cfg or make config - force config and module list regeneration
372 372
 
373
-  Example: 
373
+  Example:
374 374
 	make cfg include_modules=mysql mode=debug
375 375
 
376 376
   All future make invocations will include the mysql module and will build in debug mode
377 377
 
378
-  Note: If config.mak doesn't exist (e.g. initial checkout or after a make 
378
+  Note: If config.mak doesn't exist (e.g. initial checkout or after a make
379 379
   proper) or if Makefile.defs was changed, the config will be re-generated
380 380
   automatically by the first make command. For example:
381 381
   	make cfg  include_modules=db_mysql; make all
382
-  is equivalent to 
382
+  is equivalent to
383 383
  	rm config.mak modules.lst; make include_modules=db_mysql.
384 384
 
385 385
   * make cfg-defs  (force config regeneration, but don't touch the module list)
... ...
@@ -400,7 +400,7 @@ Clean:
400 400
   * make clean   	- clean the base and modules too
401 401
   * make proper  	- clean also the dependencies and the config, but not the module list
402 402
   * make distclean 	- the same as proper
403
-  * make maintainer-clean - clean everything, including make's config, saved 
403
+  * make maintainer-clean - clean everything, including make's config, saved
404 404
   			  module list, auto generated files, tags, *.dbg a.s.o
405 405
   * make clean-all	- clean all the modules in modules/*
406 406
   * make proper-all 	- like make proper but for all the  modules in modules/*
... ...
@@ -427,7 +427,7 @@ Compile:
427 427
   * make proper-utils   - like make proper, but only for utils
428 428
   * make
429 429
      or gmake on non-Linux systems
430
-  * make modules 
430
+  * make modules
431 431
      or make modules exclude_modules="CVS print" etc.
432 432
 
433 433
 Other Make Targets:
... ...
@@ -473,9 +473,9 @@ Install:
473 473
   to use this parameter in previous make commands, i.e. make, make modules,
474 474
   or make all. If you fail to do this then Kamailio will look for the default
475 475
   configuration file in a wrong directory, because the directory of the
476
-  default configuration file is hardcoded into Kamailio during compile time. 
477
-  When you use a different prefix parameter when installing then the 
478
-  directory hard coded in Kamailio and the directory in which the file will be 
476
+  default configuration file is hardcoded into Kamailio during compile time.
477
+  When you use a different prefix parameter when installing then the
478
+  directory hard coded in Kamailio and the directory in which the file will be
479 479
   installed by make install will not match. (You can specify exact location
480 480
   of the configuration file using -f parameter of Kamailio).
481 481
 
... ...
@@ -507,7 +507,7 @@ A) Getting Help
507 507
   check the documentation at the Kamailio web site
508 508
   http://www.kamailio.org to learn how to configure Kamailio for your site.
509 509
 
510
-  If the documentation does not resolve your problem you may try contacting 
510
+  If the documentation does not resolve your problem you may try contacting
511 511
   our user forum by E-mail at sr-users@lists.sip-router.org -- that is the
512 512
   mailing list of the Kamailio community. To participate in the mailing list,
513 513
   please subscribe at the following web address:
... ...
@@ -515,16 +515,16 @@ A) Getting Help
515 515
   https://lists.sip-router.org/cgi-bin/mailman/listinfo
516 516
 
517 517
 B) Disclaimers
518
- 
519
-  Note well the default "quick-start" configuration is very simple in order 
520
-  to be easily installable. It provides minimum features. Particularly, 
518
+
519
+  Note well the default "quick-start" configuration is very simple in order
520
+  to be easily installable. It provides minimum features. Particularly,
521 521
   authentication is by default disabled, which means anyone can register using
522
-  any name with the server. (This is on purpose to avoid installation 
522
+  any name with the server. (This is on purpose to avoid installation
523 523
   dependencies on a database, which is needed for storing user credentials.)
524 524
 
525 525
 C) Quick Start
526 526
 
527
-  The following step-by step guide gives you instructions how to install the 
527
+  The following step-by step guide gives you instructions how to install the
528 528
   SQL-free distribution of Kamailio. If you need persistence and
529 529
   authentication, then you have to install additional database support --
530 530
   proceed to section D) after you are finished with C).
... ...
@@ -547,7 +547,7 @@ C) Quick Start
547 547
     		dpkg -i <package_name>
548 548
 	gentoo:
549 549
 		emerge kamailio
550
-		(or if use only stable packets: 
550
+		(or if use only stable packets:
551 551
 		ACCEPT_KEYWORDS="~x86" emerge kamailio )
552 552
 	tar.gz:
553 553
     		cd /; tar zxvf <package_name>_os_arch.tar.gz
... ...
@@ -557,7 +557,7 @@ C) Quick Start
557 557
     		gunzip <package_name>.gz ; pkgadd -d <package_name>
558 558
 	*BSD:
559 559
     		pkg_add package_name
560
-    
560
+
561 561
   3) Start the server
562 562
 
563 563
 	RPM + gentoo:
... ...
@@ -572,10 +572,10 @@ C) Quick Start
572 572
     		pkg/kamailio/rpm/kamailio.init, pkg/kamailio/deb/debian/kamailio.init, a.s.o.)
573 573
     		You can start Kamailio directly with
574 574
 			/usr/local/sbin/kamailio.
575
-    
575
+
576 576
   4) Optionally, watch server's health using the kamctl utility
577 577
 
578
-    - to do so, first set the environment variable SIP_DOMAIN to your domain 
578
+    - to do so, first set the environment variable SIP_DOMAIN to your domain
579 579
       name, e.g., in Bourne shell, call
580 580
         export SIP_DOMAIN="myserver.foobar.com"
581 581
 	- if you are using other than 'localhost' mysql server for maintaining
... ...
@@ -589,7 +589,7 @@ C) Quick Start
589 589
 
590 590
   5) Connect SIP phones
591 591
 
592
-  Register with the server using your favorite SIP User Agent (phone). 
592
+  Register with the server using your favorite SIP User Agent (phone).
593 593
 
594 594
   In most cases, you need to set the following options:
595 595
 
... ...
@@ -602,10 +602,10 @@ C) Quick Start
602 602
 D) Kamailio With Persistent Data Storage
603 603
 ------------------------------------------
604 604
 
605
-  The default configuration is very simple and features many simplifications. 
606
-  In particular, it does not authenticate users and loses User Location database 
607
-  on reboot. To provide persistence, keep user credentials and remember users' 
608
-  locations across reboots, Kamailio can be configured to use a database, like MySQL. 
605
+  The default configuration is very simple and features many simplifications.
606
+  In particular, it does not authenticate users and loses User Location database
607
+  on reboot. To provide persistence, keep user credentials and remember users'
608
+  locations across reboots, Kamailio can be configured to use a database, like MySQL.
609 609
 
610 610
   Before you proceed, you need to make sure MySQL is installed on your box. Your
611 611
   MySQL server must be configured to deal with a large number of
... ...
@@ -615,10 +615,10 @@ D) Kamailio With Persistent Data Storage
615 615
    set-variable    = max_connections=500
616 616
 
617 617
   1) Download the package containing mysql support for Kamailio from the links
618
-     you find on: 
618
+     you find on:
619 619
         https://www.kamailio.org/wiki/
620 620
 
621
-    (rpm and deb provided, most of the binary tar.gz distributions and the 
621
+    (rpm and deb provided, most of the binary tar.gz distributions and the
622 622
      solaris package include it; if it is not present you'll have to rebuild
623 623
      from the source).
624 624
 	For gentoo please include 'mysql' to your USE variable in /etc/make.conf
... ...
@@ -633,9 +633,9 @@ D) Kamailio With Persistent Data Storage
633 633
 	(if do not want to put 'mysql' into your USE variable you can type:
634 634
 	 USE="mysql" emerge kamailio)
635 635
 
636
-  3) create MySQL tables for Kamailio 
636
+  3) create MySQL tables for Kamailio
637 637
 	- if you have a previously installed Kamailio on your system, use
638
-    	/usr/local/sbin/kamdbctl reinstall 
638
+    	/usr/local/sbin/kamdbctl reinstall
639 639
 	  to convert your Kamailio database into new structures
640 640
 	- otherwise, if this is your very first installation, use
641 641
     	/usr/local/sbin/kamdbctl create
... ...
@@ -651,16 +651,16 @@ D) Kamailio With Persistent Data Storage
651 651
     - modparam("auth", "calculate_ha1", yes)
652 652
     - modparam("auth_db", "password_column", "password")
653 653
     - if (!www_authorize("example.com", "subscriber")) {
654
-        www_challenge("example.com", "0"); 
654
+        www_challenge("example.com", "0");
655 655
         break;
656 656
       }
657 657
 
658
-  5) be sure to replace realm, the first parameter in www_* actions, 
659
-     with name of your server; some broken UAC implementations don't 
658
+  5) be sure to replace realm, the first parameter in www_* actions,
659
+     with name of your server; some broken UAC implementations don't
660 660
      authenticate otherwise; the authentication command in your
661 661
      configuration script should look then like this:
662 662
         if (!www_authorize("myserver.foobar.com", "subscriber")) {
663
-            www_challenge("myserver.foobar.com", "0"); 
663
+            www_challenge("myserver.foobar.com", "0");
664 664
             break;
665 665
         }
666 666
 
... ...
@@ -668,25 +668,25 @@ D) Kamailio With Persistent Data Storage
668 668
 
669 669
       /etc/init.d/kamailio restart
670 670
 
671
-  7) you can now start managing the server using the kamctl utility; 
672
-     you need to first set the environment variable SIP_DOMAIN to your 
671
+  7) you can now start managing the server using the kamctl utility;
672
+     you need to first set the environment variable SIP_DOMAIN to your
673 673
      local SIP realm, e.g.,
674 674
        export SIP_DOMAIN="myserver.example.com"
675 675
 
676 676
    	a) watch the server status using 'kamctl moni'
677 677
    	b) try to login with your SIP client as user 'admin' with password 'heslo'
678
-   	c) try adding new users using 
678
+   	c) try adding new users using
679 679
        		'kamctl add <username> <password>'
680 680
 
681 681
 
682 682
 4. Troubleshooting
683 683
 ------------------
684 684
 
685
-Q: SIP requests are replied by Kamailio with "483 Too Many Hops" or 
685
+Q: SIP requests are replied by Kamailio with "483 Too Many Hops" or
686 686
    "513 Message Too Large"
687 687
 
688
-A: In both cases, the reason is probably an error in request routing script 
689
-   which caused an infinite loop. You can easily verify whether this happens 
688
+A: In both cases, the reason is probably an error in request routing script
689
+   which caused an infinite loop. You can easily verify whether this happens
690 690
    by watching SIP traffic on loopback interface. A typical reason for
691 691
    misrouting is a failure to match local domain correctly. If a server
692 692
    fails to recognize a request for itself, it will try to forward it to
Browse code

INSTALL updating compiler requirements

Olle E. Johansson authored on 10/01/2017 16:34:57
Showing 1 changed files
... ...
@@ -63,8 +63,10 @@ There are various configuration options defined in the Makefile.
63 63
 
64 64
 Requirements:
65 65
 
66
-- gcc or icc : gcc >= 2.9x; 3.[12] recommended (it will work with older version
67
-  but it might require some options tweaking for best performance)
66
+- gcc or clang: 
67
+     gcc >= 2.9x; 3.[12] recommended (it will work with older version
68
+     but it might require some options tweaking for best performance)
69
+     clang >= version 3.3
68 70
 - bison or yacc (Berkley Yacc)
69 71
 - flex
70 72
 - GNU make (on Linux this is the standard "make", on *BSD and Solaris it is
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 44
  - Solaris
46 45
  - OS/X, Darwin
47 46
 
47
+Note that some modules have dependencies on the Linux operating system.
48
+This is clearly noted in the README files.
49
+
48 50
 Partially supported
49 51
  - Windows+Cygwin (core + static modules only, no IPv6, no
50 52
    TCP, no dynamic modules)
... ...
@@ -74,7 +76,7 @@ Requirements:
74 76
 - libmysqlclient & libz (zlib) if you want MySQL support (the db_mysql module)
75 77
 - libxml2 if you want to compile the cpl-c (CPL support) or pa (presence) 
76 78
    modules
77
-- libradiusclient-ng (> 5.0) if you need RADIUS support (the auth_radius,
79
+- freeradius or libradiusclient-ng (> 5.0) if you need RADIUS support (the auth_radius,
78 80
   group_radius, uri_radius and avp_radius modules)
79 81
 - libpq if you need PostgreSQL support (the db_postgres module)
80 82
 - libexpat if you want the jabber gateway support (the jabber module) or the
... ...
@@ -85,8 +87,6 @@ Requirements:
85 87
   with radius support - authentication, accounting, group support, etc
86 88
 - unixodbc - libs and devel headers - if you want UNIXODBC support as
87 89
   DB underlayer
88
-- libxmlrpc-c3 - libs and devel headers - if you want to have XML-RPC support
89
-  for the management interface (MI)
90 90
 - libperl - libs and devel headers - if you want the perl connector to support
91 91
   perl scripting from your config file (perl module)
92 92
 - 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 160
 
159 161
   Linux
160 162
   -----
163
+  Kamailio is part of the official Debian distribution. You can download binary modules
164
+  directly using normal packet management.
165
+
161 166
   Needed packages for compiling all the modules:
162 167
   * Debian:
163 168
       - libmysqlclient-dev for libmysqlclient
... ...
@@ -171,6 +176,7 @@ OS Notes:
171 176
 	install the binaries easily - see the web site for more details:
172 177
 	  - http://kamailio.org
173 178
 
179
+
174 180
  Cygwin  (alpha state, partial support)
175 181
  --------------------------------------
176 182
  make sure make, bison, flex, minires and minires-devel (needed for the
... ...
@@ -215,13 +221,13 @@ tls, run:
215 221
   make all
216 222
   make install
217 223
 
218
-2.2 Details Installing From Source Code
224
+2.2 Details - Installing From Source Code
219 225
 .......................................
220 226
 
221 227
 Build Commands
222 228
 
223 229
   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
230
+  utilities, and the various scripts/examples.  When you build, you can decide to build
225 231
   only the core, the modules, both, or all.
226 232
 
227 233
 * Compile Kamailio core only:
... ...
@@ -399,23 +405,24 @@ Clean:
399 405
 
400 406
   Config clean:
401 407
 
402
-  * make clean-cfg (cleans the compile config)
403
-  * make clean-modules-cfg (cleans the modules list)
408
+  * make clean-cfg       - cleans the compile config
409
+  * make clean-modules-cfg  - cleans the modules list
404 410
 
405
-  Reduced" clean:
411
+  Reduced clean:
406 412
 
407 413
   * make local-clean  	- cleans only the core, no libs, utils or modules
408 414
   * make clean-modules  - like make clean, but cleans only the modules
409 415
   * make clean-libs     - like make clean, but cleans only the libs
410 416
   * 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
417
+
414 418
 
415 419
 Compile:
416 420
 --------
417 421
   * make proper
418 422
      optional: make cfg  <various cfg. options that should be saved>
423
+  * make proper-modules - like make proper, but only for modules
424
+  * make proper-libs    - like make proper, but only for libs
425
+  * make proper-utils   - like make proper, but only for utils
419 426
   * make
420 427
      or gmake on non-Linux systems
421 428
   * make modules 
... ...
@@ -503,7 +510,7 @@ A) Getting Help
503 510
   mailing list of the Kamailio community. To participate in the mailing list,
504 511
   please subscribe at the following web address:
505 512
 
506
-  http://lists.sip-router.org/cgi-bin/mailman/listinfo
513
+  https://lists.sip-router.org/cgi-bin/mailman/listinfo
507 514
 
508 515
 B) Disclaimers
509 516
  
... ...
@@ -522,11 +529,11 @@ C) Quick Start
522 529
 
523 530
   1) Download an RPM or Debian package from the links on the wiki
524 531
 
525
-    http://www.kamailio.org/wiki/
532
+    https://www.kamailio.org/wiki/
526 533
 
527 534
   If you don't use an rpm or debian based distribution, try our tar.gz'ed
528 535
   binaries
529
-    http://www.kamailio.org/pub/kamailio/latest/src/
536
+    https://www.kamailio.org/pub/kamailio/latest/src/
530 537
 
531 538
   If you use Solaris 8 you can try our solaris package.
532 539
   If you use Gentoo Linux you do not have to download a package.
... ...
@@ -537,15 +544,13 @@ C) Quick Start
537 544
 	debian:
538 545
     		dpkg -i <package_name>
539 546
 	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)
547
+		emerge kamailio
548
+		(or if use only stable packets: 
549
+		ACCEPT_KEYWORDS="~x86" emerge kamailio )
545 550
 	tar.gz:
546 551
     		cd /; tar zxvf <package_name>_os_arch.tar.gz
547 552
     		(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)
553
+		/usr/local/etc/kamailio/kamailio.cfg)
549 554
 	Solaris:
550 555
     		gunzip <package_name>.gz ; pkgadd -d <package_name>
551 556
 	*BSD:
... ...
@@ -562,8 +567,7 @@ C) Quick Start
562 567
 	Solaris:
563 568
     		the tar.gz does not include an init.d script, you'll have to create one of
564 569
     		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.)
570
+    		pkg/kamailio/rpm/kamailio.init, pkg/kamailio/deb/debian/kamailio.init, a.s.o.)
567 571
     		You can start Kamailio directly with
568 572
 			/usr/local/sbin/kamailio.
569 573
     
... ...
@@ -574,7 +578,7 @@ C) Quick Start
574 578
         export SIP_DOMAIN="myserver.foobar.com"
575 579
 	- if you are using other than 'localhost' mysql server for maintaining
576 580
 	  subscriber database, change the variable 'SQL_HOST' to the proper
577
-	  host name in the serctl script
581
+	  host name in the kamctl script
578 582
     - run the kamctl utility
579 583
         /usr/sbin/kamctl moni
580 584
       or
... ...
@@ -608,9 +612,9 @@ D) Kamailio With Persistent Data Storage
608 612
 
609 613
    set-variable    = max_connections=500
610 614
 
611
-  1) Download the package containin mysql support for Kamailio from the links
615
+  1) Download the package containing mysql support for Kamailio from the links
612 616
      you find on: 
613
-        http://www.kamailio.org/wiki/
617
+        https://www.kamailio.org/wiki/
614 618
 
615 619
     (rpm and deb provided, most of the binary tar.gz distributions and the 
616 620
      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 638
 	- otherwise, if this is your very first installation, use
635 639
     	/usr/local/sbin/kamdbctl create
636 640
 	  to create Kamailio database structures
637
-   (you will be prompted for password of MySql "root" user)
641
+     (you will be prompted for password of MySql "root" user)
638 642
 
639 643
   4) configure Kamailio to use SQL
640 644
     uncomment all lines in configuration file kamailio.cfg which are related to authentication:
... ...
@@ -644,33 +648,33 @@ D) Kamailio With Persistent Data Storage
644 648
     - modparam("usrloc", "db_mode", 2)
645 649
     - modparam("auth", "calculate_ha1", yes)
646 650
     - modparam("auth_db", "password_column", "password")
647
-    - if (!www_authorize("sip-router.org", "subscriber")) {
648
-        www_challenge("sip-router.org", "0"); 
651
+    - if (!www_authorize("example.com", "subscriber")) {
652
+        www_challenge("example.com", "0"); 
649 653
         break;
650 654
       }
651 655
 
652 656
   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
-      }
657
+     with name of your server; some broken UAC implementations don't 
658
+     authenticate otherwise; the authentication command in your
659
+     configuration script should look then like this:
660
+        if (!www_authorize("myserver.foobar.com", "subscriber")) {
661
+            www_challenge("myserver.foobar.com", "0"); 
662
+            break;
663
+        }
660 664
 
661 665
   6) restart the server
662 666
 
663
-    /etc/init.d/kamailio restart
667
+      /etc/init.d/kamailio restart
664 668
 
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"
669
+  7) you can now start managing the server using the kamctl utility; 
670
+     you need to first set the environment variable SIP_DOMAIN to your 
671
+     local SIP realm, e.g.,
672
+       export SIP_DOMAIN="myserver.example.com"
669 673
 
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
+   	a) watch the server status using 'kamctl moni'
675
+   	b) try to login with your SIP client as user 'admin' with password 'heslo'
676
+   	c) try adding new users using 
677
+       		'kamctl add <username> <password>'
674 678
 
675 679
 
676 680
 4. Troubleshooting
... ...
@@ -699,4 +703,4 @@ A: Use bug tracker at: https://github.com/kamailio/kamailio/issues
699 703
 
700 704
 Q: Any F.A.Q. that could be helpful to check before reporting an issue?
701 705
 
702
-A: See: http://www.kamailio.org/wiki/tutorials/faq/main
706
+A: See: https://www.kamailio.org/wiki/tutorials/faq/main
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