Professional Documents
Culture Documents
org/installation_guide
Overview
Quick Install
Step 1: Prerequisites
Step 3: Compile
Step 8: Test!
Overview
This page is supposed to help you jump-start the Open IMS Core. In the SVN distribution, the
whole things is pre-configured and pre-provisioned with a set of minimal data that should be
enough for a simple "Alice-calls-Bob" trial.
Quick Install
If you already went once through the installation procedure, this section will help refresh your
memory on what steps you are supposed to follow. If this is your first time, skip over it for now
and start with Step 1.
mkdir /opt/OpenIMSCore
cd /opt/OpenIMSCore
mkdir FHoSS
svn checkout
http://svn.berlios.de/svnroot/repos/openimscore/FHoSS/trunk FHoSS
mkdir ser_ims
svn checkout
http://svn.berlios.de/svnroot/repos/openimscore/ser_ims/trunk ser_ims
cd FHoSS
ant compile deploy
cd ..
cd ser_ims
make install-libs all
cd ..
mysql -u root -p < FHoSS/scripts/hss_db.sql
mysql -u root -p < FHoSS/scripts/userdata.sql
mysql -u root -p < ser_ims/cfg/icscf.sql
cp ser_ims/cfg/*.cfg .
cp ser_ims/cfg/*.xml .
cp ser_ims/cfg/*.sh .
Step 1: Prerequisites
Hardware requirements
o A current Linux desktop class machine should be enough
o
Network access
o
Controllable DNS server if you don't want to have one on your Linux box
Software requirements
o
MySQL installed and started (or other DBMS if you can deal with it)
bison, flex
Linux kernel 2.6 and ipsec-tools (setkey) if you want to use IPSec security
bind installed and running (or other name server if you can deal with it)
Browser on the box or that can connect to the box (for user provisioning)
Note: we consider that you have all this installed, configured and running.
Note: we assume for now that you want to install the whole thing on just 1 box.
How? - The source code is pre-configured to work from a standard file path:
o
mkdir /opt/OpenIMSCore
cd /opt/OpenIMSCore
o
o
o
o
If you would prefer another path, be prepared to edit the configuration files!
mkdir ser_ims
svn checkout
http://svn.berlios.de/svnroot/repos/openimscore/ser_ims/trunk
ser_ims
mkdir FHoSS
svn checkout
http://svn.berlios.de/svnroot/repos/openimscore/FHoSS/trunk FHoSS
Step 3: Compile
ser_ims
o New!!! Do "make install-libs all" in ser_ims
o
o
cd ser_ims
make install-libs all
cd ..
FHoSS
o
Make sure, that the JDK version that you are using is >= 1.5!!!
o
o
o
# java -version
java version "1.5.0_07"
Java(TM) 2 Runtime Environment, Standard Edition (build 1.5.0_07b03)
Java HotSpot(TM) Client VM (build 1.5.0_07-b03, mixed mode)
It is often the case that users have just installed a 1.5 JDK but they are
still using their old JDK installation! If you see lots of errors, recheck
this before posting a bug report!
o
o
o
cd FHoSS
ant compile
ant deploy
cd ..
While you wait for the compilation to finish, you can go ahead and perform Step 4.
Notes:
o
All the installation examples configured to work only on the local loopback
and the default domain configured as "open-ims.test".
The MySQL access rights are set only for local access
We recommend that you try it first like this and then do your changes:
DNS
o
Edit named.conf and insert the file there (Would be great to also add reverse DNS
entries)
Test that the names are resolvable (don't forget about /etc/resolv.conf pointing to
your new DNS server!)
MySQL
o
o
o
o
o
o
o
o
cp ser_ims/cfg/*.cfg .
cp ser_ims/cfg/*.xml .
cp ser_ims/cfg/*.sh .
FHoSS
o
Edit these files to your own preferences (don't forget to update the DNS zone file
accordingly and restart the name server)
CSCFs
o
By default you should see periodically log messages with the content of the
registrar and with the opened diameter links
FHoSS
o
Start FHoSS/deploy/startup.sh
If the previous step fails, check that you have the JAVA_HOME environment
variable correctly exported and/or modify the script that you just tried to start.
Check if the Diameter Peers are connecting to each other. You can see this in the
console of FHoSS or in that of I/S-CSCF
FHoSS
o
alice@open-ims.test
bob@open-ims.test
Create a Subscription
Link them
SIP-to-IMS Gateway
o
The SIP-to-IMS Gateway is now obsolete and was droped from the project. See
the Annex and FAQ for information
on how you can use the Open IMS Core with SIP clients capable of only MD5
authentication.
Provision with your own UE data or use one of the default users
Alice:
OP: 0x00...0
AMF: 0x00...0
Realm: open-ims.test
Bob: similar
Alice:
Password: alice
!!! Make sure that your SIP client does REGISTER sip:open-ims.test and
not REGISTER sip:pcscf.open-ims.test:4060
!!! Read the Annex and FAQ related to using MD5-only clients with the
Open IMS Core
Bob: similar
Step 8: Test!
This is the last step. You should have all installed and configured by now
Registration uses all components and as such, it is a good test if all is up & running
Get the bind (or often called named) package installed on your distribution
Make sure you are root
Edit that file according to your needs. Here are some things that you need in there:
options {
...
forward first;
forwarders {
{THE_IP_ADDRESS_OF_YOUR_UPSTREAM_DNS_SERVER;}
};
...
};
...
zone "open-ims.test" IN {
type master;
file "pri/open-ims.dnszone";
notify no;
};
...
On some distributions this file includes other files so be sure to dig through those also.
THE_IP_ADDRESS_OF_YOUR_UPSTREAM_DNS_SERVER can be found in
/etc/resolv.conf.
cp /opt/OpenIMSCore/ser_ims/cfg/open-ims.dnszone /var/bind/pri/
chown -R named:named /var/bind/pri/open-ims.dnszone
Then start or re-start the DNS server (remember that these configuration files are not
monitored
for changes so you will have to send a SIGHUP or do a restart to reload them).
/etc/init.d/named restart
You should now test if it works. In the response look if you got the correct answer.
dig @127.0.0.1 pcscf.open-ims.test
To actually use it, you would need to configure it as a DNS server for your machine. Here
is
how your /etc/resolv.conf file should look like:
# cat /etc/resolv.conf
nameserver 127.0.0.1
search open-ims.test
domain open-ims.test
Remember that utilities like the DHCP-Client overwrite this file be default!
First provision the users (or use the default sip:alice@open-ims.test or sip:bob@openims.test).
Make sure than in the HSS provisioning interface in the private identity configuration,
you allow the
use of Digest-MD5 for the respective users
Then you have two options for the S-CSCF to trigger an MD5 authentication
1. Modify the client to send a parameter "algorithm=MD5" in the Authorization
header in the first
unauthorized REGISTER.
2. Or modify the scscf.cfg and enable the MD5 authorization as the default
authentication method instead
of AKAv1-MD5.
Next just make sure that the client is using the P-CSCF address (sip:pcscf.openims.test:4060 by default) as
strict outbound proxy and the REGISTER Request-URI is "sip:open-ims.test" (or your
own domain name) and not
"sip:pcscf.open-ims.test:4060" as many SIP clients fail here.
No, it can also reconfigure *.xml , *.sql and FHoSS configuration files(*.properties).
How do I make use of configurator.sh?
You can directly execute it and fetch the files to be changed as arguments. See the
example
below:
# pwd
/opt/OpenIMSCore
# ser_ims/cfg/configurator.sh ser_ims/cfg/scscf.cfg
ser_ims/cfg/icscf.xml \
FHoSS/deploy/hss_db.sql FHoSS/deploy/hss.properties