docs Add reference to the jansson library
[sip-router] / INSTALL
1
2      ==================================================
3
4           Kamailio SIP Server Installation Notes
5
6                  http://www.kamailio.org
7
8      ==================================================
9
10   Welcome! This is an amazingly flexible, robust and secure SIP server
11   built on years of experience in several Open Source projects. It's a merge
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.
15
16   This memo gives you hints on how to set up the SIP server quickly.
17   
18   You can find a similar tutorial and many more on project's web site:
19     - http://www.kamailio.org/w/documentation/
20     - http://www.kamailio.org/wiki/
21   
22
23 Table of Contents
24 =================
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
31      A) Set SIP Server Flavour
32      B) Build Commands
33 4. Quick-Start Installation Guide
34    A) Getting Help
35    B) Disclaimers
36    C) Quick Atart
37    D) SIP Server With Persistent Data Storage
38 5. Troubleshooting
39
40
41
42 1. SIP Server Flavours
43 ----------------------
44
45 The two major SIP server flavours are:
46   - SIP Express Router (aka SER, the initial project name, started in 2001)
47   - Kamailio (former OpenSER)
48
49 Starting with version 3.0.0, the two SIP server flavours are built from
50 same source code tree. In version 4.0.0 the two source code trees were
51 merged even more, so a combined module directory is now used.
52
53 Kamailio flavour is the one built by default. SER is, historically speaking, the
54 first open source SIP server started in 2001. Kamailio forked from SER in
55 2005 under the initial name OpenSER.
56
57 Starting with version 3.1.0 the differences between the two flavours are
58 very few, Kamailio enabling next compile time flags:
59   - internal statistics
60   - application server extensions in tm module
61
62 In version 4.0.0 the modules were merged into one set and the merger
63 between the two products was completed.
64
65 Kamailio is now the default flavour. Switching between flavours is a matter
66 of 'make' command parameters.
67
68 Several installation tutorials for Kamailio are available on the web wiki:
69   - http://www.kamailio.org/wiki/
70
71
72 2. Supported Architectures And Requirements
73 -------------------------------------------
74
75 Supported operating systems:
76  - Linux (Debian, Ubuntu, Fedora, RedHat, CentOS, OpenSUSE, Gentoo, a.s.o.)
77  - FreeBSD, NetBSD, OpenBSD, Dragonfly BSD
78  - Solaris
79  - OS/X, Darwin
80
81 Partially supported
82  - Windows+Cygwin (core + static modules only, no IPv6, no
83    TCP, no dynamic modules)
84
85 Supported architectures
86  - i386, x86_64 (amd64), armv4l, sparc64, powerpc, powerpc64
87
88 Experimental architectures:
89  - mips1, mips2, sparc32, alpha
90
91 (for other architectures the Makefiles might need to be edited)
92
93 There are various configuration options defined in the Makefile.
94
95
96 Requirements:
97
98 - gcc or icc : gcc >= 2.9x; 3.[12] recommended (it will work with older version
99   but it might require some options tweaking for best performance)
100 - bison or yacc (Berkley Yacc)
101 - flex
102 - GNU make (on Linux this is the standard "make", on *BSD and Solaris it is
103   called "gmake") version >= 3.80 (recommended 3.81).
104 - sed and tr (used in the makefiles)
105 - GNU tar ("gtar" on Solaris) and gzip if you want "make tar" to work
106 - GNU install, BSD install or Solaris install if you want "make
107   install", "make bin", "make sunpkg" to work
108 - libmysqlclient & libz (zlib) if you want MySQL support (the db_mysql module)
109 - libxml2 if you want to compile the cpl-c (CPL support) or pa (presence) 
110    modules
111 - libradiusclient-ng (> 5.0) if you need RADIUS support (the auth_radius,
112   group_radius, uri_radius and avp_radius modules)
113 - libpq if you need PostgreSQL support (the db_postgres module)
114 - libexpat if you want the jabber gateway support (the jabber module) or the
115   XMPP gateway support
116 - libxml2 if you want to use the cpl-c (Call Processing Language) or
117   the presence modules (presence and pua*)
118 - libradius-ng -libs and devel headers- if you want to use functionalities
119   with radius support - authentication, accounting, group support, etc
120 - unixodbc - libs and devel headers - if you want UNIXODBC support as
121   DB underlayer
122 - libxmlrpc-c3 - libs and devel headers - if you want to have XML-RPC support
123   for the management interface (MI)
124 - libperl - libs and devel headers - if you want the perl connector to support
125   perl scripting from your config file (perl module)
126 - libsnmp9 - libs and devel headers - if you want SNMP client functionality 
127   (SNMP AgentX subagent) for Kamailio
128 - libldap libs and devel headers v2.1 or greater - if you want LDAP support
129 - libpcre libs and devel headers - if you want to compile the lcr and dialplan
130   modules
131 - libsctp devel headers - if you want to compile the SCTP transport in the core
132 - libssl devel headers (openssl project) - if you want to compile the TLS module
133 - libunistring - for the WebSocket module
134 - python and devel headers for the Python module
135 - jdk and gcj for Java module
136 - the jansson library for the jansson module used for JSON document handling
137
138
139 OS Notes:
140
141  FreeBSD/OpenBSD/NetBSD: make sure gmake, bison or yacc & flex are installed.
142   
143   FreeBSD 5.4:
144   ------------
145   If you want to compile all the modules, you will need the following packages:
146   - mysql-client-* (any version, install one of the mysql*-client ports) for
147     libmysqlclient
148   - postgresql-libpqxx-2.4.2_1 (/usr/ports/databases/postgresql-libpqxx) for
149     libpq
150   - expat-1.95.8 (/usr/ports/textproc/expat2) for libexpat
151   - libxml2-2.6.18 (/usr/ports/textproc/libxml2) for libxml2
152   - radiusclient-0.4.7 (/usr/ports/net/radiusclient) for libradiusclient-ng 
153   NOTE: you'll need to add radiusclient_ng=4 to the gmake command line if you
154   use the 0.4.* version.
155   
156   Compile example (all the modules and SIP server core in a tar.gz):
157      gmake bin radiusclient_ng=4 include_modules="mysql jabber cpl-c auth_radius group_radius uri_radius postgres pa"
158
159   OpenBSD 3.7
160   -----------
161   - mysql-client-4.0.23 (/usr/ports/databases/mysql) for libmysqlclient
162   - expat-1.95.6 (/usr/ports/textproc/expat) for libexpat
163   - libxml-2.6.16p0 (/usr/ports/textproc/libxml) for libxml2
164   - radiusclient-ng-0.5.1 from 
165    http://download.berlios.de/radiusclient-ng/radiusclient-ng-0.5.1.tar.gz
166    (you need to download and install it, since there is no "official" 
167    openbsd port for it) for libradiusclient-ng 
168
169   Compile example (all the modules and SIP server core in a tar.gz):
170      gmake bin include_modules="mysql jabber cpl-c auth_radius group_radius uri_radius pa"
171
172   NetBSD 2.0
173   ----------
174   - mysql-client-4.1.12 (/usr/pkgsrc/databases/mysql4-client) for libmysqlclient
175   - expat-1.95.8nb2 (/usr/pkgsrc/textproc/expat) for libexpat
176   - libxml2-2.6.19 (/usr/pkgsrc/textproc/libxml2) for libxml2
177   - radiusclient-ng-0.5.1 (see OpenBSD)
178   
179   Compile example (all the modules and SIP server in a tar.gz):
180      gmake bin include_modules="mysql jabber cpl-c auth_radius group_radius uri_radius pa"
181
182   Solaris 10
183   ----------
184   As above; you can use Solaris's yacc instead of bison. You might also
185   need gtar and ginstall. If you don't have ginstall you can use Solaris
186   install, just make sure it's in the PATH (it's usually in /usr/sbin) and
187   add INSTALL=install either to the environment or to the make command line
188   (e.g.: gmake INSTALL=install all).
189   
190   Needed packages:
191   [TODO]
192   
193   Compile example (all the modules and SIP server in a tar.gz):
194      gmake bin INSTALL=install include_modules="mysql jabber cpl-c auth_radius group_radius uri_radius postgres pa"
195
196   Linux
197   -----
198   Needed packages for compiling all the modules:
199   * Debian:
200       - libmysqlclient-dev for libmysqlclient
201       - libpq-dev for libpq
202       - libexpat1-dev for libexpat
203       - libxml2-dev for libxml2
204       - libradiusclient-ng-dev for libradiusclient
205           - other libraries are needed for some other modules,
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:
209           - http://kamailio.org
210
211  Cygwin  (alpha state, partial support)
212  --------------------------------------
213  make sure make, bison, flex, minires and minires-devel (needed for the
214  resolver functions) are installed.
215  
216  Only building SIP server's core and some static modules is supported for now.
217  Stuff known not to work:
218            - IPv6 (cygwin doesn't support it yet)
219            - TCP (the tcp code heavily depends on file descriptor passing 
220              between processes, which is not yet supported by cygwin)
221            - dynamic modules (non statically linked -- not supported because
222              backlinking doesn't work in windows by design)
223
224
225   Compile example (all the modules and SIP server in a tar.gz):
226      make bin include_modules="mysql jabber cpl-c auth_radius group_radius uri_radius postgres pa"
227
228
229 3. Howto Build SIP Server From Source Code 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 the required dependencies, 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 .......................................
257
258
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
276   utilties, and scripts/examples.  When you build, you can decide to build
277   only the core, the modules, both, or all.
278
279 * Compile SIP server core only:
280         make
281
282 Compile modules except some explicitly excepted (see below)
283         make modules  - all modules in the modules/ directory 
284         make modules-all or make every-module  - all the modules 
285
286 * Compile all:
287         make all
288
289 * Explicitly excepted modules:
290   By default make all will not build modules that require external libraries or
291   that are considered to be "experimental". For example, modules that have external
292   dependencies are: db_mysql, jabber, cpl-c, auth_radius, group_radius, uri_radius,
293   avp_radius, db_postgres, db_berkely, carrierroute, ...
294
295 Including groups of modules:
296   Instead of compiling the default modules only, you can specify groups of
297   modules to include, according to their status:
298   - standard - Modules in this group are considered a standard part of SIP server
299     (due to widespread usage) but they have no dependencies (note that some of
300     these interplay with external systems. However, they don't have compile
301     or link dependencies).
302
303   - db - Modules in this group use databases and need a database driver to run.
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
306     postgres groups.
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
310     for compilation.
311     NOTE! All presence modules (dialog, pa, presence_b2b, rls, xcap) have been
312         included in this group due to interdependencies
313
314   - stable - Modules in this group satisfy specific or niche applications,
315     and are considered stable for production use. They may or may not have dependencies
316
317   - experimental - Modules in this group are either not complete, untested, or
318     without enough reports of usage to allow the module into the stable group.
319         They may or may not have dependencies.
320
321 There is another set of groups mainly used by Kamailio flavour, where modules
322 are grouped based on Debian packaging rules. For example:
323    - kstandard - Kamailio flavour's standard modules
324
325    - kpresence - Kamailio flavour's SIMPLE presence server modules
326
327 * To compile core with standard modules:
328         make group_include="standard" all
329
330 * To compile all modules (provided you have all the required libraries installed) use:
331         make group_include="standard standard-dep stable experimental" all
332
333   There are also in addition some "convenience" groups:
334
335         mysql           - Include all the db modules dependent and the MySQL db driver
336         postgres        - Include all the db modules and the PostgreSQL db driver
337         radius          - Include all modules on radiusclient
338         presence        - Include all the presence modules
339
340   Ex. to make a standard installation with MySQL, use:
341         make group_include="standard mysql" all
342
343   In addition to group_include (or instead), you can use 
344         include_modules="modA modB"
345   to specify exactly the modules you want to include, ex.
346         make include_modules="mymodule" modules
347
348   You can also explicitly skip modules using skip_modules. Let's say you want all
349   the standard and standard-dep modules except domain:
350         make group_include="standard standard-dep" skip_modules="domain" all
351
352   NOTE!!! As this mechanism is very powerful, you may be uncertain which
353   modules that will be included. Just replace all (or modules) with print-modules
354   and you will see which modules will be included and excluded, ex:
355         make print-modules
356   will show which modules are excluded by default.
357
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
360   "install" or "bin".
361
362
363 * More compile examples:
364
365   - compile with profiling
366         make PROFILE=-pg all
367   - compile debug mode version
368         make mode=debug all
369   - compile debug version with profiling
370         make mode=debug PROFILE=-pg all
371   - compile only the print module
372         make modules=modules/print modules
373   - compile by default only the print module, in debuging mode and with 
374     profiling:
375         make cfg modules=modules/print mode=debug PROFILE=-pg
376         make all
377   - change & save the  modules list without rebuilding the whole config
378     (so that already compiled modules won't be re-compiled by 
379     make all/make modules):
380         make modules-cfg include_modules="mysql postgress"
381   - change only the compile/build options, without changing the modules list:
382         make cfg-defs CPU=ultrasparc PROFILE=-pg
383   - compile by default all the usual modules + mysql and postgres, optimized 
384      for pentium-m and for space (saves both the build options and the module 
385      list)
386         make cfg include_modules="mysql postgres" CPU=pentium-m CC_EXTRA_OPTS=-Os
387         make all
388    - compile all the "default" modules except textops and vm
389         make skip_modules="textops vm" modules
390    - save the above option in the make config, so that all make commands
391      will use it by default:
392         make cfg skip_modules="textops vm"
393    - compile all default modules and include uri_radius (not compiled by default):
394         make include_modules="uri_radius" modules
395    - compile all the modules from the modules subdirectory (even the one excluded
396      by default):
397         make exclude_modules="" modules
398    - compile all the modules from the modules subdirectory excluding vm:
399         make exclude_modules=vm modules
400      or
401         make exclude_modules="" skip_modules=vm modules
402    - compile with the "tm" module statically linked and with profiling
403         make static_modules=tm PROFILE=-pg all
404    - compile with gcc-3.2 instead of gcc
405         make CC=gcc-3.2 all
406      or
407         CC=gcc-3.2 make all
408
409 Make targets:
410 =============
411
412 Make Local Build Config:
413 ------------------------
414
415   * make cfg or make config - force config and module list regeneration
416   
417
418   Example: 
419         make cfg include_modules=mysql mode=debug
420
421   All future make invocations will include the mysql module and will build in debug mode
422
423   Note: If config.mak doesn't exist (e.g. initial checkout or after a make 
424   proper) or if Makefile.defs was changed, the config will be re-generated
425   automatically by the first make command. For example:
426         make cfg  include_modules=db_mysql; make all
427   is equivalent to 
428         rm config.mak modules.lst; make include_modules=db_mysql.
429
430   * make cfg-defs  (force config regeneration, but don't touch the module list)
431
432   Example:
433         make cfg-defs CPU=ultrasparc CC_EXTRA_OPTS=-Os PROFILE=-pg
434
435         make modules-cfg
436   or
437         make modules-list
438   saves the module list, without regenerating the build config
439   Example:
440         make modules-list include_modules="tls" skip_modules="print"
441
442 Clean:
443 ------
444
445   * make clean          - clean the base and modules too
446   * make proper         - clean also the dependencies and the config, but not the module list
447   * make distclean      - the same as proper
448   * make maintainer-clean - clean everything, including make's config, saved 
449                           module list, auto generated files, tags, *.dbg a.s.o
450   * make clean-all      - clean all the modules in modules/*
451   * make proper-all     - like make proper but for all the  modules in modules/*
452
453   Config clean:
454
455   * make clean-cfg (cleans the compile config)
456   * make clean-modules-cfg (cleans the modules list)
457
458   Reduced" clean:
459
460   * make local-clean    - cleans only the core, no libs, utils or modules
461   * make clean-modules  - like make clean, but cleans only the modules
462   * make clean-libs     - like make clean, but cleans only the libs
463   * make clean-utils    - like make clean, but cleans only the utils
464   * make proper-modules - like make proper, but only for modules
465   * make proper-libs    - like make proper, but only for libs
466   * make proper-utils   - like make proper, but only for utils
467
468 Compile:
469 --------
470   * make proper
471   optional: make cfg  <various cfg. options that should be saved>
472   * make
473   or gmake on non-Linux systems
474   * make modules 
475   or make modules exclude_modules="CVS print" etc.
476
477 Other Make Targets:
478 -------------------
479   Make tags:
480         make TAGS
481
482   Create a tar.gz with the sources (in ../):
483         make tar
484
485   Create a tar.gz with the binary distribution (in ../):
486         make bin
487
488   Create a gzipped solaris package (in ../):
489         make sunpkg
490
491   Create debian packages (in ../):
492         make deb
493
494   or
495         dpkg-buildpackage
496
497 Documentation:
498 --------------
499
500   Regenerate the README for all the "default" modules (include_modules,
501   skip_modules a.s.o can be used to alter the module list).
502         make README
503
504   Generates a manpage for all the modules that support it (.xml file in the
505   module directory).
506         make man
507
508   Generates README file for modules/foo.
509         make modules=modules/foo modules-readme
510
511 Install:
512 --------
513
514         make prefix=/usr/local  install
515
516   Note: If you use prefix parameter in make install then you also need
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
519   configuration file in a wrong directory, because the directory of the
520   default configuration file is hardcoded into SIP server during compile time. 
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 
523   installed by make install will not match. (You can specify exact location
524   of the configuration file using -f parameter of SIP server).
525
526   For example, if you do the following:
527         make all
528         make prefix=/ install
529
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).
535
536   The workaround is trivial, use the same parameters in all make commands:
537         make prefix=/ all
538         make prefix=/ install
539   or save the desired prefix in the make config (e.g.: make cfg prefix=/).
540
541   That applies to other make parameters as well (for example parameters
542   "modules" or "excluded_modules").
543
544
545 4. Quick-Start Installation Guide
546 ---------------------------------
547
548 A) Getting Help
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.
554
555   If the documentation does not resolve your problem you may try contacting 
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,
558   please subscribe at the following web address:
559
560   http://lists.sip-router.org/cgi-bin/mailman/listinfo
561
562 B) Disclaimers
563  
564   Note well the default "quick-start" configuration is very simple in order 
565   to be easily installable. It provides minimum features. Particularly, 
566   authentication is by default disabled, which means anyone can register using
567   any name with the server. (This is on purpose to avoid installation 
568   dependencies on a database, which is needed for storing user credentials.)
569
570 C) Quick Start
571
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
574   authentication, then you have to install additional database support --
575   proceed to section D) after you are finished with C).
576
577   1) Download an RPM or Debian package from the links on the wiki
578
579     http://www.kamailio.org/wiki/
580
581   If you don't use an rpm or debian based distribution, try our tar.gz'ed
582   binaries
583     http://www.kamailio.org/pub/kamailio/latest/src/
584
585   If you use Solaris 8 you can try our solaris package.
586   If you use Gentoo Linux you do not have to download a package.
587
588   2) Install the package
589         RPM:
590                 rpm -i <package_name>
591         debian:
592                 dpkg -i <package_name>
593         gentoo:
594                 emerge ser
595                           or
596                         emerge kamailio
597                 (or if use only stable packets: ACCEPT_KEYWORDS="~x86" emerge ser
598                 or ACCEPT_KEYWORDS="~x86" emerge kamailio)
599         tar.gz:
600                 cd /; tar zxvf <package_name>_os_arch.tar.gz
601                 (it will install in /usr/local/, and the configuration file in
602                 /usr/local/etc/ser/ser.cfg or /usr/local/etc/kamailio/kamailio.cfg)
603         Solaris:
604                 gunzip <package_name>.gz ; pkgadd -d <package_name>
605         *BSD:
606                 pkg_add package_name
607     
608   3) Start the server
609
610         RPM + gentoo:
611                 /etc/init.d/ser start
612                           or
613                 /etc/init.d/kamailio start
614         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')
618         tar.gz:
619         Solaris:
620                 the tar.gz does not include an init.d script, you'll have to create one of
621                 your own or adapt one from the source distribution (pkg/debian/init.d,
622                 pkg/rpm/ser.init.*, pkg/gentoo/ser.init, pkg/kamailio/rpm/kamailio.init,
623                         pkg/kamailio/deb/debian/kamailio.init, a.s.o.)
624                 You can start SIP server directly with /usr/local/sbin/ser or
625                         /usr/local/sbin/kamailio.
626     
627   4) Optionally, watch server's health using the
628         serctl or kamctl utility
629
630     - to do so, first set the environment variable SIP_DOMAIN to your domain 
631       name, e.g., in Bourne shell, call
632         export SIP_DOMAIN="myserver.foobar.com"
633         - if you are using other than 'localhost' mysql server for maintaining
634           subscriber database, change the variable 'SQL_HOST' to the proper
635           host name in the serctl script
636     - run the serctl utility
637         /usr/sbin/serctl moni
638       or
639         /usr/sbin/kamctl moni
640       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
645                 tar.gz or solaris package)
646
647   5) Connect SIP phones
648
649   Register with the server using your favorite SIP User Agent (phone). 
650
651   In most cases, you need to set the following options:
652
653         Proxy server:   host name of your server
654         Domain:         the sip domain your server is configured to handle
655         User name:      the account name for your device
656         Auth user:      the ID used for authentication
657         Secret/Password:        The configured authentication password
658
659 D) SIP Server With Persistent Data Storage
660 ------------------------------------------
661
662   The default configuration is very simple and features many simplifications. 
663   In particular, it does not authenticate users and loses User Location database 
664   on reboot. To provide persistence, keep user credentials and remember users' 
665   locations across reboots, Kamailio can be configured to use a database, like MySQL. 
666
667   Before you proceed, you need to make sure MySQL is installed on your box. Your
668   MySQL server must be configured to deal with a large number of
669   connection. To increase it, set the following line in [mysqld] section
670   of your my.ini configuration file:
671
672    set-variable    = max_connections=500
673
674   1) Download the package containing mysql support for SIP server from the links
675      you find on: 
676         http://www.kamailio.org/wiki/
677
678     (rpm and deb provided, most of the binary tar.gz distributions and the 
679      solaris package include it; if it is not present you'll have to rebuild
680      from the source).
681         For gentoo please include 'mysql' to your USE variable in /etc/make.conf
682         or give it as variable to the emerge command.
683
684   2) install the package
685     rpm -i <package_name>
686     or
687     dpkg -i <package_name>
688         or
689         emerge ser
690         or
691         emerge kamailio
692         (if do not want to put 'mysql' into your USE variable you can type:
693          USE="mysql" emerge ser)
694
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
705         - if you have a previously installed Kamailio on your system, use
706         /usr/local/sbin/kamdbctl reinstall 
707           to convert your Kamailio database into new structures
708         - otherwise, if this is your very first installation, use
709         /usr/local/sbin/kamdbctl create
710           to create Kamailio database structures
711    (you will be prompted for password of MySql "root" user)
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:
716     - loadmodule "db_mysql.so"
717     - loadmodule "auth.so"
718     - loadmodule "auth_db.so"
719     - modparam("usrloc", "db_mode", 2)
720     - modparam("auth", "calculate_ha1", yes)
721     - modparam("auth_db", "password_column", "password")
722     - if (!www_authorize("sip-router.org", "subscriber")) {
723         www_challenge("sip-router.org", "0"); 
724         break;
725       }
726
727   5) be sure to replace realm, the first parameter in www_* actions, 
728    with name of your server; some broken UAC implementations don't 
729    authenticate otherwise; the authentication command in your
730    configuration script should look then like this:
731       if (!www_authorize("myserver.foobar.com", "subscriber")) {
732         www_challenge("myserver.foobar.com", "0"); 
733         break;
734       }
735
736   6) restart the server
737     /etc/init.d/ser restart
738           or
739     /etc/init.d/kamailio restart
740
741   7) you can now start  managing the server using the serctl or kamctl utility; 
742    you need to first set the environment variable SIP_DOMAIN to your 
743    local SIP realm, e.g.,
744        export SIP_DOMAIN="myserver.foobar.com"
745
746    a) watch the server status using 'serctl moni' or 'kamctl moni'
747    b) try to login with your SIP client as user 'admin' with password 'heslo'
748    c) try adding new users using 
749        'serctl add <name> <password> <email>'
750              or
751        'kamctl add <username> <password>'
752
753
754 4. Troubleshooting
755 ------------------
756
757 Q: SIP requests are replied by SIP server with "483 Too Many Hops" or 
758    "513 Message Too Large"
759
760 A: In both cases, the reason is probably an error in request routing script 
761    which caused an infinite loop. You can easily verify whether this happens 
762    by watching SIP traffic on loopback interface. A typical reason for
763    misrouting is a failure to match local domain correctly. If a server
764    fails to recognize a request for itself, it will try to forward it to
765    current URI in believe it would forward them to a foreign
766    domain. Alas, it forwards the request to itself again. This continues
767    to happen until value of max_forwards header field reaches zero or
768    the request grows too big. Solutions is easy: make sure that domain
769    matching is correctly configured. A quick way to achieve that is to
770    introduce a config option to ser.cfg or kamailio.cfg: alias=domainname,
771    where domainname shall be replaced with name of domain, which you wish to
772    server and which appears in request-URIs.
773
774 Q: Where to report issues?
775
776 A: Use bug tracker at: https://github.com/kamailio/kamailio/issues
777
778 Q: Any F.A.Q. that could be helpful to check before reporting an issue?
779
780 A: See: http://www.kamailio.org/wiki/tutorials/faq/main