OpenSIPS Control Panel
This tool, also known as opensips-cp, is the new graphical user interface for the SIP proxy. It was designed to be the primary tool to provision parameters for the OpenSIPS modules in the database.
The screenshot shows the tools available for OpenSIPS Control Panel. This tool is focused on the provisioning of system parameters. As it is usual for the VoIP providers to develop their own interface with the end users, the tools to manage end users are not available. Developed using PHP, opensips-cp currently features the following modules:
- CDRviewer
- dialplan
- domains
- dispatcher
- drouting
- load balancer
- Mi
- Monit
- nathelper
- pdt
- Permissions
- siptrace
- smonitor
Installation of opensips-cp
The step-by-step instructions to install opensips-cp in a server with Debian 5.0 are as follows:
Installation instructions change very often. For updates, check the opensips-cp project's website athttp://opensipscp.sourceforge.net/.
Step 1: Install Apache and PHP as follows:
apt-get install apache2 php5
Step 2: Install php5-mysql and php5-xmlrpc packages, and set the right parameters in the php.ini file. (It has been done for you to save time.)
apt-get install php5-mysql php5-xmlrpc php-pear
vi /etc/php5/apache2/php.ini
Please verify that you have set the short_open_tag = On ; option in your php.ini file.
Step 3: Download opensips-cp and untar the file.
Download opensips-cp from http://opensips-cp.sourceforge.net/index.php?req=download (or copy from DVD) and copy the opensip-cp_3.0.tgz file to /var/www as follows:
cd /var/www
wget http://sourceforge.net/projects/opensips-cp/files/opensipscp/
3.0/opensips-cp_3.0.tgz/download
tar -xzvf opensips-cp_3.0.tgz
chown www-data:www-data opensips-cp -R
Step 4: Install MDB2.
pear install MDB2
pear install MDB2#mysql
pear install log
Step 5: Configure Apache for OpenSIPS Control Panel. Edit the apache2.conf file.
vi /etc/apache2/apache2.conf
After doing so, include the following line below the last line:
Alias /cp "/var/www/opensips-cp/web"
Also, change the owner of the log file:
chown www-data:www-data /var/www/opensips-cp/config/access.log
Step 6: Install the cdr table schema:
cd /var/www/opensips-cp/web/tools/cdrviewer
mysql -D opensips -p < cdrs.sql
mysql -u root -p
mysql> use opensips
mysql -D opensips -p < opensips_cdrs_1_6.mysql
Step 7: Edit the cron_job/generate-cdrs.sh file and change the MySQL connection data (hostname, username, password, and database) as follows:
cd /var/www/opensips-cp/cron-job
vi generate_cdrs.sh
Step 8: Edit the /etc/crontab file and add the following line for a three-minute interval:
vi /etc/crontab
*/3 * * * * root /var/www/opensips-cp/cron_job/generate-cdrs.sh
Step 9: For the smonitor module, you must add two tables to the OpenSIPS database:
cd /var/www/opensips-cp/web/tools/smonitor
mysql -p opensips <tables.sql
Step 10: Add a cron job that collects data from the OpenSIPS machine(s). Here is a cron job that collects data at a one-minute interval. (This interval is not arbitrary. It must be set to one minute by design.)
vi /etc/crontab
* * * * * root php /var/www/opensips-cp/cron_job/get_opensips_stats.php >
/dev/null
The cron jobs do not need to run as root. You might want to change the user.
Step 11: Restart OpenSIPS and Apache.
Installing Monit
Monit is a system-monitoring utility that allows an admin to easily monitor files, processes, directories, or devices on your system. It can also be used for automatic maintenance/repairs by executing particular commands when errors arise. Providing instructions on how to install Monit is beyond the scope of this article, but we have provided some here in order to avoid errors when you select the Monit tool in the OpenSIPS-CP.
The step-by-step instructions are as follows:
Step 1: To install Monit on your server, simply use apt-get:
apt-get install monit
Step 2: Once installed, you'll find the main configuration file.
vi /etc/monit/monitrc
set daemon 120
set logfile syslog facility log_daemon
set alert root@localhost
set httpd port 2812 and
use address yourdomain.com
allow localhost # allow localhost to connect to the server and
allow youripaddress # allow 192.168.1.2 to connect to the server,
# You can give only one per entry
allow admin:monit # user name and password for authentication.
check process opensips with pidfile /var/run/opensips.pid
#Below is actions taken by monit when service got stuck.
start program = "/etc/init.d/opensips start"
stop program = "/etc/init.d/opensips stop"
# Admin will notify by mail if below of the condition satisfied.
if cpu is greater than 70% for 2 cycles then alert
if cpu > 90% for 5 cycles then restart
Step 3: After modifying the configuration file, you should check for the syntax to make sure that everything is correct. To do this, run:
# monit -t
Step 4: Edit the /etc/default/monit file and change the parameters as follows:
# You must set this variable to for 1 monit to start
startup=1
# To change the intervals which monit should run uncomment
# and change this variable.
# CHECK_INTERVALS=180
Configuring OpenSIPS Control Panel
Step 1: Configure the database access parameters. Edit the db.inc.php file, which is valid for all modules. You may change the database parameters for a single module inside the module configuration section.
For example:
cd /var/www/opensips-cp/config
vi db.inc.php
//database host
$config->db_host = "localhost";
//database port - leave empty for default
$config->db_port = "";
//database connection user
$config->db_user = "root";
//database connection password
$config->db_pass = "opensips";
//database name
$config->db_name = "opensips";
if ($config->db_port != "")$config->db_host=$config->db_host":"
$config->db_port;
Step 2: Configure the FIFO access in the boxes.global.inc.php file:
cd /var/www/opensips-cp/config/
vi boxes.global.inc.php
$box_id=0;
// mi host:port pair || fifo_file
$boxes[$box_id]['mi']['conn']="/tmp/opensips_fifo";
// monit host:port
$boxes[$box_id]['monit']['conn']="127.0.0.1:2812";
$boxes[$box_id]['monit']['user']="admin";
$boxes[$box_id]['monit']['pass']="monit";
$boxes[$box_id]['monit']['has_ssl']=0;
// description (appears in mi , monit )
$boxes[$box_id]['desc']="Primary SIP server";
$boxes[$box_id]['assoc_id']=1;
// enable local smonitor charts on this box : 0=disabled 1=enabled
// (cron)
$boxes[$box_id]['smonitor']['charts']=1;
Step 3: Access http://server_ip_address/cp and check each module for the correct functionality.