Jabber XCP Server for Windowssupport.jabber.com/.../Server/5.4/ServerXCP_5.4_InstallGuideWin.pdf ·...

Jabber XCP Server for Windows

Installation Guide

Product: Jabber XCP 5.4Document Version: E

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.

Trademarks

JABBER® is a registered trademark and the light bulb logo is a trademark of Jabber, Inc.

AOL® and AIM® are registered trademarks and Instant MessengerTM is a trademark of America Online, Inc. Oracle® is a registered trademark of Oracle Corporation. IBM®, DB2®, and Sametime® are registered trademarks of IBM Corporation. Microsoft®, Active Directory®, Internet Explorer®, Windows®, Windows Server®, and LCS® are registered trademarks of Microsoft Corporation in the United States and other countries. Adobe® and Acrobat® are registered trademarks and ConnectTM is a trademark of Adobe Systems Incorporated. WebExTM is a trademark of WebEx Communications, Inc. All other trademarks are the property of their respective owners.

Contact Information

1899 Wynkoop Street, Suite 600 Denver, Colorado 80202 303-308-3231 [email protected]

Jabber XCP Server Installation Guide Page ii

Jabber XCP Server Installation Guide Table of Contents Page iii

Beta Version O

nly

Table of Contents

Chapter 1. Introduction .................................................................................................. 4Upgrade Checklist 4New Installation Checklist 5Related Documentation 6

Chapter 2. System Requirements................................................................................... 7Operating System Requirements 7Minimum Hardware Requirements 8Default Ports 8Supported Databases 9Supported Directory Servers 9Supported Clients 10SMTP Requirements 10SNMP Requirements 10

Chapter 3. Planning Your Connection Manager Deployment.................................. 11

Chapter 4. Downloading the Jabber XCP Server Software ...................................... 14

Chapter 5. Installing the Jabber XCP Server............................................................. 15Installing the Jabber XCP Core Server 16Performing a Silent Install 24Installing Jabber XCP Extras 25Installing Jabber XCP SDKs 27Starting the Jabber XCP Controller 30Setting Up FQDN 31Uninstalling Jabber XCP 31Installing Remote Connection Managers 33

Chapter 6. Upgrading the Jabber XCP Server........................................................... 34

Appendix A. Jabber XCP Glossary ............................................................................. 38

Beta Version O

nly

Chapter 1. Introduction

The Jabber XCP Server Installation Guide for Windows contains instructions for performing a new installation of Jabber XCP 5.4, and for upgrading to version 5.4 from Jabber XCP 5.2 SP1 and 5.2 SP2. It also provides information to help you plan your Jabber XCP server deployment.

If you are currently running a version of Jabber XCP that is earlier than 5.2 SP1, contact Jabber Support for help upgrading your system.

This chapter provides the following sections:

• Upgrade Checklist• New Installation Checklist• Related Documentation

Upgrade ChecklistReview the following checklist for a summary of the tasks that you need to perform.

Verify your system’s compatibility with the Jabber XCP server (see Chapter 2).

Download the Jabber XCP 5.4 server software (see Chapter 4).

Upgrade your Jabber XCP server (see Chapter 6).

Configure your Jabber XCP server as needed (see the Jabber XCP Server Configuration Guide).

Jabber XCP Server Installation Guide Introduction

New Installation ChecklistB

eta Version Only

New Installation ChecklistIf you are installing and setting up your Jabber XCP server for the first time, review the following checklist for a summary of the tasks that you need to perform.

Verify your system’s compatibility with the Jabber XCP server (see Chapter 2).

Plan your Connection Manager (CM) layout if you want to run remote CMs (see Chapter 3).

Download the Jabber XCP 5.4 server software (see Chapter 4).

Install the Jabber XCP core server package (see “Installing the Jabber XCP Core Server” on page 16).

If you want to use more advanced Jabber XCP features such as EventBroker, persistent Text Conference rooms, Presence Mirror, and Web Services, install the Jabber XCP extras (see “Installing Jabber XCP Extras” on page 25).

If you want to extend the functionality of the Jabber XCP server, install the Jabber XCP SDKs (see “Installing Jabber XCP SDKs” on page 27).

If you plan to use LDAP or Microsoft® Active Directory® for user authentication or for Jabber Community Groups, make sure that you have one of the Jabber-supported LDAP directory servers (see “Supported Directory Servers” on page 9).

Instructions for setting up the Jabber XCP server to work with LDAP and with Microsoft Active Directory are provided in the Jabber XCP Server Configuration Guide and in the online help.

If you plan to use Jabber XCP features such as persistent Text Conference rooms, Jabber User Directory, Message Archiver, Presence Mirror, SDNS, and InfoBroker, you must have one of the following databases: Oracle®, PostgreSQL, Microsoft® SQL®, or DB2® (see “Supported Databases” on page 9). If you use one of these databases, you must also set it up to store Jabber data (as described in the Jabber XCP Server for Windows Database Setup Guide).

Start the Jabber XCP controller and the server (see “Starting the Jabber XCP Controller” on page 30).

Configure your Jabber XCP server as needed (see the Jabber XCP Server Configuration Guide).


Related DocumentationB

eta Version Only

Related DocumentationYou can access Jabber product user documentation on the Jabber Support Web site at http://support.jabber.com. (After you have logged in, click the Documentation link in the left pane.) The following documentation pertains to this Jabber XCP server release:

• Jabber XCP Server Release Notes (Document Version D)

• Jabber XCP Server Installation Guide for Windows (Document Version E)

• Jabber XCP Server Database Setup Guide for Windows (Document Version D)

• Jabber XCP Server Configuration Guide (Document Version D)

• Jabber XCP Server Developer Guide (Document Version D)

• Libjcore SDK Tutorial (Document Version D)

• Text Conferencing SDK Tutorial (Document Version D)

• Web Services API Development Guide (Document Version D)

• Java LaunchBroker SDK Tutorial (Document Version D)

• Javajcore SDK Tutorial (Document Version D)

• 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.


Beta Version O

nly

Chapter 2. System Requirements

Your Jabber XCP server 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.

The following sections are provided:

• Operating System Requirements• Minimum Hardware Requirements• Supported Databases• Supported Directory Servers• Supported Clients• SMTP Requirements• SNMP Requirements

Operating System RequirementsJabber XCP 5.4 for Windows has been verified and is supported on the following operating systems:

• Microsoft Windows Server 2000• Microsoft Windows Server 2003

Jabber XCP Server Installation Guide System Requirements

Minimum Hardware RequirementsB

eta Version Only

Minimum Hardware RequirementsYour hardware configuration can have a significant impact on the number of concurrent users that your system handles.

The minimum system requirements for x86-compatible systems are:

• 1 GHz 32-bit (x86) or 64-bit (x64) processor• 1 GB system memory• 40 GB hard drive storage capacity

Your storage requirements may vary depending on which Jabber XCP features you use and on how many users you have.

Default PortsThe 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.

• Port 5269 must be accessible to the Internet if you want your Jabber XCP server to communicate with other Jabber servers over the Internet.

• Port 7300 is used by the Jabber XCP controller by default. You can select a different port during installation if preferred.

• Port 7400 is used as the Jabber XCP server’s Master Accept Port by default. You can select a different port during installation if preferred.

• Port 7302 is used by the controller’s WebCP OpenPort connection. This port is not configurable during installation.


Supported DatabasesB

eta Version Only

Supported DatabasesJabber XCP features such as persistent Text Conference rooms, Jabber User Directory, Message Archiver, Presence Mirror, SDNS, and InfoBroker require a robust database. The SQLite database, which is installed with the server by default, is useful only for storing user data.

If you are installing Jabber XCP for the first time, or are using a database that has never stored Jabber data, see the Jabber XCP Server Database Setup Guide for information about setting up your database to work with the Jabber XCP server.

Jabber-supported databases include:

• PostgreSQL 8.1 – This database must be configured to be SQL_ASCII.

• Oracle® 9i, Release 2; Oracle 10g, Release 2 – For either version of Oracle, you must install the Oracle 9 client libraries (9.2.0.8) on your Jabber XCP server.

• IBM® DB2® version 9.5

• Microsoft SQL Server 2005 SP1 and 2000 SP3

• SQLite3-3.2.2.0 – This database, which is included in the Jabber XCP server installation, is recommended only for installations that support fewer than 500 users.

The SQLite database should be stored on a local drive. Storing the database on a remote drive may cause corruption or loss of data when the file server or network fails. Using remote drives can also cause poor SQLite performance.

Supported Directory ServersJabber XCP supports the use of LDAP and Microsoft Active Directory (Microsoft’s version of LDAP) to store and search user registration, authentication, and vCard information, and to use the Community Group feature. (Community groups are collections of Jabber users that are created by an LDAP administrator to group like users together; for example, to group users who are in the same department.)

Jabber-supported directory servers include:

• Microsoft Active Directory® Server (ADS) as included with Windows® 2000 and 2003


Supported ClientsB

eta Version Only

• Sun JavaTM System Directory Server 5.2

• OpenLDAP 3.x and 2.2.x

See the Jabber XCP Server Configuration Guide for information about setting up your LDAP or Microsoft Active Directory server to work with the Jabber XCP server, and for configuring Community Groups.

Supported ClientsJabber XCP 5.4 has been verified to operate with and is supported for the following clients:

• Jabber MomentIM 5.2.1• Jabber Messenger for the Web 5.0.3 (njg67)

SMTP RequirementsIf 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.

SNMP RequirementsThe Simple Network Management Protocol (SNMP) is an application layer protocol that facilitates the exchange of management information between network devices. SNMP has been implemented on the Jabber XCP server to enable you to use standard SNMP tools to monitor the server. You can enable or disable the use of SNMP individually for each server component, including the core router.

For information about setting up SNMP, see the “SNMP” chapter in the Jabber XCP Server Configuration Guide.


Beta Version O

nly

Chapter 3. Planning Your Connection Manager Deployment

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. Distributing the CMs in this manner can increase the scalability, security, and performance of your Jabber XCP installation.

Instructions for installing remote CMs are provided on page 33 in this guide. Configuration instructions are provided in the “Connection Managers” chapter in the Jabber XCP Server Configuration Guide.

Figure 1 on page 13 illustrates the method that Jabber, Inc. recommends for configuring CMs remotely. This method involves installing the core Jabber XCP server on each remote system, and configuring a Router-to-Router connection on your primary server for each remote CM. Otherwise, the figure is only an example of how your remote CM configuration might look. In your environment, you may choose to run other types of CMs remotely.

In Figure 1, note the following in particular:

• The primary Jabber XCP server has the default setup that is provided during core server installation. This setup includes a Web CM (for accessing the controller), JSM and Logger plugins, and CM and Text Conferencing components. (If preferred, you can remove the default CM from the primary server’s configuration, and run all of your CMs remotely.)

• The core Jabber XCP server is installed on each remote system, the default Web CM, and one or more specialized CMs.

Jabber XCP Server Installation Guide Planning Your Connection Manager Deployment

Beta Version O

nly

• 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.

• Port 5222 must be open on the firewall between the DMZ and the Internet for incoming client connections, and port 5269 must be open bidirectionally if you are running an S2S CM.


Beta Version O

nly

Figure 1. Distributed Connection Managers

JabberSessionManager

TextConferencing

DMZPrimary Jabber XCP Server

CoreRouter

CoreRouter

Router andStats Logging

Firewall

7400/TCP

7300/TCP

Router-to-Routerconnection

Router-to-Routerconnection

Firewall

Client

5222/TCP

XMPP Server

5269/TCP

Web CM

WEBCP JSMCP

JSM CM

JSMCP

XMPP Director

JSM CM

JSMCP

XMPP Director

S2S CM

S2SCP

XMPP IncomingDirector

XMPP OutgoingDirector

Open Portconnection


CoreRouter


JSM CM

JSMCP

XMPP Director

Internet

HTTPDirector

HTTP BindingDirector

Web CM

WEBCP JSMCP

HTTPDirector

HTTP BindingDirectorWeb CM

WEBCP JSMCP

HTTPDirector

HTTP BindingDirector


Jabber XCP Server Installation Guide Downloading the Jabber XCP Server Software

Beta Version O

nly

Chapter 4. Downloading the Jabber XCP Server Software

Before you can install the Jabber XCP server, you must download the installer executables and the license file, which are available on your Web page on the Jabber Support site.

To download the Jabber XCP software and license1. Access the Jabber Support Web site 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 link for the Jabber XCP 5.4 core server package to begin the download.

5. Select a location on your server, and save the file.

6. In the same way, download any other packages that you have purchased.

7. Download the Jabber XCP license file. You will be asked for the location of the license when you install the Jabber XCP Core server package.

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 set up and run a new Jabber XCP system. The Extras and SDK packages are optional, and contain advanced features and special SDK components that enable software developers to extend the functionality of the Jabber XCP server.

Beta Version O

nly

Chapter 5. Installing the Jabber XCP Server

This chapter provides instructions for installing the Jabber XCP 5.4 server. Before you can install the server, make sure that you have downloaded the installer executable files and the license file as described in Chapter 4, “Downloading the Jabber XCP Server Software”.

If you are upgrading your server from a previous installation, see Chapter 6 for instructions.

You must be logged into your Windows system as an administrator to install the Jabber XCP server.

The following sections are provided:

• Installing the Jabber XCP Core Server• Performing a Silent Install• Installing Jabber XCP Extras• Installing Jabber XCP SDKs• Starting the Jabber XCP Controller• Setting Up FQDN• Uninstalling Jabber XCP• Installing Remote Connection Managers

Jabber XCP Server Installation Guide Installing the Jabber XCP Server

Installing the Jabber XCP Core ServerB

eta Version Only

Installing the Jabber XCP Core ServerRequired: You must install the core server package on your primary Jabber XCP server, even if you plan to distribute your installation by running selected components on remote servers. Make sure that the computer on which you install the Jabber XCP server has a static IP address.

The components that install with the core Jabber XCP server are described in the following table.

Component Type of Install Description

Jabber XCP Required Components

Jabber Server (Jabberd)

Full Minimal

The core server, which acts as router and manages the user sessions.

Jabber Session Manager (JSM)

Full Minimal

Controls all sessions on the Jabber XCP Server.

Connection Manager (CM)

Full Minimal

Manages client connections and interacts with the core router.

Text Conferencing (TC)

Full Minimal

Enables multi-user conversations in online conference rooms.

Other Components

Jabber Directory Service (JDS-LDAP)

Full Minimal

Connects Jabber XCP with LDAP and ADS directory services. If you install the JDS component, you must update your LDAP schema.

Polling Director Full Minimal

Uses HTTP to communicate over firewalls using port 80 and handles communication with other Jabber instant messaging clients.

HTTP Binding Director

Full Minimal

Allows Jabber IM users to access the Jabber XCP server through restricted firewalls.

External Command Interface (LaunchBroker)

Full Integrates with the WebEx application and allows Jabber client users to create WebEx meetings and to send meeting invitations to contacts.

File Transfer Proxy

Full Enables server-based file transfer capabilities via a SOCKS5 Bytestreams proxy.



eta Version Only

To install the Jabber XCP core server1. Log into your Windows system as an administrator.

2. Make sure that you have downloaded both the core server installer file and the licence file to the server’s hard drive. You will be asked for the location of the license.xml file during the installation.

3. Double-click core server installer file to begin the installation. (If you see a security warning, ignore it, and continue with the installation.)

Jabber User Directory (JUD)

Full Creates a directory of all users who register on your server. Your Jabber users can search for other users by first name, last name, nickname, and email address. The JUD component requires the use of either a PostgreSQL or Oracle database.

Message Archiver Full Stores all messages sent through the system into a database.

Server to Server (S2S)

Full Enables Jabber XCP Servers to communicate with each other across domains, and supports the Jabber dialback protocol, which determines whether or not to trust a connection from another server.

Single Domain Name Support

Full Provides a method of distributing the load for a single domain over multiple, equivalent components (e.g., multiple JSM components).

Stanza Optimizer Full Implements Extended Stanza Addressing (described in JEP-33). You can configure the Stanza Optimizer to work in conjunction with the InfoBroker and Text Conferencing components in order to optimize stanza traffic between Jabber XCP servers, thus providing a higher degree of scalability for large numbers of users.

Wait List Service Full Allows Jabber IM users to place a contact on a waiting list by specifying information about the contact (such as a telephone number or an email address) and to be notified when that contact creates an IM account.

Upgrade Tools Full Provides the programs and scripts to allow migration to Jabber XCP 5.4.

Advanced File Transfer (AFT)

Full Allows Jabber IM users to transfer files via HTTP.

Component Type of Install Description



eta Version Only

The Choose Install Location dialog box is displayed.

4. Select a location in which to install the Jabber XCP server. By default, the server installs into C:\Program Files\Jabber Inc\Jabber XCP.

5. Click Next.

The Choose Components dialog box is displayed.

6. Select the preferred type of installation from the drop-down list. You can choose Full, Minimal, or Custom. The components that will install are selected automatically in the list according to the type of installation you choose. If you choose the Custom installation, all components are selected, and you can unselect the ones that you do not want to install.



eta Version Only

7. Click Next. The Configuration dialog box is displayed.

8. By default, the Configuration dialog box contains the IP address of the computer on which you are installing the Jabber XCP server, and the ports 7300 and 7400 for the controller and the Master Accept Port respectively. Do the following:

a. Enter the fully qualified domain name (FQDN) of the Windows-based server. The FQDN must be resolvable via DNS.

b. Make sure that the IP Address of the Jabber XCP server is a static IP address.

c. Review the default settings for the Jabber XCP controller port and the Master Accept Port. You can change these port numbers if preferred.

d. Click Next.

The following Configuration dialog box is displayed.



eta Version Only

9. The Configuration dialog box contains the default realm, “jabber”, a randomly-generated cluster name, and a randomly-generated component password. Do the following:

a. Enter the Realm name for this Jabber XCP installation. The realm identifies the router and all of its components. The realm must be unique within the same subnet.

b. Enter the Cluster name in which this router participates. All of the Jabber XCP routers that will interact must have the same cluster name.

c. Enter a Component Secret (a password) that will be used by all Jabber XCP components for authentication and communication between components.

d. Click Next.


10. The Configuration dialog box contains startup options for the controller and for the Jabber XCP server. Do the following:

a. Select Manual or Automatic for the type of startup you prefer.

b. Click Next.



eta Version Only


11. The Configuration dialog box contains the default login name of the controller administrator, “jabber”. Do the following:

a. Accept the default login name or enter another one.

b. Enter the administrator password, then enter it again to confirm it.

c. Click Next.




eta Version Only

12. The Configuration dialog box contains the location of the evaluation licence file, eval-license.xml. Do the following:

a. Browse to the location of your license file, and double-click the file to select it.

b. Click Next.

The Review Settings dialog box is displayed.

13. In the Review Settings dialog box, you can review all of your installation choices before initiating the install. Do the following:

a. Verify that your installation settings are correct.

b. If they are incorrect, click Back to change them as needed; otherwise, click Install.

When you click Install, the following dialog box shows the progress of the installation.



eta Version Only

14. When the installation completes, click Next.

The following dialog box is displayed.

15. In the dialog box shown previously, both options are selected by default. Do the following:

a. Clear the check boxes, or one or both options if preferred.

If you plan to install the Jabber XCP extras, clear the checkbox beside Start and display Jabber XCP controller. The controller must not be running when you install the extras.

b. Click Finish.


Performing a Silent InstallB

eta Version Only

Performing a Silent InstallYou can install the Jabber XCP Server for Windows from a command prompt if preferred. The silent method installs the server in C:\Program Files\Jabber Inc\Jabber XCP.

To perform a silent install1. Log into your Windows system as an administrator.

2. Open a command window.

3. Change to the directory where you downloaded the Jabber XCP install executables.

4. Enter a command like the following using the same order for the arguments:C:\>xcp-core-installer-5.4.x.x-windows.exe /S /HOSTNAME=example.com/CLUSTER=cluster /SECRET=secret /ADMIN=jabber /PASSWORD=jabber/LICENSE=C:\license.xml /REALM=jabber

The arguments are described as follows:

Argument Description

/S Indicates that this is a silent install.

/HOSTNAME The host name of the machine on which you are installing Jabber XCP.

/CLUSTER The name of the cluster. If you are installing a router-to-router configuration, make sure this value is the same for all of the routers in the cluster.

/SECRET The password that components will use to authenticate with the router. This value can be any random string.

/ADMIN The name of the Jabber administrator.

/PASSWORD The Jabber administrator’s password.

/LICENSE The full path to the Jabber XCP license file, license.xml.

/REALM The name of the realm.


Installing Jabber XCP ExtrasB

eta Version Only

Installing Jabber XCP ExtrasOptional: Install the Jabber XCP extras only if you want to use the extra features they provide. The extras package must be installed in the same location as your Jabber XCP 5.4 core server.

The Jabber XCP extras installation package contains more advanced features, described in the following table.

To install the Jabber XCP extras1. Log into your Windows system as an administrator.

2. Make sure that you have downloaded the extras install executable to the server’s hard drive.

3. Stop the Jabber XCP server and the controller if they are running. To do this, open Control Panel > Administrative Tools > Services, and stop the Jabber XCP controller and the Jabber XCP Server services.

4. Double-click the extras executable to start the installation. (If you see a security warning, ignore it, and continue with the installation.)

Component Description

EventBroker Allows you to redirect packets from TC and JSM to a custom external component.

InfoBroker Allows you to organize different types of information into categories that are accessible by a custom application’s users.

Persistent TC rooms

Allows you to configure persistent conference rooms in the Text Conferencing component.

Presence Mirror Enables you to store the current presence of all users on the system in a PostgreSQL or an Oracle database.

Web Services Enables Web Services applications and custom components to access and use the Jabber XCP services messaging, roster/presence, and InfoBroker.


Installing Jabber XCP ExtrasB

eta Version Only


5. Select the location in which you installed the Jabber XCP core software, and then click Next.


6. In the Configuration dialog box, enter the controller administrator’s login name and password. You must specify the same name and password you used when you installed the core server.

7. Click Install.


Installing Jabber XCP SDKsB

eta Version Only

8. When the installation completes, the following dialog box is displayed. Click Finish.

Installing Jabber XCP SDKsOptional: Install the Jabber XCP SDKs if you want to extend the functionality of the server. The SDK package must be installed in the same location as your Jabber XCP 5.4 core server.

The Jabber XCP SDK installation package contains software development kits that allow you to extend the functionality of the server. They include:

• The Libjcore SDK contains the core Jabber XCP libraries, and enables you to write custom C++-based components that integrate with the Jabber XCP router.

• The Javajcore SDK contains the core Jabber XCP libraries, and enables you to write custom, Java-based components that integrate with the Jabber XCP router.

• The Java LaunchBroker SDK enables you to write a custom Java-based command that integrates with the Jabber XCP server’s LaunchBroker feature.

• The Text Conferencing SDK enables you to write your own custom gears to expand the functionality of the Text Conferencing component.

• 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.



eta Version Only

To install the Jabber XCP SDKs1. Log into your Windows system as an administrator.

2. Make sure that you have downloaded the SDK installation file to the server’s hard drive.


4. Double-click the SDK install file to start the installation. (If you see a security warning, ignore it, and continue with the installation.)


5. Select the location in which you installed the Jabber XCP core software, and then click Install.



eta Version Only

The following dialog box is displayed while the SDKs are installing.

6. When the installation completes, the following dialog box is displayed. Click Finish.


Starting the Jabber XCP ControllerB

eta Version Only

Starting the Jabber XCP ControllerThe Jabber XCP controller is the 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 controller1. Select Start > All Programs > Jabber XCP > Start XCP Controller Service. (You

can also start the Jabber XCP controller service in the Services control panel.)

2. Once you have started the controller, open a Web browser, and enter the following URL:https://[xcp_server_fqdn]:[xcp_controller_port]/admin

For example:https://xcp.example.com:7300/admin

The server’s FQDN and the controller port were specified during installation. The default controller port is 7300.

3. If you see a message telling you there is a problem with the website’s security certificate, continue. This message is displayed because you are connecting via SSL, and the certificate is being signed by Jabber, Inc., which is not a certificate authority.

4. At the login prompt, enter the username and the password for the Jabber XCP controller’s administrator (specified during installation), and click OK.


Setting Up FQDNB

eta Version Only

5. When you see the following page, click start the system now.

Setting Up FQDNRecommended: Jabber users should be able to connect to the Jabber XCP server using its FQDN.

We recommend that you ensure that your Jabber users can connect to your Jabber XCP server by specifying the fully qualified domain name (FQDN) of the system where the server is running.

During installation, you must enter the hostname of the Jabber XCP server; for example, jabber.example.com.

Uninstalling Jabber XCPThe following instructions describe how to remove the Jabber XCP server from your Microsoft Windows system.

To remove the Jabber XCP server1. Stop the Jabber XCP server and the controller.

2. Make sure that no associated files are open (such as an XML file opened using XML Spy).

3. Select Start > All Programs > Jabber XCP > Uninstall. The following dialog box is displayed. If you have more than one instance of Jabber XCP installed, select the location of the one you want to remove.


Uninstalling Jabber XCPB

eta Version Only

4. Click Uninstall.

5. When the Uninstallation Complete dialog box is displayed, click Close.


Installing Remote Connection ManagersB

eta Version Only

Installing Remote Connection ManagersOptional: You can install and run Connection Managers (CMs) on systems that are remote from the primary Jabber XCP server. This type of deployment can increase the scalability, security, and performance of your Jabber XCP environment.

To install a remote CM1. Install the Jabber XCP core server on the remote system as described on page 16.

2. Configure the remote CM using the instructions provided in the “Connection Managers” chapter in the Jabber XCP Server Configuration Guide.


Beta Version O

nly

Chapter 6. Upgrading the Jabber XCP Server

This chapter provides instructions for upgrading your Jabber XCP server to version 5.4 from versions 5.2 SP1 and 5.2 SP2.

If you are currently running a version of Jabber XCP that is earlier than 5.2 SP1, contact Jabber Support for help upgrading your system.

If you need to upgrade the Jabber XCP 5.2 developer extensions, contact Jabber Support.

To upgrade the Jabber XCP core server1. Back up your database.

2. Log into your Jabber XCP for Windows system as an administrator.

3. Make sure that you have downloaded both the core server installer file and the license.xml file to your Jabber XCP server’s hard drive. You will be asked for the location of the license file during the installation.


5. Double-click the core server installer file. If you see a security warning, ignore it, and continue with the installation.

6. At the following prompt, click Yes.

Jabber XCP Server Installation Guide Upgrading the Jabber XCP Server

Beta Version O

nly

7. When you are asked where you want to install Jabber XCP, specify a directory that is different from the location where your current installation resides. For example:C:\Program Files\Jabber Inc\Jabber XCP 5.4

8. Follow the remaining prompts in the Install Wizard to complete the core installation. If you need more detailed information, instructions are provided in Chapter 5, “Installing the Jabber XCP Server”.

9. Change to the xcpInstallDir\bin directory, and execute the following command:xcp_upgrade.exe -c "[path_to_old_XCP_install_dir]\etc\jabber.xml" --installer-name [installer_name]

For example:xcp_upgrade.exe -c "C:\Program Files\Jabber Inc\Jabber XCP 5.2\etc\jabber.xml" --installer-name xcp-core-installer

Make sure to enclose the path in double quotes, since it contains spaces.

10. Optionally, copy the var and certs directories from your previous Jabber XCP install location into your new Jabber XCP install directory. This is necessary only if you are using any of the following:

− The SQLite database in JSM− The Advanced File Transfer feature− Any non-default certificates

11. Open a command window, and change to the xcpInstallDir\bin directory.

12. Run the db_tool command to create or upgrade your database tables.

Make sure that you have backed up your database before running the db_tool command.

The syntax of the command is shown here:db_tool [datasource] [DB_user] [DB_password]

[mssql | oracle-oci | postgres-odbc | db2] [pretend | new | upgrade] [oracle_tablespace]

The db_tool script options are described as follows:

Option Description

datasource The datasource name. For PostgreSQL, the datasource is specified at the top of the .odbc.ini file in square brackets; for example, [xcp_pg]. For Oracle, the datasource is specified in the ORACLE_SID environment variable or in the tsnames.ora file. For DB2, the datasource is typically the database alias.

DB_user The database username.


Beta Version O

nly

13. Change to the xcpInstallDir\schemas\sql directory.

14. Run one of the following commands (depending on your database) from within your database manager to perform required data-definition operations. The commands are listed here:postDBtool_mssql.sql

postDBtool_oracle.sql

postDBtool_db2.sql

postDBtool_postgres.sql

For example, if you are using the Microsoft SQL Server database, run the postDBTool_mssql.sql command from within the SQL Server Manager as follows:

a. Select the database against which you want to run the command.

b. Select SQL Profiler in the Tools menu.

c. Select File > Open > SQL Script.

d. Click Start Replay, and select the username that is associated with only that database.

When you run postDBTool_mssql.sql, you must be logged into the database with the same user information that you supplied when you ran the db_tool utility.

DB_password The database password.

database type The type of database you are using. You can use any of the following values:• mssql• oracle-oci• postgresql-odbc• db2

pretend Displays the amount of time that will be required to perform the new or upgrade operation. (Running db_tool with this argument is optional, although recommended.) The output lists the database tables that will be created or upgraded, how long it will take, and the temporary diskspace required in the directory in which you are running db_tool. It also lists tables that do not need to be upgraded.

new Creates new database tables. Use this argument if you are using a database that has never been set up for Jabber XCP.

upgrade Updates your database tables with any database changes made in the current release of the Jabber XCP server. Use this argument if you are upgrading a database that has already been used for Jabber XCP.

oracle_ tablespace The Oracle tablespace name, used only for the Oracle database.

Option Description


Beta Version O

nly

15. Start the Jabber XCP controller and the server as described on “Starting the Jabber XCP Controller” on page 30.


Beta Version O

nly

Appendix A. Jabber XCP Glossary

This appendix contains terms that are used throughout the Jabber XCP server documentation and in the controller.

authenticationAuthentication is the process used by the Jabber XCP server to ensure that a user is valid.

Advanced File TransferThe 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.

clientA client is an instant messaging (IM) application that is used to communicate with the Jabber XCP server for the purpose of participating in chat sessions.

command processorA command processor (CP) is a component that is configured within every Connection Manager (CM) to enable the CM to perform specific tasks. Currently, the command processors that you can configure include the JSMCP, the SMTPCP, the S2SCP, and the WebCP.

community groupsCommunity groups are LDAP-based groups of Jabber users, and must be configured through the Jabber Directory Suite component.

Jabber XCP Server Installation Guide

Beta Version O

nly

componentsComponents 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.

Connection Manager (CM)The Connection Manager component enables clients and other servers to connect to the Jabber XCP server. The default CM is configured with a JSM command processor, which enables clients to connect to the server. You can configure additional CMs to enable different types of connections or to scale the system to accept more connections. You may also choose to install CMs on external servers to improve performance.

ControllerThe controller is the Web-based interface used to configure the Jabber XCP server.

core routerThe core router is the Jabber XCP router, and is listed under Plugins in the Router area on the controller’s main screen. You can edit the core router’s configuration settings to set global parameters that affect your entire Jabber XCP system.

EventBrokerThe EventBroker allows you to redirect packets from the Jabber Session Manager and from the Text Conferencing component to custom external components that are written in any programming language. After processing the packets, the custom component can send responses back to the JSM and to the TC component if needed.

File Transfer ProxyThe File Transfer Proxy component allows you to enable server-based file transfer capabilities via a XEP-65: SOCKS5 Bytestreams proxy. The component acts as a SOCKS5 proxy server, and allows byte streams to be transferred between two Jabber clients.

Fully Qualified Domain Name (FQDN)A fully qualified domain name consists of a host and domain name, including the top-level domain. For example, www.jabber.com is a fully qualified domain name where “www” is the host, “jabber” is the second-level domain, and “.com” is the top-level domain. FQDNs are used to locate machines on networks.


Beta Version O

nly

gatewayA gateway is a service that provides a bridge over the Internet between a Jabber XCP server and any non-Jabber service or network.

HTTP directorThe 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.

HTTP binding directorThe HTTP binding director works in conjunction with the HTTP Binding Handler (configured within a Web command processor) to support XMPP over HTTP, allowing access to the Jabber XCP server through restricted firewalls. The HTTP binding director is configured within a JSM command processor.

HTTP binding handlerThe HTTP binding handler looks for traffic coming into the Jabber XCP core router over a specific URL. This handler works in conjunction with the HTTP binding director. The HTTP binding handler is configured within a Web command processor.

HTTP static handlerThe HTTP static handler serves static files to any HTTP client. This feature is configured within a Web command processor.

InfoBrokerThe InfoBroker component provides the capability for customers to create applications through which users can publish, subscribe to, and access information that is organized by meaningful categories. The InfoBroker is included in the developer extensions installation package.

Info/Query (IQ)In the Jabber protocol, Info/Query is a data structure that is used to obtain information about a Jabber Entity or to set information for an entity.

Instant Messaging (IM)Instant messaging is a term that refers to text-based conversations that occur in real time.

jabberdjabberd, short for Jabber Daemon (in Unix terminology), is the main process in which the Jabber XCP server runs.


Beta Version O

nly

Jabber entityA 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 IDA 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.

Jabberd LoggerThe Jabberd Logger is listed under Plugins in the Router area on the controller’s main screen. The Jabberd Logger receives packets from the core router and then logs these packets to syslog or stderr.

Jabber Directory Suite (JDS)The Jabber Directory Suite component provides an interface between the Jabber XCP server and version 3-compliant LDAP or Active Directory Services (ADS). It handles authentication, and enables the retrieval of vCard information and the use of Community Groups. If you prefer not to use JDS and LDAP, you can use the Jabber User Directory for your user search directory.

Jabber Session Manager (JSM)The Jabber Session Manager is listed under Plugins in the Router area on the controller’s main screen. It handles real-time messaging functionality, and contains state information about every client that sends a packet through the core router.

Jabber User Directory (JUD)The Jabber User Directory component provides a searchable user directory for all users who register with the Jabber XCP server. The JUD requires a Jabber-supported database for user searches. (The JUD is commonly used for a user search directory when JDS with LDAP is not being used.)

Jabber XCP serverThe Jabber XCP server is the software that connects and communicates with other Jabber clients and servers. All communications for a client are directed to the server and then passed to the client.

Java LaunchBrokerThe Java LaunchBroker component (previously called the Java External Command Interface (JECI)) performs the same function as the LaunchBroker component, but allows custom commands to be written in Java. As with LaunchBroker, these commands must comply with XEP-50: Ad-Hoc Commands.


Beta Version O

nly

JSM command processorThe JSM command processor, configured within a Connection Manager component, handles the translation and transfer of data between IM clients and the core router.

LaunchBrokerThe 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. The LaunchBroker also allows you to add your own custom XEP-0050 Ad-Hoc Commands.

LDAPLDAP, Lightweight Directory Access Protocol, is a networking protocol that is used for querying and modifying directory services that are running over TCP/IP (see http://en.wikipedia.org/wiki/Lightweight_Directory_Access_Protocol for more information). Through the Jabber Directory Suite component, you can configure your LDAP directory server to perform user authentication and search. You can also configure Community Groups.

Message ArchiverThe Message Archiver component logs all messages sent to and from the server, including basic IM, Text Conferencing, and broadcast messages. You must have a Jabber-supported database to use this feature.

Offline messageAn offline message is an IM message that is sent to a Jabber user who is offline. These messages can be redirected to an email server using a Connection Manager configured with an SMTP command processor.

OpenPortThe OpenPort allows you to configure a custom component with a non-validated configuration, a component from the Open Source community, or a component that is used for testing purposes. It also allows you to associate a host filter with a component that connects to the Master Accept Port.

pluginsPlugins are integral parts of the Jabber XCP core router that start automatically when you start the Jabber XCP server. The Core Router, Jabberd Logger, and JSM plugins are configured for you by default when you install the server.

Polling directorThe Polling director handles communication with Jabber IM clients that need to use HTTP to communicate through firewalls over port 80. The Polling director is configured within a JSM command processor.


Beta Version O

nly

Presence MirrorThe 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 connectionThe Router-to-Router connection allows a connection between two routers that are not in the same cluster or subnet.

S2S command processorSee Server-to-Server command processor.

Secure Socket Layer (SSL)SSL is a TCP/IP standard for supporting encryption at the socket communication layer.

Server-to-Server (S2S) command processorThe Server-to-Server command processor, configured within a Connection Manager component, allows Jabber XCP servers to communicate with each other across domains.

Single Domain Name Support (SDNS)The Single Domain Name Support component provides a means of distributing the load for a single Jabber domain over multiple components. For example, if you want users who are connecting to routers A and B to participate in Text Conference rooms on either router, you must configure an SDNS component on both routers. The services that you can configure for SDNS include JSM, InfoBroker, and Text Conferencing.

The SDNS plugin uses the SDNS component’s default settings, and is used for specific implementations in which packet ‘to’ and ‘from’ addresses are required. For example, this plugin can be used for SDNS implementations that use JSM, Text Conferencing, or SIP gateways; however, it cannot be used with the InfoBroker (as can the SDNS component).

SMTP command processorThe SMTP (Simple Mail Transfer Protocol) command processor, configured within a Connection Manager component, redirects IM messages that are sent to offline users to an email server. The users then receive the messages via email.

Stanza OptimizerThe Stanza Optimizer component implements Extended Stanza Addressing (described in detail in XEP-33). You can configure the Stanza Optimizer to work in conjunction with the InfoBroker and Text Conferencing components in order to


Beta Version O

nly

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. The TC component that is set up by default during installation is configured to allow basic conferencing functionality using ad-hoc rooms. You can configure many other TC features, including persistent conference rooms, which remain on your server until they are deleted.

vCardvCards automate the exchange of personal information typically found on a traditional business card.

Wait List ServiceThe Wait List Service component allows Jabber users to place a contact on a waiting list by specifying information about the contact (such as a telephone number or an email address) and to be notified when that contact creates an IM account. (For more information, see XEP-130.)

Web command processorThe Web command processor, configured within a Connection Manager component, handles HTTP requests, and translates and transfers data between clients and the Jabber XCP core router over the Web. This command processor is installed with the Web Services component, which is included in the Jabber XCP developer extensions installation package.

Web ServicesThe Web Services component provides the capability for customers to create applications and custom components that use Messaging, Router/Presence, and InfoBroker services. The Web Services component is included in the developer extensions installation package.

Web services handlerThe Web services handler is configured within a Web command processor. It allows users to access XCP services using SOAP over HTTP, and configures a Uniform Resource Indicator (URI) path, over which messages are sent from Web Services applications to the handler via HTTP. The handler performs HTTP basic authentication and, if passed, forwards the message to the Web Services component.


Beta Version O

nly

XMLXML, 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 namespaceAn XML namespace provides a simple method for qualifying element and attribute names used in XML documents by associating them with namespaces identified by a URI reference. The XML Namespace specification is currently a recommendation with the W3C (see http://www.w3.org/TR/1999/REC-xml-names-19990114/).

XMPPXMPP, eXtensible Messaging and Presence Protocol, is the part of the Jabber XML Protocol that supports Instant Messaging functionality.

XMPP directorThe XMPP director handles communication between the core router and Jabber IM clients. It is configured within a JSM command processor in a Connection Manager.

XMPP Extensions (XEPs)The Jabber Software Foundation (JSF) develops extensions to XMPP through a standards process centered around XMPP Extension Protocols (XEPs). The process is managed by the XMPP Extensions Editor and involves intensive discussion on the Standards-JIG mailing list, formal review and voting by the XMPP Council, and modification based on implementation experience and interoperability testing. See (http://www.xmpp.org/extensions/) for a list of all XEPs (formerly known as JEPs).

XMPP incoming server directorThe XMPP incoming server director handles packets being sent to the router from remote servers. It is configured within an S2S command processor.

XMPP outgoing server directorThe XMPP outgoing server director handles packets being sent from the router to remote servers. It is configured within an S2S command processor.


Beta Version O

nly

Index

AActive Directory Server 9Advanced File Transfer 38authentication 38

Cclient 38clients

supported by Jabber XCP 10command processor 38community groups 38components 39Connection Manager 39

planning your deployment 11running remotely 11, 33

Controllerstarting 30

controller 39core router 39core server

downloading 14

Ddatabases

supported by Jabber XCP 9DB2 9developer extensions

downloading 14directory servers

supported by Jabber XCP 9documentation 6

EEventBroker 39extras

installing 25, 27

FFile Transfer Proxy 39FQDN 39fully qualified domain name 39

Ggateway 40glossary 38

Hhardware requirements 8HTTP

Binding Director 40binding handler 40director 40static handler 40

IInfoBroker 40installation

checklist 5installing

extras 25, 27remote connection managers 33

JJabber Directory Suite 41Jabber ID 41Jabber Session Manager 41Jabber User Directory 41Jabber XCP

Controller 30core router 39default ports 8downloading the software and license 14glossary 38installing

extras 25, 27remote connection managers 33

new installation checklist 5related documentation 6supported clients 10supported databases 9supported directory servers 9system requirements 7upgrading 34

jabberd 40Jabberd Logger 41Java LaunchBroker 41JSM 41

command processor 42

LLanuchBroker 42LDAP 42

supported directory servers 9

Jabber XCP Server Installation Guide Index

Beta Version O

nly

licensedownloading 14

MMessage Archiver 42Microsoft Active Directory Server 9Microsoft SQL 9Microsoft Windows Server 7

Ooffline messages 10, 42OpenPort 42Oracle 9

Pplugins 42polling director 42ports used by Jabber XCP 8PostgreSQL 9, 10Presence Mirror 43

Rremote connection managers 33Router-to-Router Connection 43

SSecure Socket Layer 43Server-to-server 43Single Domain Name Support 43SMTP

command processor 43requirements 10

SNMP requirements 10

SQLite 9Stanza Optimizer 43system requirements

clients 10databases 9directory servers 9minimum hardware 8SMTP 10SNMP 10

TText Conferencing 44

Uupgrading the Jabber XCP server 34

VvCards 44

WWait List Service 44Web command processor 44Web Services 44Web services handler 44

XXML 45

namespace 45XMPP 45

Extensions (XEPS) 45incoming server director 45outgoing server director 45

XMPP director 45

Jabber XCP Server Installation Guide Index

Jabber XCP Server for Windowssupport.jabber.com/.../Server/5.4/ServerXCP_5.4_InstallGuideWin.pdf ·...

Documents

Transcript of Jabber XCP Server for Windowssupport.jabber.com/.../Server/5.4/ServerXCP_5.4_InstallGuideWin.pdf ·...