Jabber XCP Server for Solaris/Linux Installation Guide Product: Jabber XCP 5.
Disclaimers Copyright 2008, Jabber, Inc. The information contained in this document is proprietary to Jabber, Inc. This information is considered confidential and is not to be disclosed to any outside parties without the express written consent of Jabber, Inc. This document is provided for information purposes only, and the information herein is subject to change without notice. Jabber, Inc. does not provide any warranties covering and specifically disclaims any liability in connection with this document.
Table of Contents Installation Checklist Release Documentation 5 6 Chapter 2. System Requirements................................................................................... 8 Operating System and Resource Requirements Supported Operating Systems Resource Settings Minimum Hardware Requirements Sun SPARC Systems x86 Compatible Systems Default Ports Supported Databases Supported Directory Servers Supported Clients SMTP Requirements SNMP Requirements 9 9 10 10 10 10 11 11 12 13 13 13 Chapter 3.
Appendix B. Jabber XCP Glossary .............................................................................
The Jabber XCP Server Installation Guide for Solaris/Linux contains instructions for installing Jabber XCP 5.2.2. It also provides information to help you plan your Jabber XCP server deployment. Instructions for upgrading to version 5.2 SP2 from version 5.x are provided in the Jabber XCP Server Release Notes for Jabber XCP 5.2 SP2. If you are planning to run a SIP gateway in your Jabber XCP environment, see the Jabber Interoperability Options Setup Guide.
Release Documentation Install the Jabber XCP core server package (see “Installing the Jabber XCP Core Server” on page 20). Install your Jabber XCP license file (see “Installing the Jabber XCP License” on page 24). If you want to use more advanced Jabber XCP features such as the SDKs, Web Services, InfoBroker, and Presence Mirror, install the Jabber XCP developer extensions (see “Installing Jabber XCP Developer Extensions” on page 25).
Release Documentation Jabber XCP Server Developer Guide (Document Version C) • Libjcore SDK Tutorial (Document Version C) • Text Conferencing SDK Tutorial (Document Version C) • Web Services API Development Guide (Document Version C) • Java LaunchBroker SDK Tutorial (Document Version C) • Javajcore SDK Tutorial (Document Version C) • Online help for configuring the Jabber XCP server is accessible by clicking the Help link available on each page in the Jabber XCP Controller’s interface.
Y our Jabber XCP installation must meet the minimum system requirements listed in this chapter. To install the Jabber XCP server software, your server platform must support UTF-8 encoding.
Operating System and Resource Requirements Operating System and Resource Requirements This section lists the supported operating systems and resource requirements. Supported Operating Systems The Jabber XCP server has been verified and is supported on the following operating systems: • Sun SolarisTM 9, 10 − Your system must support UTF-8. − If you are running Solaris 9, make sure that you have installed the SUNWeu8os package.
Minimum Hardware Requirements Resource Settings Make sure that the following ulimit settings are in place: • For the system on which you plan to install the Jabber XCP server, the ulimit setting must be 1024 or above; for example: -n ulimit -n 1024 • For the system on which you run the Server-to-Server Command Processor, the setting should be twice the number of server connections that you expect.
Default Ports The installation scripts unpack themselves into the /var/tmp directory during the installation, and then clean themselves up. This directory must have enough space in it to handle the installation. Default Ports The following ports are used by the Jabber XCP server: Port 5222 must be accessible to your local network and, optionally, to the Internet, for Jabber clients to communicate with your Jabber XCP server over the Internet. Port 5223 is required if you are implementing SSL or TLS.
Supported Directory Servers Jabber-supported databases include: PostgreSQL 8.1 – This database must be configured to be SQL_ASCII. • Oracle® 9i, Release 2; Oracle 10g, R2 – For either version of Oracle, you must install the Oracle 9 client libraries (9.2.0.4) on your Jabber XCP server. • DB2® version 8.2 • Microsoft SQL Server 2000, SP4 – You must use version 2000.80.194.00 or higher of the ODBC driver that comes with SQL Server 2000. • Microsoft SQL Server 2003, SP1 and R2 • SQLite3-3.2.2.
Supported Clients Supported Clients Jabber XCP 5.2 has been verified to operate with and is supported for the following clients: • • Jabber Messenger 3.2.x Jabber Messenger for the Web 5.0 If you plan to configure Jabber XCP’s SMTP feature to enable users to send offline messages to each other, you must have a mail server. The SMTP feature has been verified with and is supported for SMTP-compatible email servers such as Sendmail v8.x.
The Connection Manager (CM) component enables IM clients and servers to connect to your Jabber XCP server. You can configure multiple CM components to increase the number of connections that your server can handle and to enable communication over different protocols. Although you can run all of your CM components your primary Jabber XCP server, you can also install and run CMs on systems that are external to your primary server.
The primary Jabber XCP server’s core router establishes communication with each remote server using an outgoing router-to-router connection. • Ports 7400 and 7300 are open on the firewall between the primary Jabber XCP server and the DMZ. The primary server must be able to open port 7400, which is the core router’s default Master Accept Port, and 7300 is used to access the Controller on the remote system during server configuration. Port 7300 must be open only when the remote system is being configured.
DMZ Primary Jabber XCP Server Web CM JSM CM Internet JSM CM WEBCP JSMCP XMPP Director XMPP Director JSMCP Jabber Session Manager XMPP Director Core Router 5222/TCP Text Conferencing 5269/TCP Firewall Open Port connection 7400/TCP Router-to-Router connection Router Logging 7300/TCP S2S CM Firewall S2SCP XMPP Incoming Director Web CM Core Router WEBCP XMPP Outgoing Director XMPP Director Router Logging Web CM XMPP Server WEBCP XMPP Director JSM CM JSMCP XMPP Director Figure 1.
Before you can install the Jabber XCP server, you must download the installer scripts and the license file, which are available on your web page on the Jabber Support site. To download the Jabber XCP software and license 1. Access the Jabber Support website at: http://support.jabber.com 2. Log in using your username and password. (You should have received an email with your account information.) 3. In the left pane, click Downloads. 4. Locate and click the ServerXCP-5.2-SP2-[L|S].
The core package is required and must be installed first. It provides standard instant messaging functionality and contains all of the components that are necessary to and set up a new Jabber XCP system. The Developer Extensions package is optional. It contains advanced features and special SDK components that enable software developers to extend the functionality of the Jabber XCP server. Table 1 lists the contents of both packages. Table 1.
T his chapter describes how to perform a new installation of the Jabber XCP server. Before you can install the server, make sure that you have downloaded the installer scripts and the license file as described in Chapter 4, “Downloading the Jabber XCP Server Software”.
Installing the Jabber XCP Core Server To prepare your system for installation 1. On the machine where you plan to install the Jabber XCP server, change to the super user: su 2. Enter the root password. 3. Create a Jabber user: useradd jabber Enter a password for the Jabber user. 5. Create a Jabber group: Beta Version Only 4. groupadd jabber 6. Create the directory where you plan to install the server; for example: mkdir /opt/jabber/XCP_5.
Installing the Jabber XCP Core Server To install the Jabber XCP core server 1. On your primary Jabber XCP server, change to the Jabber user that you created in the previous section. su - jabber 2. Enter the Jabber user’s password. 3. Set the $JABBER_HOME environment variable to the Jabber XCP installation directory that you created in the previous section; for example: export JABBER_HOME=/opt/jabber/XCP_5.
Installing the Jabber XCP Core Server Enter the IP Address of this machine [ 127.0.0.1 ]: Enter the Jabber XCP server’s IP address. The IP address of the computer on which you are installing the server is supplied by default. This must be a static IP address. Enter a port for XCP component connections [7400]: Enter the port on which the Jabber XCP router will listen for connections from all components. This port is referred to in the Controller and in the documentation as the Master Accept Port.
Installing the Jabber XCP Core Server The installer script does not ask you about the PostgreSQL database. If you are using PostgreSQL, see the “Setting up PostgreSQL” chapter in the Jabber XCP Server Database Setup Guide for Solaris/Linux after you have finished installing the server. Enter the staging (upload) directory path for file transfers [/opt/jabber/var/staging]: Press ENTER to accept the default location for the Advanced File Transfer staging directory, or type a new path.
Installing the Jabber XCP License Installing the Jabber XCP License Required: You must install the Jabber XCP license file before you can start the Jabber XCP Controller and the server. To perform this procedure, make sure that you have downloaded the Jabber XCP license file (license.xml) from the Jabber Support site as described in Step 7 on page 17. These instructions assume that you downloaded the license into the /tmp directory on your primary Jabber XCP server. 1.
Installing Jabber XCP Developer Extensions 6. Add two symbolic links that will restart the Controller and the Jabber XCP server automatically if the remote system goes down or is rebooted. You can use the same commands on both Solaris and Linux systems. Change to the /etc/rc3.d directory, and enter the following commands to create these links: ln -s $JABBER_HOME/bin/runcontroller S98Jabber ln -s $JABBER_HOME/bin/runjabber S99Jabber 7.
Installing Jabber XCP Developer Extensions • The Web Services API gives a wide range of external applications access to Jabber XCP server functions that are specific to instant messaging, roster/presence, and publish/subscribe capabilities. To install the Jabber XCP developer extensions 1. On your primary Jabber XCP server, change to the Jabber user. su - jabber Enter the Jabber user’s password. 3.
Starting the Jabber XCP Controller Starting the Jabber XCP Controller The Jabber XCP Controller is a web-based interface that is used to configure the Jabber XCP server. This section describes how to start the Controller and access it in a browser window. To start the Jabber XCP Controller Change to the $JABBER_HOME/bin directory. 2. At the command line, enter: ./runcontroller start 3.
Starting the Jabber XCP Controller Jabber XCP server, not its hostname. To make this error go away, either connect using the server’s IP address, or use a certificate for your hostname that is obtained from a trusted certificate authority. At the login prompt, enter the username and password for the Jabber XCP Controller Administrator (specified during installation), and click OK. 6. When the following window displays, click start the system now.
Cloning Jabber XCP Configurations Cloning Jabber XCP Configurations The Jabber XCP server provides a cloning feature, which allows you to duplicate your server configuration on multiple systems. This feature enables you to set up multiple Jabber XCP servers in much less time than would be required if you had to install and configure them manually. To clone your Jabber XCP server: Change to the Jabber user on the Jabber XCP server whose configuration you plan to clone: su - jabber 2.
Uninstalling Jabber XCP 10. Change to the $JABBER_HOME/support/config_clone directory. 11. Run the unclone script: ./unclone.sh [path_to_clone_file] For example: ./unclone.sh /tmp/clone-2007251104203.tgz To uninstall Jabber XCP, stop the server and the Controller, and remove the installation directory. Jabber, Inc. does not currently provide a utility for uninstalling individual components.
Appendix A. Install Packages and Options Install Packages To list the packages that are contained in an install script, execute the script followed by the --list option. For example: ./xcp-core-installer-5.2.2.x-OS.bin --list or ./xcp-developerextensions-5.2.2.x-OS.bin --list where OS is solaris8 or linux. Table 2.
Install Packages Package Description The Web control processor cyrus_sasl Cyrus SASL db_upgrade The database upgrade script (now named db_tool) eci LaunchBroker (formerly called External Command Interface) expat XML parsing library file_transfer_proxy File Transfer Proxy component http_binding HTTP Binding director jabber2 Core server jds2 Jabber Directory Suite jds2-schema_ updater The Jabber Directory Suite schema updater script jud Jabber User Directory krb5 Kerberos 5.
Install Packages Package Description wlservice Wait List Service component xcp_config Configuration Utility.
Install Options Install Options A number of install options are available, which give you more control over the installation. To list the options that are available for the installation scripts, execute the script followed by the --help option. For example: ./xcp-core-installer-5.2.2.x-OS.bin --help or where OS is solaris8 or linux. Table 3. Install options Option Description --prefix=path The location in which you want to install the Jabber server. The default location is /opt/jabber.
Appendix B. Jabber XCP Glossary authentication Authentication is the process used by the Jabber XCP server to ensure that a user is valid. Advanced File Transfer The Advanced File Transfer (AFT) feature uses HTTP to upload and download files that are being transferred from one user to another. All file transfer transactions are recorded in a Jabber-supported database. AFT is configured as a handler in the Web command processor.
components Components provide functionality that you can add to your Jabber XCP server. Most components are installed with the core Jabber XCP installation package; however, a few are installed only with the developer extensions package. When you install the core Jabber XCP server package, a Connection Manager and a basic Text Conferencing component are configured for you by default. Using the Controller, you can configure other components to provide additional functionality as needed.
gateway A gateway is a service that provides a bridge over the Internet between a Jabber XCP server and any non-Jabber service or network. HTTP director The HTTP director can be used for transferring files, for serving static web pages, for receiving HTTP Binding requests, and for receiving SOAP-over-HTTP requests from Web Services applications. The HTTP director is configured within a Web command processor.
Jabber entity A Jabber entity is any separate and distinct item that has a Jabber ID. Jabber entities include Jabber users, Jabber XCP servers, gateways, and services. Jabber ID A Jabber ID (JID) is used both externally and internally to express ownership or routing information. Jabber IDs are formed of a domain, node, and resource having the following format: user@host/resource.
JSM command processor The JSM command processor, configured within a Connection Manager component, handles the translation and transfer of data between IM clients and the core router. LaunchBroker The LaunchBroker component (previously called External Command Interface (ECI)) integrates with web conferencing services, such as WebExTM and Adobe® Acrobat® ConnectTM Professional. It allows Jabber client users to create online meetings and to send meeting invitations to contacts.
Presence Mirror The Presence Mirror component enables the storage of user presence information in a database on a near real-time basis. You must have a supported database to use this feature. The Presence Mirror is included in the developer extensions installation package. Router-to-Router connection The Router-to-Router connection allows a connection between two routers that are not in the same cluster or subnet. See Server-to-Server command processor.
optimize stanza traffic between Jabber XCP servers, thus providing a higher degree of scalability for large numbers of users. This feature allows a single stanza to be sent to multiple recipients rather than one stanza being sent per recipient, as was the case in previous versions of the server. Text Conferencing (TC) Text Conferencing allows multiple users to communicate with each other in online chat rooms.
XML XML, Extensible Markup Language, is a universal format for structured documents and data on the Web. The entire Jabber protocol is based on XML and XML Namespaces. The XML standard is being developed and maintained by the W3C (see http://www.w3.org/XML/). XML namespace XMPP XMPP, eXtensible Messaging and Presence Protocol, is the part of the Jabber XML Protocol that supports Instant Messaging functionality.
Index G Active Directory Server 12 Advanced File Transfer 35 authentication 35 gateway 37 gateways 5 glossary 35 C H client 35 clients supported by Jabber XCP 13 cloning Jabber XCP installations 29 command processor 35 community groups 35 components 36 Connection Manager 36 planning your deployment 14 running remotely 14, 24 Controller 36 starting 27 core router 36 core server downloading 17 installation 21 hardware requirements 10 HTTP Binding Director 37 binding handler 37 director 37 static handler
L LanuchBroker 39 LDAP 39 supported directory servers 12 license downloading 17 M Message Archiver 39 Microsoft Active Directory Server 12 Microsoft SQL 11 O offline messages 13, 39 OpenPort 39 operating system requirements 9 Oracle 11 P plugins 39 polling director 39 ports used by Jabber XCP 11 PostgreSQL 11, 13 preparing your system for installation 19 Presence Mirror 40 Jabber XCP Server Installation Guide R Red Hat Enterprise Linux 9 remote connection managers 24 Router-to-Router Connection 40 S S
X XML 42 namespace 42 XMPP 42 Extenstions (XEPS) 42 incoming server director 42 outgoing server director 42 XMPP director 42 Beta Version Only Jabber XCP Server Installation Guide Index Page 45
