SipXphone Installation

From SIPfoundry sipx, The Open Source SIP PBX for Linux - Calivia

Jump to: navigation, search

Contents

[edit] sipXphone Installation

The sipXphone SIP open source softphone is a Java VoIP (Voice over IP) phone that runs on either Windows or Linux operating systems. sipXphone is part of the sipX family of projects from SIPfoundry. It is a high functionality SIP softphone that can be used with any SIP compliant proxy or SIP PBX system. When using sipXphone with sipX – The Open Source SIP PBX for Linux, it is fully integrated into the remote configuration management provided by the sipX Configuration Server.

sipXphone is very similar in software and functionality to the original Pingtel xpressa hard and softphone. Pingtel no longer sells its once famous hard phone, but instead made the code available to the open source community. A supported version of sipXphone is still available from the Pingtel Web store. The only difference between sipXphone from SIPfoundry and the supported version from Pingtel is the inclusion of the GIPS media processing framework NetEQ, including the GIPS codec and the GIPS advanced jitter buffer and packet loss concealment. GIPS is not royalty free and requires a license from Global IP Sound.

sipXphone is a very powerful SIP softphone with lots of features. It can be easily extended using the built-in JAVA Virtual Machine (VM) and SDK, which is beyond the scope of this brief introduction.

[edit] Installing sipXphone on Micosoft Windows XP

System Requirements

  • Operating System: Windows XP
  • System Hardware: Pentium II with at least 600 MHz and 128 MB RAM
  • Audio Subsystem: Full duplex sound card and driver
  • Headset with microphone (speakers with microphone are OK too)
  • Optional: Clarisys Claritel USB handset (needs to be verified)


Installation of sipXphone under Microsoft Windows is simple. First download the Windows installer (23 MByte). Run the installer and follow the prompts as indicated.

[edit] Configuring sipXphone

After you install a sipXphone softphone, you can configure it for your environment. Fundamentally, there are two different ways of doing this:

  1. Using the phone top UI and Web interface of sipXphone to configure the softphone directly
  2. Using the sipX Configuration Server to configure the softphone remotely as part of a sipX PBX system


[edit] sipXphone boot process

sipXphone can be used as a stand-alone SIP softphone and without sipX or the sipX Configuration Server. As you start the sipXphone application, it will by default attempt to locate and contact the sipX Configuration Server. It does this by issuing a DNS query for a host called ‘sipuaconfig.your.domain’ assuming that sipuaconfig is a valid alias for the sipX Configuration Server. sipXphone will then attempt to register with this Configuration Server and obtain appropriate configuration data automatically based on its user and device profiles. The phone's serial number (defaults to PC's MAC address), stored in the local-config configuration file is used as the unique identifier. Local configuration files pinger-config and user-config will be overwritten.

If the name sipuaconfig cannot be resolved, sipXphone will start with its current configuration as defined by the following files (if they do not exist they will be created upon startup with default values): 

\Program Files\SIPfoundry\sipxphone\meta\pinger-config
\Program Files\SIPfoundry\sipxphone\meta\local-config
\Program Files\SIPfoundry\sipxphone\meta\user-config

The rest of this introduction describes how to configure sipXphone directly using its UI and Web interface and without the presence of the sipX Configuration Server.

PLEASE NOTE: By default, access to the sipXphone softphone through a browser is NOT enabled after installation. Before you use the browser-based interface, you must enable the phone’s built-in Web server and assign it to a particular port.

[edit] Starting the Web server

The sipXphone softphone’s Web server runs directly on the PC and provides access to files that are stored on that PC. For security reasons, this Web server does not start automatically after installing sipXphone.

When the sipXphone softphone’s Web server is running, only files stored in the directory Program Files\SIPfoundry\sipxphone or its subdirectories can be accessed. Files and directory listings elsewhere on the PC cannot be accessed.

Code: Starting the built-in Web server

To start the Web server, you perform these steps using the phone's UI:

  • From the sipXphone softphone’s home screen, press MORE.
  • On the Apps tab, press Prefs
  • Scroll down to review all of the categories.
  • Select the mysip softphone Web category, then press Adjust. This task requires the admin log in. Default password is empty.
  • For interaction using the HTTP protocol, check the Enable Web Server check box. Optionally, supply an HTTP port. If you do not supply a port number, the default is 80.
  • Press Ok.

Finding the phone's IP address: The sipXphone softphone uses the network information of the PC on which it is installed. You can find the IP address used by your softphone from within sipXphone or from a command prompt on your PC.

Code: Obtain sipXphone's IP address using the UI
  • From the home screen, click MORE.
  • On the Menu tab, select About.
  • Click Info.

[edit] Accessing the browser-based interface

Code: Accessing the Web UI
  • Start sipXphone.
  • Open a browser on your PC.
  • In the browser’s Address or Location field, enter the protocol and the IP address. For example, enter ''http://123.45.67.89''
  • If the browser and the sipXphone softphone are installed on the same PC, you can enter ''http://localhost''.
  • If the HTTP port is set to a number other than 80, include it using the format ''http://<ip address>:<port>/'' For example, enter ''http://123.45.67.89:8080/''.
  • Enter your user name and password in the dialog box that opens. The sipXphone softphone’s home page opens. Username admin, password is empty.

[edit] Stopping the built-in Web server

Code: Stopping the Web server

You can prevent the Web server from starting automatically the next time you start sipXphone:

  • Start the sipXphone softphone and go to Prefs. Find this application by pressing MORE, then the Apps tab.
  • Select the mysip softphone Web preference category, then press Adjust (This task requires the admin log-in).
  • Clear the Enable Web Server check box.
  • Press Ok.

[edit] sipXphone Installation under Gentoo Linux

Installation under Gentoo Linux is simple using the sipXphone Gentoo ebuild from this Wiki.

The procedure for enabling the built-in Web server is identical to the Windows version (see above).

Retrieved from "http://sipx-wiki.calivia.com/index.php/SipXphone_Installation"
Personal tools