Author:
    Elena-Ramona Modroiu

Note: this version was not officially released. The first release in 5.x series was 5.3.0.

• Kamailio (OpenSER) 5.1.x installed
  • one option to install it is to use GIT repository, tutorials are available at:
    • http://www.kamailio.org/wiki/

• Web server (e.g., Apache) with mod_rewrite enabled
  • on Debian Ubuntu, you can do:

apt-get install apache2
a2enmod rewrite

• PHP5 or PHP7 with MySQL, GD, CURL and XML support
  • on Debian Ubuntu, you can do:

For PHP5:

apt-get install php5 php5-mysql php5-gd php5-curl php-pear

For PHP7:

apt-get install php php-mysql php-gd php-curl php-xml libapache2-mod-php php-pear

You may need to enable the php7.0 module for apache:

a2enmod php7.0

CURL module is needed if you want to use JSONRPC command panel. XML support is included by core PHP5 and it is a separate package in PHP7. A reload or restart of apache server might be required.

For XMLRPC command panel, the XML_RPC pear package is needed for both PHP5 or PHP7:

pear install XML_RPC

Or it can be downloaded and installed from local tarball:

wget http://pear.php.net/get/XML_RPC-1.5.5.tgz
pear upgrade XML_RPC-1.5.5.tgz 

When released, v5.1.0 is available as tarball, otherwise it has to be taken from GIT repository.

When released, latest version of SIREMIS 5.1.x is available at:

• http://siremis.asipto.com/pub/downloads/siremis/
• it includes everything, so you do not need to download something else extra

Untar the archive on the local file system (e.g., in your web server root folder):

cd /var/www
tar xvfz siremis-x.y.z.tgz
cd siremis-x.y.z

You have to replace x.y.z with version number for Siremis (for example, for Siremis v5.1.0, replace x.y.z with 5.1.0).

Alternative, when SIREMIS was not released or you want to get latest GIT version, get it from Github project:

cd /var/www
git clone https://github.com/asipto/siremis kamailio-5.1.0

If you want to setup an alias for Apache 2.2.x (for v2.4.x see below), you can run:

make apache-conf

and you get the config snippet printed in the terminal – it should look like (of course, x.y.x is replaced by version number):

siremis-x.y.z# make apache-conf
# siremis apache conf snippet ...

	Alias /siremis "/var/www/siremis-x.y.x/siremis"
	<Directory "/var/www/siremis-x.y.x/siremis">
		Options Indexes FollowSymLinks MultiViews
		AllowOverride All
		Order allow,deny
		Allow from all
		<FilesMatch "\.xml$">
			Order deny,allow
			Deny from all
		</FilesMatch>
		<FilesMatch "\.inc$">
			Order deny,allow
			Deny from all
		</FilesMatch>
	</Directory>

You can copy&paste what was printed in the terminal into Apache conf file, inside VirtualHost settings.

For Apache2 on Debian/Ubuntu, the config file is:

/etc/apache2/sites-available/default

After restarting the web server, SIREMIS will be available under:

• http://yourwebserver.com/siremis/

If you want to use a different alias, edit Makefile and change the value of URLBASE.

Note: for Apache 2.4.x, use:

make apache24-conf

and you get the config snippet printed in the terminal.

Copy&paste what was printed in the terminal into Apache conf file, inside VirtualHost settings.

For Apache2 on Debian/Ubuntu, the config file is:

/etc/apache2/sites-available/default

After restarting the web server, SIREMIS will be available under:

• http://yourwebserver.com/siremis/

If you want to use a different alias, edit Makefile and change the value of URLBASE.

Next step is to create .htaccess and Siremis configuration files, you have to run the prepare command.

For Apache 2.2:

make prepare

For Apache 2.4:

make prepare24

The output looks like:

siremis-x.y.z# make prepare
updating htaccess file...
updating app.inc file...
done

Make sure that following directories have write access for web server user:

• siremis/log
• siremis/session
• siremis/files
• siremis/themes/default/template/cpl

On Debian/Ubuntu you can do:

siremis-x.y.z# make chown

Do not forget to restart the web server after doing the changes in its configuration file.

Database server to be used is MySQL.

You have to create a MySQL user that has access to Siremis database, for example:

GRANT ALL PRIVILEGES ON siremis.* TO siremis@localhost IDENTIFIED BY 'siremisrw';

You can run above SQL statement via mysql command line tool, connecting to MySQL server as user root.

This MySQL user will be needed later during the installation, of course, you can use an existing MySQL user that has enough privileges.

Also, you have to create Kamailio database with kamdbctl tool, if you don't have it already:

kamdbctl create

You don't need to do anything else to setup the database of Siremis, the rest of the process is down via web installation wizard.

Once you have done the steps above, access the web page:

• http://yourwebserver.com/siremis/

When you do it first time, you are redirected to an installation wizard. Follow the steps.

You get a page to start the setup process.

First step shows the status of required items. You have to update local configuration until all the items are checked ok.

In the second step you have to introduce the details to access Kamailio and Siremis database.

When you install Siremis first time, you probably have to select the following options (at the bottom of the web form):

• Create Siremis Database - this creates database 'siremis'
• Import Default Data - this imports initial data into database 'siremis'
• Update SIP Database - this updates the structure of Kamailio database for accounting and charts modules
• Replace DB Config - this updates Siremis configuration file with the details to access databases

IMPORTANT NOTE: be aware that the check box is on the right of the text describing the option. Unless you do some customization, first time installation requires all the check boxes to be set.

This page presents a status report of installation, showing whether the required directories have writable access and summary of database access details.

This is the end of installation, presenting the username and password to login to Siremis. This page is automatically redirected to login page after a short period of time.

After first login, do not forget to update the password for user admin.

• remove the install directory: siremis/install

If you want to run again installation wizard:

• restore directory: siremis/install
• remove file: siremis/install.lock

• once you are logged in, the management of Kamailio is done from the SIP Admin Menu panel, the link to access it is in upper right corner
• first to do is to add your SIP server domain, under Server Services ⇒ Domain List. If you have a single domain Kamailio installation, with no checks of domain part inside the SIP server, you can simply introduce 127.0.0.1 as your domain
• then you can start the management of records used by Kamailio SIP Server
  • add subscribers via Subscriber Services ⇒ Subscriber List
  • manage records for routing services (dispatcher/load balancing, least cost routing, …) from Routing Services ⇒ …
  • …

These are special Siremis components that need further configuration in order to work:

• Install Accounting Services
• Install XMLRPC Commands Panel
• Install JSONRPC Commands Panel
• Install Charts Services
• Adding New Views To Siremis
• Enable Public Registration

Siremis is an administration tool, it is recommended to:

• run it in a private network
• run it over HTTPS
• add extra protection at HTTP server or firewall layers (e.g., HTTP auth, IP restrictions, etc)

You may need to change the context of your web server directory, like:

chcon -t httpd_sys_content_t /var/www/html -R