Preparing for Installation

This chapter contains the following sections to help you prepare to install Instant Messaging :


Note	For the most recent information about this release of Sun ONE Instant Messaging, see the Instant Messaging Release Notes.

Instant Messaging Installation Overview

Whether you install Sun ONE Instant Messaging in the Sun ONE Portal Server environment or as a standalone server, you can configure Instant Messaging according to the requirements of your site. See the Sun ONE Instant Messaging Administrator’s Guide for more information on configuring Sun ONE Instant Messaging.

Installing Instant Messaging with Sun ONE Portal Server

The steps involved in installing Instant Messaging in the Sun ONE Portal Server environment are:


Note	The deployment of Sun ONE Instant Messaging with Sun ONE Portal Server is supported only on the Solaris platform.


Note	You need to install the Portal Server, directory server (optional), and the SMTP server before installing Sun ONE Instant Messaging.

When the Instant Messaging is installed with the Sun ONE Portal Server, users can invoke the Sun ONE Instant Messenger from their Sun ONE Portal Server Desktop. Sun ONE Instant Messenger leverages the Sun ONE Portal Server, Secure Remote Access to provide secure access. In the secure mode, communication between the Sun ONE Instant Messenger and Sun ONE Instant Messaging Multiplexor is encrypted through the Sun ONE Portal Server Netlet. A lock icon appears in the Sun ONE Instant Messenger’s Status area to indicate that you are running Sun ONE Instant Messenger in a secure mode. See the Sun ONE Portal Server, Secure Remote Access Administrator’s Guide for more information on Netlet.

Installing Instant Messaging as a Standalone Server

When Instant Messaging is installed in a standalone environment, the users can invoke Sun ONE Instant Messenger through a URL from the web browser.


Note	You can configure the Sun ONE Instant Messenger for secure mode only if the Sun ONE Portal Server, Secure Remote Access is installed.


Note	You need to install the LDAP directory server, and the SMTP server before installing Sun ONE Instant Messaging.

Sun ONE Portal Server System Requirements

Before you install Sun ONE Portal Server, you should verify that the systems on which you need to install the software meet the minimum product requirements. For the most recent information on the product requirements, see the Sun ONE Portal Server Release Notes at:


Note	The deployment of Sun ONE Instant Messaging with Sun ONE Portal Server is supported only on the Solaris platform.

Sun ONE Instant Messaging System Requirements

Before you install the Sun ONE Instant Messaging Server, you should verify that the systems on which you plan to install the software meet the minimum product requirements. For more information on the supported platforms, software and hardware requirements, see the Sun ONE Instant Messaging Release Notes at:

Instant Messaging Installation Privileges

To install Instant Messaging, log in as a superuser. For example, root (UNIX) or administrator (Windows).

Gathering the Installation Information

Sun ONE Instant Messaging requires the following to be installed for a portal deployment:

Sun ONE Instant Messaging requires the following to be installed for a standalone deployment:

While installing Sun ONE Instant Messaging, you will be required to specify certain basic configuration information.

Table 1-1 lists the configuration information to be considered and made note of before installing and configuring Sun ONE Instant Messaging. This table contains the installation parameters, their description and possible values. Complete the following check list before installing the software.

Table 1-1 Sun ONE Instant Messaging Installation Checklist
Parameter	Description	Value
Base Directory	Select Install Directory.	Enter the name and path of the directory in which you want the Instant Messaging to be installed. The following are the default values: On UNIX: /opt On Windows: c:\Program Files\Sun\InstantMessaging
Instant Messaging Server Hostname and logical instant messaging Domain Name	Instant Messaging Services Configuration.	Enter the host and domain name. For example, budgie.siroe.com Host Name: budgie.siroe.com Domain Name: siroe.com
IM Server Port	Instant Messaging Services Configuration.	Enter the instant messaging server port number. For example, 49999.
Multiplexor port	Instant Messaging Services Configuration.	Enter the Instant Messenger (client) port number. For example, 49909.
Remote IM Server Host name	Instant Messaging Server configuration.	Enter the remote server host name that the local multiplexor will use. Enter a value for this parameter only if you have enabled the “multiplexor only” option. Otherwise you do not have to enter a remote server host name.
Assign IM Services to existing users	Assign IM Services to Existing Users.	Select this check box to assign the Instant Messaging services to the existing Identity Server users.
Secure Mode	To enable integration with Sun ONE Portal Server Secure Remote Access	Select this check box to enable Instant Messaging in the secure mode. This parameter is required, if you are installing “Sun ONE Portal Server IM Channel and Archive” component and want to enable Instant Messaging in secure mode. Note: You can run Sun ONE Instant Messenger in the secure mode only if Sun ONE Portal Server, Secure Remote Access is configured.
Deploy Messenger Resources in Portal Web Container	IM Channel and Archive Options.	Select this check box to download the Instant Messenger resources from the Portal Server. This parameter is required if you are installing the “Sun ONE Portal Server IM Channel and Archive” component.
Netlet IM Port	To enable integration with Sun ONE Portal Server Secure Remote Access	Enter the port number to which Netlet listens. The default port no is 49917. This parameter is required if you are installing the “Sun ONE Portal Server IM Channel and Archive” component and want to enable Instant Messaging in secure mode.
Messenger Secure Download Port	To enable integration with Sun ONE Portal Server Secure Remote Access	Enter the port number from which the Instant Messenger Resources will be downloaded through the Netlet. The default value is 49916. This parameter is required if you are installing “Sun ONE Portal Server IM Channel and Archive” component in the secured mode and have not selected “Deploy Messenger Resources in Portal Web Container” check box in the IM Channel and Archive Options panel.
Enable Instant Message Archive	IM Channel and Archive Options.	Select this check box to enable Portal Server Search based archiving in Instant Messaging. This parameter enables archiving in Instant Messaging.
LDAP Host Name	Instant Messaging Server LDAP Configuration.	Enter the host name on which the directory server is running. For example: varrius.siroe.com
LDAP Port Number	Instant Messaging Server LDAP Configuration.	Enter the port no to which the directory server listens to. For example: 389
Base DN	Instant Messaging Server LDAP Configuration.	Enter the Base DN (distinguished name) entry in your LDAP directory. The LDAP directory searches for users and groups from this base distinguished name (DN). For example, o=i-zed.com
Bind DN	Instant Messaging Server LDAP Configuration.	Note: If “Sun ONE Identity Server Instant Messaging Service” component is installed, enter the Bind DN (distinguished name) of the Directory Manager to bind to the LDAP directory server. In a standalone installation, enter the Bind DN (distinguished name) of the user who has the read only privileges to the directory server.
Bind Password	Instant Messaging Server LDAP Configuration.	If “Sun ONE Identity Server Instant Messaging Service” component is installed then enter the password of the Directory Manager to bind to the LDAP directory server. In a standalone installation enter the password of the user who has the read only privileges to bind to the directory server.
SMTP Server Host Name	SMTP Service Configuration.	Enter the Mail server host name. For example, varrius.siroe.com.
Location of Database, Logs, and Runtime Files	Instant Messenger Resources Directory.	Enter the path and directory in which the runtime files are to be saved. On Solaris: /var/opt/SUNWiim/default On Linux: /var/opt/soim/html On Windows: c:\Program Files\Sun\InstantMessaging
Instant Messenger Resources and Help File Location	Instant Messenger Resources Directory.	Enter the path where you want to install the Instant Messenger resources and Online Help files. This path is referred as imdocroot. The default path on which these files are installed is: On Solaris: /opt/SUNWiim/html On Linux: /opt/soim/html On Windows: c:\Program Files\Sun\InstantMessaging\html
Code Base	Instant Messenger Resources web location.	Enter the Codebase for the Instant Messenger Resources. The URL from where the Instant Messenger resources are downloaded is referred to as the Codebase. For example, the default value will be: http://budgie.siroe.com Where budgie.siroe.com is the host name on which the Instant Messenger Resource files are installed.

Installing and Configuring a Directory Server

Instant Messaging in the standalone mode requires a directory server to be installed to perform user authentication and search users.

In a portal deployment, the directory is used for user search and attribute retrieval and it may or may not be used for authentication. It is possible to only leverage single sign on to authenticate to the Instant Messaging server.

Instant Messaging supports Sun ONE Directory Server. For more information on supported software and versions, see the Sun ONE Instant Messaging Release Notes.

For information on how to install and configure Directory Server, see the Sun ONE Directory Server documentation at:

Directory Considerations for Sun ONE Portal Server

When installing Sun ONE Instant Messaging in a portal deployment, you will be using the directory server used by the Sun ONE Portal Server. In a portal deployment, the Sun ONE Instant Messenger uses the directory to search for users and not to authenticate them.

Installing and Configuring a Web Server

Instant Messaging requires a web server to serve the Sun ONE Instant Messenger resource files. The Instant Messaging supports Sun ONE Web Server Enterprise Edition. For information on supported software and versions, see the Sun ONE Instant Messaging Release Notes.

The Instant Messenger resources component should be installed on a server which has a web server installed in it. Note that the portal server includes a web server that can be used to serve messenger resources.

This installation program offers you the option to deploy the messenger resources in the portal web server instance. If you are not deploying the messenger resources with portal, or if you choose not to use the portal's web server instance, you need to either install a web server, or create an instance out of an existing web server installation.

After having decided which web server instance to use, you need to decide where the messenger resources will be physically located under the web server's documentation root. This will define the URL of the messenger resources that is the codebase. For instance, assume that the web server on host www.example.com listens on port 89, the doc root for this web server is /opt/web/, and you choose to install the messenger resources in /opt/web/im, then the messenger resources codebase will be http://www.example.com:89/im/

For information on how to install and configure Sun ONE Web Server Enterprise Edition, see the Application Server documentation at:


Note	If the correct codebase is not provided during installation, you need to update in the messenger launch pages codebase/lang/im[ssl].html and codebase/lang/im[ssl].\|jnlp with the correct URL.


Tip	On Unix, it is possible to install the messenger resources in a directory and use a symbolic link to make the messenger resources visible to the web server. For instance, if in the above example you had installed the messenger resources in /opt/SUNWiim/html, the messenger resources can be made visible to the web server by creating the following symbolic link. ln -s /opt/SUNWiim/html /opt/web/im


Note	If the web server and Instant Messaging server do not reside on the same host, do not install the Instant Messenger resources on the Instant Messaging server host. Instead, install the Instant Messenger resources separately on the web server host.


Note	If you are using Sun ONE Portal Server, you automatically use the web server that ships with it.

Installing and Configuring a SMTP Server

Instant Messaging requires a SMTP server to forward Sun ONE Instant Messenger alerts as email to users when they are offline. To enable this feature, the installer asks you to identify the SMTP server to be used. If you do not have a SMTP server installed, you must install one before installing the Instant Messaging software. For information on supported software and versions, see the Sun ONE Instant Messaging Release Notes.

Installation Options Overview for Instant Messaging

Use the information in this section to become familiar with Instant Messaging installation options before actually installing the product.

Performing a Fresh Installation

The first time you install Instant Messaging components, the installer leads you through all the screens necessary to perform the installation. You can choose to install any combination of the following components:

Within the Instant Messaging server installation, you have two options, “server and multiplexor”, or “multiplexor only”. Use the “multiplexor only” option if you have the server installed on a remote host.


Note	The Instant Messaging installer does not offer an uninstall option. On UNIX, as part of the original installation process, an uninstall program is copied to a directory on the target host. To remove the existing Instant Messaging components, use the uninstall program. See Uninstalling Instant Messaging on UNIX for more information. On Windows, go to Add/Remove Programs from the Control Panel to remove the existing Instant Messaging components.

After installing the Instant Messenger resources, you must configure your systems to launch Sun ONE Instant Messenger. See Configuring Sun ONE Instant Messenger for more information.

Upgrading An Existing Installation With The Current Version of the Software

If the installation program detects an existing instance of an older version of the on the host, then it allows you to upgrade the existing installation with the current version of the software.

The installation program will allow you to select the components to be installed, and in particular it will also allow you to select the components that are not installed in the previous installation.

During installation, the existing components are upgraded and the new components are installed.

When a component is upgraded, the configuration information of the component and the user data maintained by the component are saved. For example, the user information created and managed by the server component is not affected by the upgrade of the server component or any other component.


Note	While the installation program saves all the existing user data and configuration information, as a precaution you need to back up the database and the configuration information. For information on platform-specific back up procedures, see Installing Sun ONE Instant Messaging on UNIX and Installing Sun ONE Instant Messaging on Windows.

For more information on how to back up the Instant Messaging data and configuration information, see the Sun ONE Instant Messaging Administrator’s Guide.

Chapter 1 Preparing for Installation