======= Install And Maintain Kamailio v4.4.x From GIT =======

<code>
Main author:
   Daniel-Constantin Mierla

Support: <sr-users@lists.sip-router.org>
</code>

This is a step by step tutorial about how to install and maintain Kamailio SIP Server version 4.4.x using the sources downloaded from GIT repository - the choice for those willing to write code for Kamailio or to try the new features to be released in the future with the next major stable version.

<color blue>//This document focuses on Kamailio v4.3.x with MySQL support, using a Debian unstable system.//</color>

The first version in release series 4.4 is 4.4.0, 4.4.x refers to the most recent version released at some point in time that starts with 4.4.

Note that Kamailio provides APT repositories for several Debian/Ubuntu releases, you can use them to do the install from .deb packages, see:

  * http://www.kamailio.org/wiki/packages/debs

==== Notes on Kamailio vs SER ====

Since version 4.0.0, Kamailio and SER integration was fully completed, there are no more duplicated modules and a single database schema. Default flavour is **kamailio**, setting this name to the application and database. SER flavour can be compiled using **make** command line options (practically, flavour system is now just about naming the application and related components).

===== 1. Prerequisites =====

To be able to follow the guidelines from this document you need **root** access.

The following packages are required before proceeding to the next steps.

  * __git__ client: apt-get install git - it is recommended to have a recent version, if your Linux distro has an old version, you can download newer one from: http://git-scm.com/
  * __gcc__ compiler: apt-get install gcc
  * __flex__ - apt-get install flex
  * __bison__ - apt-get install bison
  * __libmysqlclient-dev__ - apt-get install libmysqlclient-dev
  * __make__ - apt-get install make
  * if you want to enable more modules, some of them require extra libraries:
    * __libssl__ - apt-get install libssl-dev
    * __libcurl__ - apt-get install libcurl4-openssl-dev
    * __libxml2__ - apt-get install libxml2-dev
    * __libpcre3__ - apt-get install libpcre3-dev

**Important Note**: starting with version 4.3.0, Kamailio uses the directory **/var/run/kamailio/** for creating FIFO and UnixSocket control files. You have to complete the section related to installation of init.d script for creating /var/run/kamailio even if you plan to start Kamailio manually from command line. The alternative is to set different paths via parameters of **mi_fifo** and **ctl** modules.

===== 2. Getting sources from GIT =====

First of all, you have to create a directory on the file system where the sources will be stored. 

<code>
  mkdir -p /usr/local/src/kamailio-4.4
  cd /usr/local/src/kamailio-4.4
</code>

Download the sources from GIT using the following commands.

<code>
  git clone --depth 1 --no-single-branch https://github.com/kamailio/kamailio kamailio
  cd kamailio
  git checkout -b 4.4 origin/4.4
</code>

//Note: if your git client version does not support **--no-single-branch** command line parameter, then just remove it.//

===== 3.Tuning Makefiles =====

The first step is to generate build config files.

<code>
  make cfg
</code>

Next step is to enable the MySQL module. Edit **modules.lst** file:

<code>
  nano -w modules.lst
</code>

Add **db_mysql** to the variable **include_modules**.

<code>
include_modules= db_mysql
</code>

Save the **modules.lst** and exit.

NOTE: this is one mechanism to enable modules which are not compiled by default, such as lcr, dialplan, presence -- add the modules to **include_modules** variable inside the **modules.lst** file.

Alternative is to set 'include_modules' variable to specify what extra modules to be included for compilation when building Makefile cfg:

<code>
make include_modules="db_mysql dialplan" cfg
</code>

**NOTE**: If you want to install everything in one directory (so you can delete all installed files at once), say /usr/local/kamailio-4.4, then set PREFIX variable to the install path in 'make cfg ...' command:

<code>
make PREFIX="/usr/local/kamailio-4.4" include_modules="db_mysql dialplan" cfg
</code>


More hints about Makefile system at: 
  * https://www.kamailio.org/wiki/devel/makefile-system

**NOTE**: Previous release series 3.x.x used FLAVOUR mechanism to set the name of the application to **kamailio**. Starting with 4.0.0, the default is **kamailio**. From that version, if you want to build **ser** flavour, use **FLAVOUR=ser** in the make command to generate the build configs.

===== 4. Compile Kamailio =====

Once you added the mysql module to the list of enabled modules, you can compile Kamailio:

<code>
  make all
</code>

You can get full compile flags output using:

<code>
  make Q=0 all
</code>

===== 5. Install Kamailio =====

When the compilation is ready, install Kamailio with the following command:

<code>
  make install
</code>

===== 6. What and where was installed =====

The binaries and executable scripts were installed in:

<code>
  /usr/local/sbin
</code>


These are:

  * __kamailio__ - Kamailio SIP server
  * __kamdbctl__ - script to create and manage the Databases
  * __kamctl__ - script to manage and control Kamailio SIP server
  * __kamcmd__ - CLI - command line tool to interface with Kamailio SIP server

To be able to use the binaries from command line, make sure that '/usr/local/sbin' is set in PATH environment variable. You can check that with 'echo $PATH'. If not and you are using 'bash', open '/root/.bash_profile' and at the end add:

<code>
  PATH=$PATH:/usr/local/sbin
  export PATH
</code>

Kamailio (OpenSER) modules are installed in:

<code>
  /usr/local/lib/kamailio/modules/
</code>
Note: On 64 bit systems, /usr/local/lib64 may be used.

The documentation and readme files are installed in:

<code>
  /usr/local/share/doc/kamailio/
</code>

The man pages are installed in:

<code>
  /usr/local/share/man/man5/
  /usr/local/share/man/man8/
</code>

The configuration file was installed in:

<code>
  /usr/local/etc/kamailio/kamailio.cfg
</code>

**NOTE**; In case you set the **PREFIX** variable in 'make cfg ...' command, then replace **/usr/local** in all paths above with the value of PREFIX in order to locate the files installed.

===== 7. Create MySQL database =====

To create the MySQL database, you have to use the database setup script. First edit **kamctlrc** file to set the database server type:

<code>
  nano -w /usr/local/etc/kamailio/kamctlrc
</code>

Locate DBENGINE variable and set it to MYSQL:

<code>
DBENGINE=MYSQL
</code>

You can change other values in **kamctlrc** file, at least it is recommended to change the default passwords for the users to be created to connect to database.

Once you are done updating **kamctlrc** file, run the script to create the database used by Kamailio:

<code>
  /usr/local/sbin/kamdbctl create
</code>

You can call this script without any parameter to get some help for the usage. You will be asked for the domain name Kamailio is going to serve (e.g., mysipserver.com) and the password of the 'root' MySQL user. The script will create a database named 'kamailio' containing the tables required by Kamailio. You can change the default settings in the kamctlrc file mentioned above.

The script will add two users in MySQL:

- **kamailio** - (with default password 'kamailiorw') - user which has full access rights to 'kamailio' database

- **kamailioro** - (with default password 'kamailioro') - user which has read-only access rights to 'kamailio' database

**__Do change the passwords for these two users to something different that the default values that come with sources.__**

===== 8. Edit configuration file =====

To fit your requirements for the VoIP platform, you have to edit the configuration file.

<code>
  /usr/local/etc/kamailio/kamailio.cfg
</code>

Follow the instruction in the comments to enable usage of MySQL. Basically you have to add several lines at the top of config file, like:

<code>
#!define WITH_MYSQL
#!define WITH_AUTH
#!define WITH_USRLOCDB
</code>

If you changed the password for the 'kamailio' user of MySQL, you have to update the value for 'db_url' parameters.

You can browse [[https://github.com/kamailio/kamailio/blob/master/etc/kamailio.cfg|kamailio.cfg]] online on GIT repository.

===== 9. Startup scripts =====

==== 9.1. The init.d script ====

The init.d script can be used to start/stop the Kamailio server in a nicer way. A sample of init.d script for Kamailio is provided at:

<code>
/usr/local/src/kamailio-4.4/kamailio/pkg/kamailio/deb/debian/kamailio.init
</code>

Just copy the init file into the /etc/init.d/kamailio. Then change the permissions:

<code>
  cp /usr/local/src/kamailio-4.4/kamailio/pkg/kamailio/deb/debian/kamailio.init /etc/init.d/kamailio
  chmod 755 /etc/init.d/kamailio 
</code>

then edit the file updating the $DAEMON and $CFGFILE values:

<code>
  DAEMON=/usr/local/sbin/kamailio
  CFGFILE=/usr/local/etc/kamailio/kamailio.cfg
</code>

You need also setup a configuration file in the /etc/default/ directory. This file can be found at:

<code>
  /usr/local/src/kamailio-4.4/kamailio/pkg/kamailio/deb/debian/kamailio.default
</code>

You need to rename the file to 'kamailio' after you've copied it. Then edit this file and set RUN_KAMAILIO=yes. Edit the other options at your convenience.

Create the directory for pid file:

<code>
mkdir -p /var/run/kamailio
</code>

Default setting is to run Kamailio as user "kamailio" and group "kamailio". For that you need to create the user:

<code>
adduser --quiet --system --group --disabled-password \
        --shell /bin/false --gecos "Kamailio" \
        --home /var/run/kamailio kamailio

# set ownership to /var/run/kamailio
chown kamailio:kamailio /var/run/kamailio
</code>

Then you can start/stop Kamailio using the following commands:

<code>
  /etc/init.d/kamailio start
  /etc/init.d/kamailio stop
</code>

==== 9.1 The systemd script ====

TBA

===== 10. Ready to rock =====

Now everything is in place. You can start the VoIP service, creating new accounts and setting the phones.

A new account can be added using 'kamctl' tool via 'kamctl add <username> <password> <email>'. (email is optional)

  kamctl add test testpasswd

If you are asked for SIP_DOMAIN environment variable do one of the following option.

<code>
  1.
  export SIP_DOMAIN=mysipserver.com

  2.
  edit '/usr/local/etc/kamailio/kamctlrc' (or per user file, like '/root/.kamctlrc') and add:
  SIP_DOMAIN=mysipserver.com
</code>

===== 11. Maintenance =====

The maintenance process is very simple right now. You have to be user 'root' and execute following commands:

<code>
  cd /usr/local/src/kamailio-4.4/kamailio
  git pull origin
  make all
  make install
  /etc/init.d/kamailio restart
</code>

Now you have the latest Kamailio devel running on your system.


===== 12. Time for maintenance service =====

Notification about GIT commits are sent to the mailing list: **sr-dev@lists.sip-router.org**. Each commit notification contains the reference to the branch where the commit has been done. If the commit message contains the lines:

<code>
Module: kamailio
Branch: 4.4
</code>

then an update has been made to Kamailio devel version and it will be available to the public GIT in no time.