This is a tutorial on how to setup Kamailio Open Source SIP server for use with uvgComm. Currently adding users is done manually, but other alternatives may exist. This tutorial uses PostgreSQL but other databases are also possible.
Install Kamailio and postgress module with following command:
apt-get install kamailio kamailio-postgres-modules postgresql postgresql-contrib kamailio-presence-modules kamailio-tls-modules
After Kamailio has been installed, we can start configuring its various aspects.
Kamailio uses control tools to ease operations such as adding or removing users. The Kamailio control tool configuration file is found at:
/etc/kamailio/kamctlrc
First, set SIP_DOMAIN to Kamailio host’s public IP address or domain name. This will be the server address used in uvgComm.
SIP_DOMAIN=10.0.0.2
Next, find and set DBENGINE to PGSQL (or any other alternative database if desired):
DBENGINE=PGSQL
Next we start creating the database that will hold the users details as well as their location information so they can be called from anywhere on the internet. Create a .pgpass file in /root folder (home folder of root) with postgres as the username and password:
*:*:*:postgres:postgres
and change the permissions with:
chmod 0600 ~/.pgpass
These credentials are used by kamailio when operating with postgreSQL database. For security reasons, you should NOT change the UNIX password of postgres user, because this unlocks it and makes logging with it possible.
Instead, set the postgres password within psql terminal front-end for Postgress:
sudo -u postgres psql postgres
# \password postgres
Now we create the Kamailio database in postgres with following command. Change the owner of the database to kamailio.
kamdbctl create
Just to be sure that everything went correctly, we check the existance of the database. Start psql:
sudo -u postgres psql
Inside with the front-end open, list databases, connect to kamailio database and list all tables:
psql> \list
psql> \c kamailio
psql> \dt
You should see the tables we just created that are used by Kamailio.
Next we configure the run-time behavior of Kamailio. The configuration file for modules and run-time behavior is found in:
/etc/kamailio/kamailio.cfg
Add the following lines to enable postgreSQL, user authentication and persistent REGISTER statuses after restart.
#!define WITH_PGSQL
#!define WITH_AUTH
#!define WITH_USRLOCDB
#!define WITH_TLS
Add database location to "Defined Values":
#!ifdef WITH_PGSQL
#!ifndef DBURL
#!define DBURL "postgres://postgres:postgres@localhost/kamailio"
#!endif
#!endif
Add PostgreSQL module:
#!ifdef WITH_PGSQL
loadmodule "db_postgres.so"
#!endif
Set alias to host’s public IP or domain name and port:
alias="10.0.0.2:5060"
Set tcp connection to disconnect if no messages are sent. Depends on the registaration frequency of software.
tcp_connection_lifetime=610
Listen to only the desired interfaces with:
listen=tcp:10.0.0.2:5060
listen=tcp:10.0.0.2:5061
Configure GRUU
Change the following parameter to 1 so the REGISTER-request will generate GRUUs:
modparam("registrar", "gruu_enabled", 0)
The default configuration does not use GRUU to route requests within a dialog by default. Change the first route(RELAY) in route[WITHINDLG] to the following:
if ( is_gruu() ) {
route(LOCATION);
} else {
route(RELAY);
}
TODO: Something is needed for NATs?
Lastly we set the last few details needed to start Kamailio.The configuration file is located in:
/etc/default/kamailio
Set these values:
RUN_KAMAILIO=yes
USER=kamailio
GROUP=kamailio
You may want to add additional security measures to your Kamailio server. See Overview of Security related config snippets from Kamailio for security tips.
In order for REGISTER-requests to be accepted by the Kamailio, the user has to exist in database. WITH_AUTH makes kamailio require password with each request from uvgComm.
kamctl control utility is used to add users. When asked for password, the default kamctl password for kamailio is "kamailiorw". Add user with following command:
kamctl add testuser testpasswd
(check more commands from here)
You can check that everything was successful with interactive terminal:
sudo -u postgres psql
You can find users in subscriber table and active registrations in location table with select:
\c kamailio
\x on
psql> select * from subscriber;
psql> select * from location;
After modifying the config, you can start Kamailio with:
systemctl start kamailio
You can check the status with:
systemctl status kamailio
If Kamailio was running before modifying configs, use "systemctl restart" instead.
In case you need to debug Kamailio use the following:
journalctl -u kamailio.service
You may want to include
#!define WITH_DEBUG
at the beginning of /etc/kamailio/kamailio.cfg for more detailed logs.
Kamailio SIP Trunk Registration
Connect Kamailio with PostgreSQL
PostgreSQL module documentation
PostgreSQL Documentation