iPlanet Portal Server: Instant Collaboration Pack Release 3.0 Installation Guide: Chapter 3 Installing iPlanet Instant Messaging Server on Windows NT

Previous Contents Index DocHome Next

iPlanet Portal Server: Instant Collaboration Pack Release 3.0 Installation Guide

Chapter 3 Installing iPlanet Instant Messaging Server on Windows NT

This chapter describes the steps to follow to install iPlanet Instant Messaging Server (iIM Server) on a Windows NT platform. You can run the setup program by either using the graphical interface installation or using the command-line installation.
This chapter contains:

Using the Graphical Interface Installation on Windows NT

Using the Command-Line Installation on Windows NT

Post-Installation Steps for Windows NT

Note You can install and configure iPlanet Instant Messaging Server on the Windows NT platform in standalone mode only and not in portal mode. Currently, iPlanet Portal Server is not supported on Windows NT, hence you cannot create a portal deployment for iPlanet Instant Messaging Server using that platform.

Using the Graphical Interface Installation on Windows NT

The following steps describe how to use the graphical user interface installation program to install iPlanet Instant Messaging Server.

Log in as Administrator. You must have superuser privileges (that is, be logged in with full administration rights to the system) to run the installation program.

Create a directory (such as c:\tmp\imsvr) on the machine that will host the iIM Server and download (or copy) the iIM Server self-extracting archive file to that directory.

Download the software from:

http://www.iplanet.com/downloads/download

Make sure that the download directory has adequate disk space to store the extracted files.

Caution
Do not download the installer package, nor extract it, into the directory where you plan to install the product. This will result in installation failures.

Change to the directory where you downloaded or copied the file and extract the contents.

In the directory where you placed the extracted files, double-click the setup.exe file.

The Welcome window opens. Click Next to continue.

The Software License Agreement window opens.

Read the license agreement and click Yes (Accept License) to accept it and continue. (If you click No, the installation program will end without installing the software.)

The Software Requirements window opens, listing other product dependencies.

Before continuing with this installation, you should already have installed:

A web server, such as iPlanet Web Server, to serve up HTML to the client.

A directory (LDAP) server, such as iPlanet Directory Server, for user authentication.

A messaging server (SMTP service), such as iPlanet Messaging Server, to send alerts by email when users are not currently logged in to iIM Server and are unable to receive instant messages.

Optionally, you may want to install:

A provisioning tool, such as iPlanet Delegated Administrator.

Note See the iPlanet Portal Server: Instant Collaboration Pack 3.0 Release Notes for information on supported software and versions.

If you have these products installed, click Next to continue installation. Otherwise, Click Exit to quit the installation and install and configure the necessary products. Then restart the installation.

Note A restricted license copy of each of these products is bundled in the iPlanet Instant Messaging Server Release 3.0 product package. Each must be installed separately.

Two informational windows open saying "Installer: Verifying Services." On faster systems, you might not see these windows.

The installation program is automatically detecting the host name and DNS domain name of the system on which you are installing the server. If the installation program cannot detect the host name or DNS domain name, the "Unable to make network connection" window opens. Be sure that the host name and DNS domain name specified are correct, then click Next to continue the installation. The installation program will then try to establish a network connection using these values.

Note The Host Name or Domain Name fields will be blank if the installation program is unable to detect these values. In this case, you must enter a valid host name or DNS domain name, or both.

If you have a previous version of iPlanet Instant Messaging Server installed on this system, the Upgrade or Remove and Reinstall Existing Installation window opens.

Whether you decide to upgrade or remove and reinstall, all running iIM services must be stopped. The installation program attempts to stop them for you. If it is unable to verify that all services are stopped, it opens a warning window. The warning window advises you that the installation may not be successful if any services are still running. If you are sure that all services have been stopped, click Continue; otherwise, click Cancel to return to the installation program. Stop all services before proceeding with the installation.

Caution
Be sure to stop all existing iIM services before proceeding with either the upgrade or reinstallation.

Upgrade vs. Reinstall Considerations

Table 3-1 summarizes the difference between upgrading and reinstalling.

Table 3-1 Upgrade vs. Reinstall Considerations

Type of Installation

Enables Changing Configuration Options?

Allows You to Add a Component to This Server?

Preserves Existing Database and Configuration?

Should You Back Up Existing iIM Server Files?

Upgrade

No.

No

Yes.

Not necessary, but should be done as a precaution.

Reinstall

Yes. You can change all installation options.

Yes

No.

Depends: Back up any customizations, configurations, or databases you want to keep.

Upgrading

Choose to upgrade only if you do not need to change any installation options.

For complete instructions on upgrading your system to a new version, see Appendix B "Upgrading iPlanet Instant Messaging Server."

Reinstalling

To remove the existing installation and install the new version, you must check the Reinstall Existing Components checkbox at the bottom of the window, and then click Next.

You see one or two informational message windows open:

The Confirm: Reinstall message window opens asking if you want to continue with the reinstall operation.

It informs you that reinstall removes the entire existing installation, including all directories and their contents, configuration information, and the site specific changes. It advises you to back up any existing databases before continuing.

Click Continue (reinstall) to continue the operation, or click Cancel to return to the Upgrade or Reinstall Existing Installation screen, where you can reselect your option or exit the installer.

A second message window might warning that the installation program has attempted to stop any existing iIM services, but is unable to verify that all of the services are stopped.

If any iIM services are left running, the installation could fail. Ensure that all iIM services are stopped before continuing with the reinstallation.

Click Continue to continue the installation, or click Cancel to return to the Upgrade or Reinstall Existing Installation screen.

Caution
Check the Reinstall box only if you want to completely remove the existing installation and reinstall the new version from scratch. Before proceeding, back up any existing databases, user profiles and preferences, and any other files you may have customized.
Back up the following directory and its subdirectories:
c:\Program Files\iPlanet\InstantMessaging\db\
In addition, the following files are the most commonly customized files and should be included when you back up your files.
Config Files (if you use the default directories, $BASEDIR = c:\Program Files\iPlanet\InstantMessaging):
$BASEDIR\config\iim.conf
$BASEDIR\config\acls\sysAdmin.acl
$BASEDIR\config\acls\sysTopicsAdd.ac
$BASEDIR\config\acls\sysRoomsAdd.acl
$BASEDIR\config\acls\sysSendAlerts.acl
$BASEDIR\config\acls\sysWatch.acl
$BASEDIR\config\acls\sysSaveUserSettings.acl
HTML Files (if the defaults were used, $HTMLDIR = c:\Program Files\iPlanet\InstantMessaging\html):
$HTMLDIR\iim.html
$HTMLDIR\iim.jnlp
$HTMLDIR\index.html
$HTMLDIR\iimres.jnlp
$HTMLDIR\iimres.jar

The Component Selection window opens.

Select the software components to be installed (default is both):

iPlanet Instant Messenger - This component includes the client software and online help.

iPlanet Instant Messaging Server - This component includes both the server and the multiplexor.

If you choose to install this component, with or without the client component, additional screens are presented to you. These steps are indicated as such in this guide.

Note If you are not installing iPlanet Instant Messaging Server on the same host as your web server, you should only install the server component at this time, and not the client component. Then, when this installation is over, start the installation process again and install the client component on the web server host. This is necessary so that the iPlanet Instant Messenger HTML, .jar, and online help files reside at the web server document root (the directory from which the web server is serving files).
If you choose not to install the client component at the web server document root (you will be asked to specify the directory in Step 16), you must edit the iim.jnlp and iimres.jnlp files to reflect the proper codebase.
For more information on customizing these files, see Chapter 3 in the iPlanet Portal Server: Instant Collaboration Pack Release 3.0 Administrator's Guide.

When you have finished making your selections, click Next to continue.

The Select Install Directory window opens.

If you do not want to install in the default directory, specify the directory where you want to install the iIM Server software. The default is c:\Program Files\iPlanet\InstantMessaging.

If you want to select another directory, click Browse, then select a directory and click OK.

When you have finished making your selection, click Next to continue.

If the directory you selected does not exist, a message window opens and you can either:

Click Create Directory to install iIM Server in the specified directory and continue the installation.

Click Choose New to return to the Select Install Directory window where you can select another installation directory.

The Instant Messaging Services Configuration window opens.

If you do not want the default values, specify the following configuration information:

Domain Name. The logical instant messaging domain name you want this iIM server to support. If you are serving instant messaging to a wider group of people, this is not normally the TCP/IP host name of your system. This domain name does not have to be in the DNS. It is a name used by iIM server, on this server only, to identify itself and its users.

Multiplexor Port. (Default is 9999.) The port number on which the iIM server accepts connections from multiplexors. The default port number should work for most installations.

Web Client Port. (Default is 9909). The port on which the multiplexor accepts connections from client requests. The default port should work for most installations. If you specify a port other than the default, iPlanet Instant Messenger users will need to explicitly include this port number at login.

Disable Server Check Box. Check this box if you are installing the iIM server on another (remote) host and you only want this local server to have the multiplexor enabled.

Remote Server Hostname. The host name where you are installing the iIM Server software. If you checked the "Disable Server" box then this is the remote server, otherwise it is the local host name.

If you want to use values other than the defaults, enter them now.

Note When installing just the client component, you see only the options for the Web Client Port (Multiplexor port accepting connections from clients) and the Remote Server Hostname.

If a port is already being used by another process running on the system, a Server (or Multiplexor) Port in use message window opens, giving you two choices:

Click Accept to keep the settings. After installation and before starting the server, you must free the port in use on the other service.

Click Choose New to be returned to the Instant Messaging Services Configuration window. Select a port number other than the one in use.

When you have finished making your selections, click Next to continue. You might experience a short delay while the installer works in the background.

(Server installations only) The LDAP Service Configuration window opens with default settings.

If you are using different settings, enter the following LDAP server information for user authentication:

Host. Host name of the machine on which the LDAP server is running.

Port. Port number that the LDAP server listens to. The default is 389.

Base DN. Base DN (distinguished name) is the entry in your LDAP directory used as the starting point from which searches will occur. For example, if you specify a base DN of ou=people, o=i-zed.com, LDAP search operations executed by iIM server will examine only the ou=people subtree in the o=i-zed.com directory tree. The installation program does not attempt to verify your entry.

The default is the fully qualified host name.

Note If the installation program does not detect an LDAP server running on the specified port, a Problem Connecting to LDAP message window opens stating that the iIM server will not run if an LDAP server is not available. If this is acceptable at this point, click Accept, and install the LDAP server before starting iIM server. Otherwise, click Choose New and re-enter the LDAP configuration parameters.

When you have finished making your selections, click Next to continue.

(Server installations only) The SMTP Service Configuration window opens.

Identify the SMTP server to be used for sending alerts by email when the user is offline and unable to receive instant messages.The default is the local server you are installing onto.

If you specify your local host name, the installer tries to connect to the SMTP service. If an SMTP service cannot be found on your local host, an Unable to Connect to SMTP Host message window opens, giving you two choices:

Click Accept to keep the settings. You can edit the iim.conf file later to specify the correct SMTP host.

Click Choose New to be returned to the SMTP Service Configuration window. Type the correct host name. Click Next to continue.

(Server installations only) The Specify Runtime Files Directory window opens.

Specify the directory where you want to store runtime files, including the user profile database, logs, and other files created by the server and multiplexor at runtime.

The default is c:\Program Files\iPlanet\InstantMessaging\.

If you want to select another directory, click Browse, then select a directory and click OK.

If the directory you selected does not exist, a window opens and you can either:

Click Create Directory to store the runtime files in the specified directory and continue the installation.

Click Choose New to return to the Specify Runtime Files Directory window where you can select another directory.

When you have finished making your selection, click Next to continue.

(Client installations only) The Web Server Document Root Directory window opens.

Specify the directory where you want to store the iPlanet Instant Messenger HTML files, .jar files and the Online Help files, which is referred to as the Web Server Directory, or the Web Server Document Root.

These files must reside where the web server is serving the files. If the web server is on the same host as the iIM Server, then use the top level docs directory for the web server. If the web server is on a host other than the iIM server, then install iPlanet Instant Messenger on the web server host instead of the iIMS server host.

The directory you specify for this step must be on the host you are currently installing to. The default is c:\Program Files\iPlanet\InstantMessaging\
html.

If you want to select another directory, click Browse, then select a directory and click OK.

If the directory you selected does not exist, a message box opens and you can either:

Click Create Directory to install client files in the specified directory and continue the installation.

Click Choose New to return to the Webserver Document Root Directory window where you can select another directory.

Note If you do not install these files in the web server document root (for example, in a subdirectory under the web server document root), you need to edit the iim.jnlp and iimres.jnlp files to reflect the proper codebase.
For example, if your web server's document root is c:\Winnt\docroot and you choose to put your files into the subdirectory c:\Winnt\docroot\iim, then edit the iPlanet Instant Messaging Server .html and .jnlp files so that the iim subdirectory is appended to all the http://www.hostname.com entries, where hostname is your web server's host name. All the entries would then look like http://www.hostname.com/iim.
For more information on customizing these files, see Chapter 3 in the iPlanet Portal Server: Instant Collaboration Pack Release 3.0 Administrator's Guide.

When you have finished making your selection, click Next to continue.

(Server installations only) The Instant Messaging Services Startup window opens.

Select the options for automatically starting iIM server.

You can choose to start the server after successful installation and, optionally, to start the server automatically at system startup. If you do not wish to start the server after the installation or upon server startup, uncheck the applicable box or boxes. When you have finished making your selections, click Next to continue.

A message window opens saying the installer is verifying if there is adequate disk space. You might not see this window on faster systems.

The Ready to Install window opens.

Note that the size shown for the installation does not include the Java Runtime Environment, which is an additional 51 MB.

To complete the installation, click Install Now.

The Installing window opens and displays installation progress.

When the installation procedure has completed, an installation Summary window opens. Click Details if you want to review summary information about the installation. When you are finished, Click dismiss to close the Summary information window, then click Exit to exit the installation program.

Note Be sure to follow the post-installation instructions found in the section titled "Post-Installation Steps for Windows NT"."

Using the Command-Line Installation on Windows NT

iPlanet Instant Messaging Server provides you the option of running the installation script without using the graphical interface. To run the command-line installation program, use the following steps:

Login as Administrator. You must have superuser privileges (that is, be logged in with full administration rights to the system) to run the installation program.

Create a directory (such as \tmp\imsvr) on the machine that will host the iPlanet Instant Messaging Server and download (or copy) the iIM Server archive file to that directory. Make sure that the download directory has adequate disk space to store the extracted files.

Download the software from:

http://www.iplanet.com/downloads/download/

Caution
Do not download the installer package, nor extract it, into the directory where you plan to install the product. This will result in installation failures.

Change to the directory where you downloaded or copied the file and extract the contents.

Open a command prompt and change to the directory in which you placed the iIM Server archive file. For example:

cd \tmp\imsvr

Type the name of the iIM Server archive file followed by the argument -nodisplay. For example:

setup.exe -nodisplay

After the installation program extracts the compressed installation files, read the instructions and then press Enter to continue.

A welcome message displays. Press Enter to continue.

Preparatory text displays. Press Enter to display the iPlanet Software License Agreement.
The installation program then asks the same configuration questions as described above in Step 6 - Step 20 in Using the Graphical Interface Installation on Windows NT.

Note To exit the installation, press CTRL-C.

Post-Installation Steps for Windows NT

After installation, you might need to complete other steps described in this section.

Searching the Directory and Anonymous Users

iPlanet Instant Messaging Server needs to be able to search the directory to function correctly. If your directory is configured to be searchable by anonymous users, iIM Server has the capability it needs. If the directory is not readable by anonymous users, you must take additional steps to configure the iim.conf file with the credentials of a user ID that has at least read access to the directory.
See Chapter 2 of the iPlanet Portal Server: Instant Collaboration Pack Release 3.0 Administrator's Guide for the steps to enable iIM Server to search the directory as a specific (non-anonymous) user.

Launching Java Web Start

To launch Java Web Start, you might need to edit the web server's mime.types file to include a line for JNLP.

For iPlanet Web Server, the default location for this file is:

c:\Netscape\Server4\https-xxx\config\mime.types

where xxx is your web server instance name.

If not already present, add the following line:

type=application/x-java-jnlp-file exts=jnlp

Restart the http-xxx server for this change to take effect.

For Apache Web Server, the mime.types file, located in the Apache Web Server configuration directory (its location is site-specific), should be edited to include the line:

application/x-java-jnlp-file jnlp

Viewing Online Help

If you chose to install at the document root, in order to see iPlanet Instant Messaging Server online help, you must edit the iPlanet Web Server file obj.conf, found at:
c:\Netscape\server4\https-xxx\config\obj.conf
where xxx is your web server instance name.
Comment out the following line:
NameTrans fn="pfx2dir" from="/help" dir="/export1/webserver/
manual/https/ug" name="es-internal"

Web Server Not Installed on Default Port

If you will be using Java Web Start and your web server was not installed on the default port, you must edit the iim.jnlp and iimres.jnlp files as follows:
For both files, edit codebase="http://servername" to be:
codebase="http://host.domain:port"

Note For further information on editing the iim.jnlp and iimres.jnlp files, see the iPlanet Portal Server: Instant Collaboration Pack Release 3.0 Administrator's Guide.

Type of Installation	Enables Changing Configuration Options?	Allows You to Add a Component to This Server?	Preserves Existing Database and Configuration?	Should You Back Up Existing iIM Server Files?
Upgrade	No.	No	Yes.	Not necessary, but should be done as a precaution.
Reinstall	Yes. You can change all installation options.	Yes	No.	Depends: Back up any customizations, configurations, or databases you want to keep.

Previous Contents Index DocHome Next
Copyright © 2001 Sun Microsystems, Inc. All rights reserved.

Last Updated December 04, 2001