You are on page 1of 15

GTS Institute, VoIP ICT Labs Build & Deploy your own Private sipXecs with Openfire System

th Openfire System v1.0

Global Technology Solutions Institute


VoIP Systems Integration Hands-on Labs Training Manual

Build and Deploy Enterprise sipXecs 4.2 IP PBX Integration


with Openfire/XMPP
Kefa Rabah
GTS Institute, Vancouver Canada
krabah@gtechsi.org www.gtechsi.org

Table of Contents Page No.

BUILD AND DEPLOY ENTERPRISE SIPXECS 4.2 TELEPHONY SYSTEM INTEGRATION WITH
OPENFIRE/XMPP 3

Introduction 3

Part 1: sipX Enterprise Communications System (sipXecs) 3


1.1 The iPBX 4

Part 2: Install sipXecs PBX 5


Step 1; Install and Configure sipXecs PBX 5
Part 2: Install Webmin 23

Part 3: Install and Configure DNS Server 25

Part 4: Install sipx-openfire package 28


Step 1: Install Java (JDK6) 28
Step 2: Download and Install sipx-openfire 29

Part 5: Creating New Users Accounts on sipXecs 32


Step 1: Creating Users on sipXecs 33
Step 2: Importing users 36
Step 3: User groups 38

Par 6: Configuring Phones in sipXecs 40


Step 1: Types of phones 40
Step 2: Managed phones 40
Step 3: Unmanaged phones 47
3.1 Install & Configure Unmanaged phones 48
Step 4: Testing you sipXecs VoIP functionality using X-Lite 4 51
Step 5: Adding Contacts Lists 52

Part 7: sipXecs Conference server 53

Part 8: Internet calling and NAT traversal 58

Part 9: Connecting to the Outside World with sipXecs 60


Step 1: Adding gateways to sipXecs 60
Step 2: Configuring Managed gateways on sipXecs 60
1
April 2007, Kefa Rabah, Global Technology Solutions Institute, Vancouver Canada

www.gtechsi.org ETC204 – sipXecs Server Administration Training


GTS Institute, VoIP ICT Labs Build & Deploy your own Private sipXecs with Openfire System v1.0

Step 3: Configuring PSTN Lines on sipXec 62


3.1 Configure Caller ID 64
3.2 Configure Dial Plan 64
Step 4: Configuring Unmanaged gateways on sipXecs 65
4.1 Add gateway 66
Step 5: Configure Dial Plans 67

Part 9: Deploying sipXecs Clustering Technology 68


Step 1: High availability installation 68
Step 2: Install and configure the sipXecs distributed server 69

Part 10: Keeping your sipXecs Up-to-date (Updating) 74

Part 11: Troubleshooting your sipXecs server 75


11.1 Log Files 75
11.2 Only see Apache Test Page 75
11.3 Cannot log into Web Admin UI 76
Postgresql server not running or missconfigured 76
11.4 Forgot superadmin password 76

Part 12: Need More Training on Linux 76


sipXecs Server Administration Training – ETC204 76
Linux Administration Training 77

Part 13: Hands-on Lab Assignments 77

A GTSI Open Access Technical Academic Publications


Delivering Cutting-edge Technology at your Fingertips for Tomorrow’s Workplace

2
April 2007, Kefa Rabah, Global Technology Solutions Institute, Vancouver Canada

www.gtechsi.org ETC204 – sipXecs Server Administration Training


GTS Institute, VoIP ICT Labs Build & Deploy your own Private sipXecs with Openfire System v1.0

Global Technology Solutions Institute


VoIP Systems Integration Hands-on Labs Training Manual

Build and Deploy Enterprise sipXecs 4.2 Telephony System


Integration with Openfire/XMPP
By Kefa Rabah, krabah@gtechsi.org November 20, 2010 GTI Institute

Introduction
sipXecs open source unified communications project developed by SIPfoundry. sipXecs is excellent
selection for enterprises or individual who’re looking to replace your aging (IP) PBX with an all software
modern communications solution that scales to mid-size and large enterprise. SIPfoundry is an open
source community dedicated to the development of SIP and XMPP based communications solutions.

Currently, sipX is the leading open source IP PBX in terms of scalability, robustness and ease of use. The
sipX IP PBX has been successfully deployed in a lot of places. The largest known installation serves more
than 5,000 users connected to one redundant (HA) system. Small installations go all the way down to a
few users served by very low cost hardware.

A Private Branch Exchange (PBX) or a Private Automatic Branch Exchange (PABX - which is out of
fashion since all modern day PBXs are automatic), is a phone switch serving a business or organization
and is usually located on the organization’s premises. The PBX provides phone services including internal
calling, and access to the public switched telephone network. It allows a small number of outside lines to
be shared among all of the people of the organization. Advanced PBX phone switches sometimes provide
auto-attendant, voice-mail, and ACD (automatic call distribution) services for the organization.

Hands-on Labs Session


In this hands-on lab, you will learn how to install & configure your first sipXecs iPBX VoIP Telephony
based on Linux CentOS 5.5 machine and use it to deploy your own private PBX based VoIP system. It’s
assumed that you are comfortable working with Linux distros, especially CentOS-5, which is the core OS
for sipXecs. You’ll also learn how to install, configure and integrate sipXecs with Openfire. Its’ a great
opportunity to get up to speed on how sipXecs is at the forefront of open source enterprise VoIP telephony
development and how you can build and run your own iPBX Telephony system that’s cost-effective and
can even save you money with some of its powerful integration with Openfire etc or even start your own
private VoIP telephony business. Finally, you’ll learn how to install sipXecs cluster for high availability.
Upon completion of this hands-on lab session you should have gained a competency and skills necessary
to install and configure various components of sipXecs system.

Part 1: sipX Enterprise Communications System (sipXecs)


sipX Enterprise Communications System (sipXecs) is a highly scalable, enterprise-grade communications
solution. It is a product of the independent, not for-profit, open source organization known as SIPFoundry.
Leveraging standards and built in an open source environment, sipXecs offers dramatic cost savings,

3
April 2007, Kefa Rabah, Global Technology Solutions Institute, Vancouver Canada

www.gtechsi.org ETC204 – sipXecs Server Administration Training


GTS Institute, VoIP ICT Labs Build & Deploy your own Private sipXecs with Openfire System v1.0

ease of use, and a degree of interoperability, functionality, and scalability that is not found in other SIP
systems.
It is without surprise that the sipXecs features mimic much of the well-defined functionality of a traditional
phone system that users expect. The usual phone system cabinet is outdated, and components of the
system are, currently, separated and held together by network switching equipment, as shown in Fig. 1.

Fig. 1: Telephone system cabinet

1.1 The iPBX


Historically, the core of the phone system has always been the PBX and this is no different with sipXecs
system. Today, the traditional PBX is now referred to as an iPBX or a Softswitch. This name is derived
from the fact that the PBX functionality is accomplished in software running on a standard server as
compared to the old PSTN system. Since the software can run on a standard type of server, this computer
can be as reliable as a customer demands and as fast, depending the machine capability, and as per the
requirements for the number of users the system will support.

The success of sipXecs emanates from the ease of installation and use and which has been the core
fundamental founding principal of the sipXecs project. System administration and configuration is done
mainly via a web interface provided by a system service called the configuration server. The
configuration server is a core component of the system, which ensures that data consistency is always
maintained across all elements of the iPBX.

Technically, at the heart of the sipXecs iPBX is a Session Initiated Protocol (SIP) proxy. SIP is
an Internet Engineering Task Force (IETF) standard protocol user for conducting interactive
communications. SIP can be utilized for many forms of communications sessions, including voice, video,
and chat. The SIP call signaling is independent from the media sessions it controls.

4
April 2007, Kefa Rabah, Global Technology Solutions Institute, Vancouver Canada

www.gtechsi.org ETC204 – sipXecs Server Administration Training


GTS Institute, VoIP ICT Labs Build & Deploy your own Private sipXecs with Openfire System v1.0

The sipXecs proxy can be thought of as a call router. Its job is to direct SIP calls through the system. The
proxy itself does not handle any voice traffic (media). This is one of the reasons why sipXecs systems are
so scalable as opposed to other IP phone systems that must process voice traffic within the iPBX.

The iPBX, as a whole, is a collection of 14 separate services running on a single or multiple Linux-based
servers in case f distributed system. These services are: sipxsupervisor, freeswitch, sipregistrar, sipstatus,
sipxacd, sipxbridge, sipxcallresolver, sipxconfig-agent, sipxconfig, sipxivr, sipxpage, sipxpark,
sipxpresence, sipXproxy, sipxrelay, sipxrls, and sipXvxml. These services interoperate to deliver all of the
system functionality.

Part 2: Install sipXecs PBX


Its important to note that sipXecs does not require any special setup. It’s recommend that you install a
minimum system without graphical user interface and without the X-server. And also remember to disable
both the Firewall and SELinux during installation.

When fully installed, the sipXecs has the following functionality:

• Complete SIP IP PBX


• IM XMPP Server
• Unified Messaging System
• Conferencing Server
• Call Center Server
• GUI Management
• Mobility Services

You can install sipXecs as distributed, scalable and resilient system able to replace a legacy (IP) PBX and
provide communications to mid-size and large enterprises (10,000 users) and with a user experience
similar to Microsoft OCS.

Step 1; Install and Configure sipXecs PBX


1. Download sipXecs Stable and Development ISO. Attach the ISO to the virtual machine’s DVD-ROM
drive (Media > DVD Drive) and start the machine. You can also burn-it to CD/DVD.

2. Insert the CD/DVD and wait for it bootup, as shown in Fig. 1. Read the info especially note that he root
password after installation is setup. When satisfied, hit on the Enter key to begin installation.

5
April 2007, Kefa Rabah, Global Technology Solutions Institute, Vancouver Canada

www.gtechsi.org ETC204 – sipXecs Server Administration Training


GTS Institute, VoIP ICT Labs Build & Deploy your own Private sipXecs with Openfire System v1.0

Fig. 1

3. From Fig. 2, Loading SCSI driver screen, wait for the system to complete current task.

Fig. 2

6
April 2007, Kefa Rabah, Global Technology Solutions Institute, Vancouver Canada

www.gtechsi.org ETC204 – sipXecs Server Administration Training


GTS Institute, VoIP ICT Labs Build & Deploy your own Private sipXecs with Openfire System v1.0

4. From Fig. 3, wait for the system to complete the current task, it will continue when done.

Fig. 3

5. From Fig. 4, wait for the system to complete the current task, it will continue when done.

Fig. 4

6. From Fig. 5, wait for the system to complete the current task, it will continue when done.

Fig. 5
7
April 2007, Kefa Rabah, Global Technology Solutions Institute, Vancouver Canada

www.gtechsi.org ETC204 – sipXecs Server Administration Training


GTS Institute, VoIP ICT Labs Build & Deploy your own Private sipXecs with Openfire System v1.0

7. From Fig. 6, wait for the system to complete the current task, it will continue when done.

Fig. 6

8. From Fig. 7, wait for the system to complete the current task, it will reboot itself.

Fig. 7

8
April 2007, Kefa Rabah, Global Technology Solutions Institute, Vancouver Canada

www.gtechsi.org ETC204 – sipXecs Server Administration Training


GTS Institute, VoIP ICT Labs Build & Deploy your own Private sipXecs with Openfire System v1.0

9. From Fig. 8, the system will go through the bootup process.

Fig. 8

10. At the end of the bootup process, you should be able to access the login screen as shown in Fig. 9.
Note: the default login is user "root" and password "setup".

Fig. 9

11. Upon login, you’ll be taken to the Setup Wizard screen, as shown in Fig. 10. Note the warning that
"any existing configuration will be overwritten unless you Exit". Click on the Start button to continue.

9
April 2007, Kefa Rabah, Global Technology Solutions Institute, Vancouver Canada

www.gtechsi.org ETC204 – sipXecs Server Administration Training


GTS Institute, VoIP ICT Labs Build & Deploy your own Private sipXecs with Openfire System v1.0

Fig. 10

12. From Fig. 11, Administrator Password screen, enter admin password, tab to OK, and then hit on the
Enter key to continue. Note: do not forget this password as you’ll need to login as root later!

Fig. 11

13. From Fig. 12, Enter the network settings screen, enter Hostname, IP, Netmask, and Gateway
Address, change as desired and then tab to OK, and then hit on the Enter key to continue.

10
April 2007, Kefa Rabah, Global Technology Solutions Institute, Vancouver Canada

www.gtechsi.org ETC204 – sipXecs Server Administration Training


GTS Institute, VoIP ICT Labs Build & Deploy your own Private sipXecs with Openfire System v1.0

Fig. 12

14. From Fig. 13, DNS servers screen, enter Names servers IP address, change as desired and then tab
to OK, and then hit on the Enter key to continue.

Fig. 13

11
April 2007, Kefa Rabah, Global Technology Solutions Institute, Vancouver Canada

www.gtechsi.org ETC204 – sipXecs Server Administration Training


GTS Institute, VoIP ICT Labs Build & Deploy your own Private sipXecs with Openfire System v1.0

15. From Fig. 14, wait for the system to complete the current task, it will continue by itself.

Fig. 14

16. From Fig. 15, Set System Time Zone screen, accept the default selection, or change as desired, tab
to OK, and then hit on the Enter key to continue.

Fig. 15

17. From Fig. 16, Time Zone screen, accept the default selection, or change as desired, tab to OK, and
then hit on the Enter key to continue.

12
April 2007, Kefa Rabah, Global Technology Solutions Institute, Vancouver Canada

www.gtechsi.org ETC204 – sipXecs Server Administration Training


GTS Institute, VoIP ICT Labs Build & Deploy your own Private sipXecs with Openfire System v1.0

Fig. 16

18. From Fig. 17, wait for the system to complete the current task, it will continue by itself.

Fig. 17

19. From Fig. 18, accept the default selection or change as desired, and tab to OK, and then hit on the
Enter key to continue.

13
April 2007, Kefa Rabah, Global Technology Solutions Institute, Vancouver Canada

www.gtechsi.org ETC204 – sipXecs Server Administration Training


GTS Institute, VoIP ICT Labs Build & Deploy your own Private sipXecs with Openfire System v1.0

Fig. 18

20. Follow the link below to access the full document.

The full document has moved to Docstoc.com. You can access and download it from here:

• Build and Deploy Enterprise sipXecs Integration with Openfire

OR

http://www.docstoc.com/docs/63112277/Build-and-Deploy-Enterprise-sipXecs-Integration-with-
Openfire

sipXecs Server Administration Training – ETC204


You can now register and take our superb Introduction to the sipXecs PBX VoIP System Administration
Training including working with Openfire server and clients:

• sipXecs PBX Server Administration Training – ETC204

Contact us today: Email: info@globalopenversity.org URL: www.globalopenversity.org

-----------------------------------------------
Kefa Rabah is the Founder of Global Technology Solutions Institute. Kefa is knowledgeable in several
fields of Science & Technology, Information Security Compliance and Project Management, and
Renewable Energy Systems. He is also the founder of Global Open Versity, a place to enhance your
educating and career goals using the latest innovations and technologies.

Fellow us on Twitter: Global Open Versity and Kefa Rabah


A GOV Open Access Technical Academic Publications
Enhancing education & empowering people worldwide through eLearning in the 21st Century
14
April 2007, Kefa Rabah, Global Technology Solutions Institute, Vancouver Canada

www.gtechsi.org ETC204 – sipXecs Server Administration Training