The Kamailio SIP server is the main Open Source software program for building SIP services like a SIP proxy, SIP Presence Server, SIP location server and much more. Kamailio used to handle thousands of call setups per second. Kamailio is the choice for building enterprise as well as carrier solutions with a rich configuration language, popularity and continues development. Kamailio runs on UNIX and Linux systems, ranging from embedded systems to huge scale multi-core servers.
Pre-requites for Kamailio installation:
The following packages are required before proceeding to the next steps.
- git client: apt-get install git-core – it is recommended to have a recent version if your Linux distro has an old version.
- 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:
- 1. libssl – apt-get install libssl-dev
- 2. libcurl – apt-get install libcurl4-openssl- dev
- 3. libxml2 – apt-get install libxml2-dev
- 4. libpcre3 – apt-get install libpcre3-dev
Note: Kamailio (version 4.3.0) uses the directory /var/run/kamailio/ for creating FIFO and UnixSocket control files. You have to complete the section related to the 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.
Step1: First, Getting sources from GIT:
First of all, you have to create a directory on the file system where the sources will be stored.
1 2 |
mkdir -p /usr/local/src/kamailio-devel cd /usr/local/src/kamailio-devel |
you can Download the sources from GIT using the following commands.
1 2 3 |
git clone --depth 1 --no-single-branch git://git.kamailio.org/kamailio kamailio cd kamailio git checkout -b 4.4 origin/4.4 |
Step2. Tuning Make files
The first step is to generate build config files.
1 |
make cfg |
Next step is to enable the MySQL module. Edit modules.lst file:
1 |
nano -w modules.lst |
Add db_mysql to the variable include_modules.
1 |
include_modules= db_mysql |
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:
1 |
make include_modules="db_mysql dialplan" cfg |
NOTE: If you want to install everything in one directory (so you can delete all installed files at once), say /usr/local/kamailio-devel, then set PREFIX variable to the install path in ‘make cfg …’ command:
1 |
make PREFIX="/usr/local/kamailio-devel" include_modules="db_mysql dialplan" cfg |
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.
Step3. Compile Kamailio
Once you added the mysql module to the list of enabled modules, you can compile Kamailio:
1 |
make all |
You can get full compile flags output using:
1 |
make Q=0 all |
Step4. Install Kamailio
When the compilation is ready, install Kamailio with the following command:
1 |
make install |
Step5. Kamailio installation Path
The binaries and executable scripts were installed in:
1 |
/usr/local/sbin |
These are kamailio, kamdbctl, kamctl, kamcmd commond to manage SIP Server.
To be able to use the binaries from command line, make sure that ‘/usr/local/sbin’ is set in PATH environment variable.
1 2 |
PATH=$PATH:/usr/local/sbin export PATH |
Kamailio (OpenSER) modules are installed in:
1 |
/usr/local/lib/kamailio/modules/ |
Note: On 64 bit systems, /usr/local/lib64 may be used.
The documentation and readme files are installed in:
1 |
/usr/local/share/doc/kamailio/ |
The man pages are installed in:
1 2 |
/usr/local/share/man/man5/ /usr/local/share/man/man8/ |
The configuration file was installed in:
1 |
/usr/local/etc/kamailio/kamailio.cfg |
Step6. Create MySQL database
To create the MySQL database, first edit kamctlrc file to set the database server type:
1 |
nano -w /usr/local/etc/kamailio/kamctlrc |
Locate DBENGINE variable and set it to MYSQL:
1 |
DBENGINE=MYSQL |
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:
1 |
/usr/local/sbin/kamdbctl create |
Step7. Edit configuration file
To fit your requirements for the VoIP platform, you have to edit the configuration file.
1 |
/usr/local/etc/kamailio/kamailio.cfg |
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:
1 2 3 |
#!define WITH_MYSQL #!define WITH_AUTH #!define WITH_USRLOCDB |
Step8. 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:
1 |
/usr/local/src/kamailio-devel/kamailio/pkg/kamailio/deb/debian/kamailio.init |
Just copy the init file into the /etc/init.d/kamailio. Then change the permisions:
1 |
chmod 755 /etc/init.d/kamailio |
then edit the file updating the $DAEMON and $CFGFILE values:
1 2 |
DAEMON=/usr/local/sbin/kamailio CFGFILE=/usr/local/etc/kamailio/kamailio.cfg |
You need also setup a configuration file in the /etc/default/ directory. This file can be found at:
1 |
/usr/local/src/kamailio-devel/pkg/kamailio/debian/kamailio.default |
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:
1 |
mkdir -p /var/run/kamailio |
Default setting is to run Kamailio as user “kamailio” and group “kamailio”. For that you need to create the user:
1 2 3 4 5 6 |
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
|
Then you can start/stop Kamailio using the following commands:
1 2 |
/etc/init.d/kamailio start /etc/init.d/kamailio stop |
Step9. Ready to use
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 ‘. (or try without the email)
1 |
kamctl add test testpasswd test@mysipserver.com |
1 |
kamctl add test testpasswd test@mysipserver.com |
If you are asked for SIP_DOMAIN environment variable do one of the following option.
1 2 3 |
export SIP_DOMAIN=mysipserver.com edit '/root/.kamctlrc' and add: SIP_DOMAIN=mysipserver.com |
Step10. Maintenance
The maintenance process is very simple right now. You have to be user ‘root’ and execute following commands:
1 2 3 4 5 |
cd /usr/local/src/kamailio-devel/kamailio git pull origin make all make install /etc/init.d/kamailio restart |
Now you have the latest Kamailio devel running on your system.
Kamailio is the choice for building enterprise as well as carrier solutions with a rich configuration language, popularity and continues development. We at GVenture Technology will fulfil all your necessary requirements.
Recent Comments