Tutorial on SIP and SIP SER server

Installation of SER.

 

This page contains instructions to install SER on

• FreeBSD ver 4.10 (preferred by this tutorial), and
• Red Hat Fedora Core 1

 

 

References:

http://iptel.org/ser/doc/ser-howto/ser-Howto.html

By Quincy Wu and Stephen Kingham, June 2004

 

Step by Step Installation of SER on FreeBSD 4.10

The following has been tested on a FreeBSD install as per instructions and is based on SER version 0.8.12

Key to the colours used:
Pink indicates a command or a filename
Red indicates something specific to your SER Server, do not just put in the example

 

• Get the software, install, and run

  • from SER or from this server

  • Install
    

    cd /; gunzip -c ser-0.8.12_freebsd_i386.tar.gz | tar -tvf -  

  • Start
    

    /usr/local/sbin/ser -P /var/run/ser.pid

• Do some environmental changes

  • export SIP_DOMAIN="nctu.edu.tw"
    

  • Edit /etc/profile and add the following line to the end of the file:
    

    export SIP_DOMAIN="nctu.edu.tw"
    export LD_LIBRARY_PATH /usr/local/lib/mysql
    

• From the sysinstall main menu, choose Configure - Packages, and install the following packages:
• database/mysql-server-4.0.18_1
• This will also install mysql-client-4.0.18_1
  
• lang/phpMyAdmin-2.5.6
• This will also install php4-4.3.6
• Start MySQL server
  
• Login as root (Note: not just sudo)
• Initiate MySQL database
  /usr/local/bin/mysql_install_db
• Start MySQL server
  /etc/rc.d/init.d/mysqld start
• Configure the install, ie the mysql password and the ser database password
  • View /usr/sbin/ser_mysql.sh, where the following are defined
    DBHOST=localhost
    USERNAME=ser
    DEFAULT_PW=heslo
    ROUSER=serro
    RO_PW=47serro11
    SQL_USER="root"
    DEFAULT_PW=heslo
    # DEFAULT_PW is the password used by serctl to add users etc! Create the SER database with this SER script
• Run the SER script to create the SER database in mysql.
  /usr/sbin/ser_mysql.sh create
  Notes:
  MySql password for root: BLANK
  Domain (Realm) is the domain name for the SIP users: nctu.edu.tw
  Second password: BLANK
• Enter mysql and check that the tables have been created, follow these commands to check it is working correctly:
  mysql
  connect ser;
  show tables;
  select * from subscriber;
  exit
• Start phpMyAdmin, which is a web interface for managing your MySQL database:
  cd /usr/local/www/data-dist/phpMyAdmin/
  cp config.inc.php.sample config.inc.php
  vi config.inc.php
    $cfg['Servers'][$i]['user']          = 'ser';
    $cfg['Servers'][$i]['password']      = 'heslo';
    # There are 3 pairs, but I only change the first pair
• Now you may visit the URL http://your.host.name/phpMyAdmin/ to manage your database
  
• Edit the SER configuration file "/usr/local/etc/ser/ser.cfg" so that SER will use mysql
  • Uncomment the line loadmodule "/usr/lib/ser/modules/mysql.so"
  • Comment the line modparam("usrloc", "db_mode", 0)
  • Uncomment the line modparam("usrloc", "db_mode", 2)
  • to enable digest authentication:
    • Uncomment the line loadmodule /usr/lib/ser/modules/auth.so
    • Uncomment the line loadmodule /usr/lib/ser/modules/auth_db.so
  • Uncomment these lines and change all instances of iptel.org to nctu.edu.tw
    • if (!www_authorize("nctu.edu.tw", "subscriber")) {
    • www_challenge("nctu.edu.tw", "0");
• Restart SER so that the changes take effect
  cd /usr/local/lib/mysql
  ln -s libmysqlclient.so.12 libmysqlclient.so.10
  # temporary solution
  kill `cat /var/run/ser.pid`
  /usr/local/sbin/ser -P /var/run/ser.pid
• Create two users using serctl. IMPORTANT NOTE : YOU MUST BE LOGGED IN AS ROOT (NOT JUST sudo)!!!!!!!
  Format of the command is: serctl add <username> <password> <email>
  and you need to use the DEFAULT_PW=heslo as the password set in /usr/sbin/ser_mysql.sh
  /usr/sbin/serctl add quincy password quincy@6ren.net.tw
  /usr/sbin/serctl add solomon password solomon@ipv6.org.tw
• Test the connection using two SIP UAs.
  • See the examles of how to configure UAs.
  • Use the this command to see who is logged in:
    serctl ul show

 

 

Step by Step Installation of WEBSER on FreeBSD 4.10

When the original distribution is installed the directory locations do not match up with the typical apache file locations. These notes document all the changes needed. SUGGESTION: For the Tutorial we should develop a new install TAR so delegates do not spend 30 minutes editing all the files.

 

• Get the TAR, un-tar and place the files in the right directory

  • from SER or from this server

  • untar
    gunzip -c serweb_2004-01-04.tar.gz | tar -xvf -
    

  • change directory to where the files were untared to
    cd serweb_2004-01-04

  • Move the phplib directory.  It is recommended that you don't place the directory in the HTML tree on your server.
    mv phplib  /usr/local/www/
    chown -R root:mysql /usr/local/www/phplib/
    chmod -R 755 /usr/local/www/phplib/

  • Move the html files to the DocumentRoot directory
    mv html /usr/local/www/data/serweb/
    chown -R root:mysql /usr/local/www/data/serweb/
    chmod -R 755 /usr/local/www/data/serweb/
    
    

• Edit php.ini
  cd /usr/local/etc/
  cp php.ini-recommended php.ini
  vi php.ini

  Change register_globals = "Off" to "On"

• Create these files as part of the serweb module.

  echo "<BODY><H1> AARNet SIP Tutorial" > serweb/prolog.html
  echo "</H1><HR>" > /usr/local/www/data/serweb/separator.html
  echo "<H1>End of Page</H1></BODY>" > /usr/local/www/data/serweb/epilog.html
  
  

• ALL the files that follw are with respect to /usr/local/www/data/serweb
  cd /usr/local/www/data/serweb
  
  
• edit these lines in ./config.php
  
  Replace all 192.168.2.16 with your.host.name

  vi ./config.php
  :%s/192.168.2.16/your.host.name/

  #If you have changed the mysql username, dbname or password you need to change these:
  $this->db_name="ser"; //database name
  $this->db_user="ser"; //database conection user
  $this->db_pass="heslo"; //database conection password
  # NOTE: The above relate to the mysql database, see /usr/sbin/ser_mysql.sh.
  
  $this->root_path="/serweb/";
  # (Two occurrences of this line)
  #The above must match where the serweb html directory is put
   
  $this->user_pages_path = this->root_path."user_interface/";
  
  $this->prolog="/serweb/prolog.html";
  $this->separator="/serweb/separator.html";
  $this->epilog="/serweb/epilog.html";
  
  $this->root_uri.$this->root_path."user_interface/my_account.php?#session#\n\n".
  $this->root_uri.$this->root_path."user_interface/reg/confirmation.php?nr=#confirm#\n\n".
  # /* email address for questions concerning registration */
  
  # There is heaps more to customise in this file which we will leave to the user. These include more email references and text used in emails to users who register. Here are some example which do not need to be changed for this tutorial:
  $this->mail_header_from="Stephen.Kingham@aarnet.edu.au";
  $this->web_contact="sip:Stephen.Kingham@aarnet.edu.au";
  $this->title="AARNet IP Telephony Site";
  $this->infomail = "Stephen.Kingham@aarnet.edu.au";
  $this->regmail = "Stephen.Kingham@aarnet.edu.au";
• ln -s /usr/local/www/data/serweb/user_interface /usr/local/www/data/serweb/user
  
• Edit /usr/local/www/phplib/db_mysql.inc
  # You need to add the following to /* public: connection parameters */
  var $Host = "127.0.0.1";
  var $Database = "ser";
  var $User = "ser";
  var $Password = "heslo";

The follwoing changes can be applied three ways:

1. Get and extract this tar file	Get the file fixupserwebphp.tar (yet to be developed) from this server put it in the directory /usr/local/src/ser Issue these commands cd /usr/local/www/data/serweb tar -xvf fixupserwebphp.tar
OR
2. Manualy make all these changes	Generaly you have to add "../" to all these files so that they point correctly to where the phplib is. Edit ./admin/prepend.php # change $_PHPLIB["libdir"] = "../../../phplib/"; Edit ./user_interface/prepend.php # change $_PHPLIB["libdir"] = "../../../phplib/"; Edit ./user_interface/reg/prepend.php # change $_PHPLIB["libdir"] = "../../../../phplib/"; Edit ./admin/acl.php # change require "../../../phplib/oohforms.inc"; Edit ./admin/index.php # require "../../../../phplib/oohforms.inc"; Edit ./admin/users.php # require "../../../../phplib/oohforms.inc"; Edit ./user_interface/accounting.php # require "../../../../phplib/oohforms.inc"; Edit ./user_interface/find_user.php # require "../../../../phplib/oohforms.inc"; Edit ./user_interface/index.php # require "../../../phplib/oohforms.inc"; Edit ./user_interface/missed_calls.php # require "../../../phplib/oohforms.inc"; Edit ./user_interface/my_account.php # require "../../../phplib/oohforms.inc"; Edit ./user_interface/phonebook.php # require "../../../phplib/oohforms.inc"; Edit ./user_interface/send_im.php # require "../../../phplib/oohforms.inc"; Edit ./user_interface/notification_subscription.php # require "../../../phplib/oohforms.inc"; Edit ./user_interface/reg/finish.php # require "../../../../phplib/oohforms.inc"; Edit ./user_interface/reg/get_pass.php # require "../../../../phplib/oohforms.inc"; Edit ./user_interface/reg/index.php # require "../../../../phplib/oohforms.inc";
OR
3. Create a symbolic link	ln -s /usr/local/www/phplib /usr/local/www/data/ # For an operating service, this may not be recommended for security reason; but it works for the scope of this workshop.

 

• LAST STEP: RESTART APACHE
  

  kill -HUP `cat /var/run/httpd.pid`

• Now you can login as "admin" with password "heslo" from
• http://your.host.name/serweb/admin/index.php
• http://your.host.name/serweb/user_interface/index.php

 

---

 

Step by Step Installation of SER on RedHad Fedora Core 1

The following has been tested on a RedHat Fedora Core 1 install as per instructions and is based on SER version 0.8.12

Key to the colours used:
Pink indicates a command or a filename
Red indicates something specific to your SER Server, do not just put in the example

 

• Get the software, install, and run

  • from SER or from this server

  • Install
    

    rpm -i ser-0.8.12-0.i386.rpm 

  • Start
    

    /etc/rc.d/init.d/ser start

• Do some environmental changes

  • export SIP_DOMAIN="aarnet.edu.au" Note I used an IP address here to make it work.

  • Edit /etc/profile and add the foloowing line one the end of the file:
    

    export SIP_DOMAIN="aarnet.edu.au" Note I used an IP address here to make it work.

• Get the SER mysql module, configure the install, install it, configure SER and restart SER

• from SER or from this server

• Install mysql
  rpm -i ser-mysql-0.8.12-0.i386.rpm
• Start
  /etc/rc.d/init.d/mysqld start
• Configure the install, ie the mysql password and the ser database password
  • Edit /usr/sbin/ser_mysql.sh, the following may want to be changed
    #?????? DO we change the values in /usr/sbin/ser_mysql.sh ?????
    DBHOST=localhost
    USERNAME=ser
    DEFAULT_PW=heslo
    ROUSER=serro
    RO_PW=47serro11
    SQL_USER="root"
    DEFAULT_PW=heslo
    # DEFAULT_PW is the password used by serctl to add users etc! Create the SER database with this SER script
• Run the SER script to create the SER database in mysql. IMPORTANT NOTE : YOU MUST BE LOGGED IN AS ROOT (NOT JUST sudo)!!!!!!!
  /usr/sbin/ser_mysql.sh create
  Notes:
  MySql password for root: BLANK
  Domain (Realm) is the domain name for the SIP users: aarnet.edu.au
  Second password: BLANK
• Enter mysql and check that the tables have been created, follow these commands:
  mysql
  connect ser;
  show tables;
  select * from subscriber;
  exit
• Edit the SER configuration file "/etc/ser/ser.cfg" so that SER will use mysql
  • Uncomment the line loadmodule "/usr/lib/ser/modules/mysql.so"
  • Comment the line modparam("usrloc", "db_mode", 0)
  • Uncomment the line modparam("usrloc", "db_mode", 2)
  • to enable digest authentication:
    • Uncomment the line loadmodule /usr/lib/ser/modules/auth.so
    • Uncomment the line loadmodule /usr/lib/ser/modules/auth_db.so
  • Uncomment these lines and change all instances of iptel.org to aarnet.edu.au
    • if (!www_authorize("aarnet.edu.au", "subscriber")) {
    • www_challenge("aarnet.edu.au", "0");
• Restart SER so that the changes take effect
  /etc/rc.d/init.d/ser restart
• Create two users using serctl. IMPORTANT NOTE : YOU MUST BE LOGGED IN AS ROOT (NOT JUST sudo)!!!!!!!
  Format of the command is: serctl add <username> <password> <email>
  and you need to use the DEFAULT_PW=heslo as the password set in /usr/sbin/ser_mysql.sh
  /usr/sbin/serctl add srk password Stephen.Kingham@aarnet.edu.au
  /usr/sbin/serctl add caf password Clayton.Forbes@aarnet.edu.au
• Test the connection using two SIP UAs.
  • See the examles of how to configure UAs.
  • Use the this command to see who is logged in:
    serctl ul show

 

 

Step by Step Installation of WEBSER on RedHad Fedora Core 1

When the original distribution is installed the directory locations do not match up with the typical apache file locations. These notes document all the changes needed. SUGGESTION: For the Tutorial we should develop a new install TAR so delegates do not spend 30 minutes editing all the files.

 

• Get the TAR, un-tar and place the files in the right directory

  • from SER or from this server

  • untar
    tar -xvzf serweb_2004-01-04.tar.gz

  • change directory to where the files were untared to
    cd serweb_2004-01-04

  • Create the directory and move the files there
    mkdir /var/www/phplib
    chown root /var/www/phplib
    chgrp root /var/www/phplib
    chmod 755 /var/www/phplib
    cp ./phplib/* /var/www/phplib/ -R

  • # Move the html files to the DocumentRoot directory
    mkdir /var/www/html/serweb/
    chown apache /var/www/html/serweb/
    chgrp root /var/www/html/serweb/
    chmod 755 /var/www/html/serweb/
    cp ./html/* /var/www/html/serweb -R

• edit these lines in /etc/php.ini
  and change short_open_tag = Off" to "On"
  

  and change register_globals = Off" to "On"

• Create these files as part of the serweb module.

  vi /var/www/html/serweb/prolog.html
  <body><H1>AARNet SER SIP Server</H1>
  
  vi /var/www/html/serweb/separator.html
  <HR>
  
  vi /var/www/html/serweb/epilog.html
  <H1>End of page text</H1></BODY>

• ALL the files that follw are with respect to /var/www/html/serweb
  cd /var/www/html/serweb
  
  
• edit these lines in ./config.php
  
  In general replace all 192.168.2.16 with 192.94.63.28
  
  #If you have changed the mysql username, dbname or password you need to change these:
  $this->db_name="ser"; //database name
  $this->db_user="ser"; //database conection user
  $this->db_pass="heslo"; //database conection password
  # NOTE: The above relate to the mysql database, see /usr/sbin/ser_mysql.sh.
  
  $this->root_path="/serweb/";
  #The above must match where the serweb html directory is put
  
  this->user_pages_path = this->root_path."user_interface/";
  
  $this->prolog="/serweb/prolog.html";
  $this->separator="/serweb/separator.html";
  $this->epilog="/serweb/epilog.html";
  # /* email address for questions concerning registration */
  
  $this->root_uri.$this->root_path."user_interface/my_account.php?#session#\n\n".
  $this->root_uri.$this->root_path."user_interface/reg/confirmation.php?nr=#confirm#\n\n".
  
  # There is heaps more to customise in this file which we will leave to the user. These include more email references
  # and text used in emails to users who register. Here are some example which do not need to be changed for this tutorial:
  $this->mail_header_from="Stephen.Kingham@aarnet.edu.au";
  $this->web_contact="sip:Stephen.Kingham@aarnet.edu.au";
  $this->title="The AARNet IP Telephony Site";
  $this->infomail = "Stephen.Kingham@aarnet.edu.au";
  $this->regmail = "Stephen.Kingham@aarnet.edu.au";
  
  
  
• Edit /var/www/phplib/db_mysql.inc
  # You need to add the following to /* public: connection parameters */
  var $Host = "192.94.63.28";
  var $Database = "ser";
  var $User = "ser";
  var $Password = "heslo";

The follwoing changes can be applied two ways:

1. Get and extract this tar file	get the file fixupserwebphp.tar from this server put it in the directory /usr/local/src/ser issue these commands cd /var/www/html/serweb tar -xvf fixupserwebphp.tar
OR
2. Manualy make all these changes	Generaly you have to add "../" to all these files so that they point correctly to where the phplib is. Edit ./admin/prepend.php # change $_PHPLIB["libdir"] = "../../../phplib/"; Edit ./user_interface/prepend.php # change $_PHPLIB["libdir"] = "../../../phplib/"; Edit ./user_interface/reg/prepend.php # change $_PHPLIB["libdir"] = "../../../../phplib/"; Edit ./admin/acl.php # change require "../../../phplib/oohforms.inc"; Edit ./admin/index.php # require "../../../../phplib/oohforms.inc"; Edit ./admin/users.php # require "../../../../phplib/oohforms.inc"; Edit ./user_interface/accounting.php # require "../../../../phplib/oohforms.inc"; Edit ./user_interface/find_user.php # require "../../../../phplib/oohforms.inc"; Edit ./user_interface/index.php # require "../../../phplib/oohforms.inc"; Edit ./user_interface/missed_calls.php # require "../../../phplib/oohforms.inc"; Edit ./user_interface/my_account.php # require "../../../phplib/oohforms.inc"; Edit ./user_interface/phonebook.php # require "../../../phplib/oohforms.inc"; Edit ./user_interface/send_im.php # require "../../../phplib/oohforms.inc"; Edit ./user_interface/notification_subscription.php # require "../../../phplib/oohforms.inc"; Edit ./user_interface/reg/finish.php # require "../../../../phplib/oohforms.inc"; Edit ./user_interface/reg/get_pass.php # require "../../../../phplib/oohforms.inc"; Edit ./user_interface/reg/index.php # require "../../../../phplib/oohforms.inc";

 

• LAST STEP: START APACHE
  /etc/rc.d/init.d/httpd start
  

 

Useful links

• www.iptel.org
• http://voip.internet2.edu/SIP.edu/