Sun ONE logo      Previous      Contents      Index      Next     

Sun ONE Instant Messaging Installation Guide

Chapter 3
Installing Sun ONE Instant Messaging on Windows

This chapter describes the steps to install Sun ONE Instant Messaging on a Windows platform. You can run the setup program using either the graphical user interface or the command-line interface.

This chapter contains the following sections:

Downloading and Unpacking Sun ONE Instant Messaging Installer

To download and unpack the Sun ONE Instant Messaging Installer, perform the following steps:

  1. Log in to the machine, where you want to download the Instant Messaging Installation program.
  2. Create a directory such as c:\tmp\imsvr on the machine that will host the Instant Messaging and download or copy the Instant Messaging self-extracting archive file to that directory. Make sure that the directory you use has a minimum disk space of 184MB to store the extracted files.
  3. Download or copy the Instant Messaging Installation archive file.

    4. Note

    • If you are installing from a CD, then change to the CDROM drive.
    • Download the Sun ONE Instant Messaging software from the following site:

  4. Change to the directory where you copied or downloaded the archive file. To extract the contents, type:

    5. unzip soim-version-platform.zip

    Where platform identifies the name of the platform and version identifies the product version of the archive file you downloaded or copied.

Using the Graphical User Interface Installation on Windows

The following steps describe how to use the graphical user interface installation program to install Sun ONE Instant Messaging:

  1. Download and unpack the Sun ONE Instant Messaging Installation program. For more information, see Downloading and Unpacking Sun ONE Instant Messaging Installer.
  2. Log in as Administrator. You must have superuser privileges with full administration rights to be able to run the installation program.
  3. Change to the directory where you placed the extracted files and double-click the setup.exe file.
  4. The installation program displays the Welcome panel. Click Next to continue.
  5. The Software License Agreement panel is displayed.

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

  6. The Software Requirements panel lists the product required to be installed for this installation to be successful.

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

    • A web server, such as Sun ONE Web Server Enterprise Edition, to serve up Instant Messenger resources.
    • A directory (LDAP) server, such as Sun ONE Directory Server, for user authentication.
    • A messaging server (SMTP service), such as Sun ONE Messaging Server, to send alerts by email when users are not currently logged in to Sun ONE Instant Messaging.

      • Note

      See the Instant Messaging 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 process. Install and configure the necessary products.

      Then restart the installation.

      Note

      A restricted license copy of each of these products is bundled with the Sun ONE Instant Messaging product package. Each one of these products must be installed separately.

  7. The installation program automatically detects 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” panel is displayed. Ensure that the host name and DNS domain name specified are correct, and then click Next to continue with the installation. The installation program will then try to establish a network connection using these values.

    8. Note

    For the install program to run properly enter a valid DNS domain name.

  8. The Select Install Directory panel is displayed.

    9. If you do not want to install the Instant Messaging in the default directory, specify the directory where you want to install the Instant Messaging software. The default is c:\Program Files\Sun\InstantMessaging.

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

    Click Next to continue.

    If the directory you selected does not exist, a message window displays the following choices:

    • Click Create Directory to install Instant Messaging in the specified directory and continue with the installation process.
    • Click Choose New to return to the Select Install Directory panel where you can select another installation directory.

      • Click Next to Continue.

  9. In the Select Components panel select the software components to be installed.
    • Sun ONE Instant Messaging Server - This component includes both the server and the multiplexor software.
    • Sun ONE Instant Messenger Resources.

      Note

      If you are not installing Sun ONE Instant Messaging on the same host as your web server, select the Sun ONE Instant Messaging Server option and not the Instant Messenger Resources option. When this installation is completed, start the installation process again and install the Instant Messenger Resources on the web server host. This must be done to ensure that the Sun ONE Instant Messenger HTML, .jar, and Online Help files reside at the web server docroot.

      • The components already installed on the system are automatically selected by the installer.

      Note

      The components will be disabled, if a same or higher version of the component is already installed on the system.

      If the installation program detects an older version of Sun ONE Instant Messaging installed on the host, the installation program upgrades the existing components and installs the new components selected. For more information on upgrade considerations, see Installation Options Overview for Instant Messaging.

      Click Next after you have made the selection.

      If the disk space in the base directory selected is less than the minimum required, the installation program displays the message “Insufficient Disk Space” to inform you that the disk space is less than the minimum required.

      If the disk space in the selected base directory is adequate, the “Confirm, Upgrade and Addition of Components” panel with a list of components to be upgraded and the list of newly added components is displayed.

      When you decide to upgrade, stop all the installation program service.

      During an upgrade if the installation program finds some services running it displays a warning window. The warning window informs you that the installation may not be successful if any of the services is 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

      Before running the installation program, back up the existing databases, user profiles and preferences, and the files you have customized.

      Back up the following directory and its subdirectories:

      • $RUNTIMEDIR\db

        The default value for the RUNTIMEDIR is c:\Program Files\Sun\InstantMessaging\

      • iim.conf file from the directory $BASEDIR\config\iim.conf
      • ACL files from the directory $BASEDIR\config\acls\

        The default value for the $BASEDIR is c:\Program Files\Sun\InstantMessaging

      • Back up the following HTML files from the imdocroot: $imdocroot\im.html
        $imdocroot\im.jnlp
        $imdocroot\index.html
        $imdocroot\imres.jnlp
        $imdocroot\imbrand.jar

        The default value for the $imdocroot is c:\Program Files\Sun\InstantMessaging\html

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

  10. The Instant Messaging Services Configuration panel appears only when Sun ONE Instant Messaging Server Installation is selected in the Select Components panel (For new installations only).

    11. Specify the following configuration information, if you do not want to use the default values:

    • Domain Name. The logical instant messaging domain name you want this Instant Messaging 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 the Instant Messaging Server to identify itself and its users on this server only.
    • IM Server Port. (Default is 49999.) The port number on which the Instant Messaging server accepts connections from multiplexors. The default port number should work for most installations.
    • Multiplexor Port. (Default is 49909). The port on which the multiplexor accepts connections from Instant Messenger. The default port should work for most installations.
    • Disable Server. Select this check box if you are installing the Instant Messaging server on a remote host but want the local server to have the multiplexor enabled.
    • Remote IM Server Hostname. The host name where you are installing the Instant Messaging server software. If you have selected the “Disable Server” check box then this host name is considered to be a remote server. Otherwise the Instant Messaging Server host name is considered to be the local host name.

      • Note

      When installing only the Instant Messenger component, only the options for the multiplexor port and the remote server hostname are displayed.

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

    • Click Accept to keep the settings. After installation and before starting the server, you must free the port in use by the other service.
    • Click Choose New to return to the Instant Messaging Services Configuration panel. 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.

  11. The Instant Messaging Server LDAP Configuration panel appears only when Sun ONE Instant Messaging Server Installation is selected in the Select Components panel. The Instant Messaging Server LDAP Configuration panel displays with default settings.

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

    • LDAP Host Name. Host name of the machine on which the LDAP server is running. The default is the fully qualified host name. For example, fiat.sireo.com.
    • LDAP Port Number. 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 to search for users and groups. For example, if you specify a base DN of o=i-zed.com, LDAP search operations executed by the Instant Messaging server will examine only the o=i-zed.com directory tree. The installation program does not attempt to verify your entry if the Bind DN and Password are not specified.
    • BindDN. Enter the Bind DN (distinguished name) of the user who has read only privileges to the directory server.
    • Bind Password. Enter the password of the user who has read only privileges to the directory server.

      • Note

      • If the installation program does not detect a LDAP server running on the specified port, the message “Problem Connecting to LDAP Host” is displayed. Click Accept, and install the LDAP server before starting the Instant Messaging server. Otherwise, click Choose New and re-enter the LDAP configuration parameters.
      • If the directory server is configured for anonymous user search, you need not specify the BindDN and the Password in the LDAP Service Configuration panel.

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

  12. The SMTP Service Configuration panel appears only when Sun ONE Instant Messaging Server Installation is selected in the Select Components panel.

    13. 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 on which you are installing Instant Messaging server.

    The installer tries to connect to the specified host name. If the SMTP service is not found, the message “Problem connecting to SMTP host” is displayed. In the “Problem connecting to SMTP host” window you can:

    • Click Accept to keep the settings. You can edit the iim.conf file later to specify the correct SMTP host name.
    • Click Choose New to return to the SMTP Service Configuration panel. Type the correct host name. Click Next to continue.
  13. The Sun ONE Instant Messaging Server Runtime Files Directory panel appears only when Sun ONE Instant Messaging Server Installation is selected in the Select Components panel.

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

    The default value is c:\Program Files\Sun\InstantMessaging

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

    If the directory you selected does not exist, the message “Create new directory?” is displayed and you can either:

    • Click Create Directory to create a new directory and store the runtime files in this directory and continue the installation.
    • Click Choose New to return to the Instant Messaging Runtime Files Directory panel where you can select another directory.

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

  14. The Instant Messenger Resources Directory panel appears only when Sun ONE Instant Messenger Resources Installation is selected in the Select Components panel.

    15. The Instant Messenger Resources Directory panel displays the location of the instant messenger resource files. The default base directory for messenger resources is:

    c:\Program Files\Sun\InstantMessaging\html

    Specify the directory where you want to store the Sun ONE Instant Messenger Resource and the Online Help files, also referred as the Instant Messaging docroot directory.

    These files must reside where the web server is located.

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

    If the directory you have selected does not exist, the message window “Create new directory?” is displayed and you can either:

    • Click Create Directory to create a new directory and install client files in this directory and continue the installation.
    • Click Choose New to return to the Instant Messenger Resources Directory panel where you can enter the path to install the Instant Messenger resource files.

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

  15. The Select CodeBase for Instant Messaging Resources panel appears only when Sun ONE Instant Messenger Resources Installation is selected in the Select Components panel.

    16. CodeBase. Enter the Instant Messenger Codebase. The URL from where the Instant Messenger resources are downloaded is referred to as Codebase. The default Codebase value is:

    http://LocalHost_Name:80

  16. The Instant Messaging Services Startup panel appears only when Sun ONE Instant Messaging Server Installation is selected in the Select Components panel. In the Instant messaging Services Startup panel, specify when to start Instant Messaging services. The startup options are:
    • Start Instant Messaging Services after successful installation
    • Start Instant Messaging Services on system startup

      • Click Next to continue.

  17. The installation program verifies if there is adequate disk space and then displays the Ready to Install panel.

    Note

    The required disk space displayed for the installation does not include the Java Runtime Environment. Java Runtime Environment requires an additional 51 MB.

    18. To complete the installation, click Install Now.

  18. When the installation procedure is complete, a summary panel is displayed.
    1. Click Details, if you want to review the summary information of the installation.
    2. When you are finished reviewing the summary information, click Dismiss to close the “Summary information” window.
    3. Click Exit to end the installation program.

      4. Note

      Follow the post-installation instructions in the section Post-Installation Step for Windows.

Using the Command-Line Installation on Windows

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

  1. Download and unpack the Sun ONE Instant Messaging Installation program. For more information, see Downloading and Unpacking Sun ONE Instant Messaging Installer.
  2. Login as Administrator. You must have superuser privileges that is, be logged in with full administration rights to run the installation program.
  3. Type the name of the Instant Messaging archive file followed by the argument -nodisplay. For example:

    4. setup.exe -nodisplay

  4. After the installation program extracts the compressed installation files, read the instructions and then press Enter to continue.
  5. A Welcome message is displayed. Press Enter to continue.
  6. Preparatory text is displayed. Press Enter to display the Sun ONE Software License Agreement.

    7. The installation program then asks the same configuration questions as described above in Step 5 to Step 18 in Using the graphical user interface installation on Windows.

    Note

    To exit the installation, press CTRL-C.

Adding Additional L10n Client Files to Existing Installation on Windows

On Windows, the installer does not automatically install the localized resources.

The localized resources need to be manually added after the core product is installed.

To install the localized resources type:

  1. cd $IMDOCROOT
  2. cp localized_resources_bundle to $IM_DOCROOT
  3. unzip the localized_resources_bundle
  4. gen_files.bat<lang> for example, gen_files.bat ja

Post-Installation Step for Windows

After installation, you might need to complete the step described in this section.

Enabling Java Web Start

To enable Java Web Start support in your web server, you might need to edit the web server’s mime.types file to include a line for JNLP.

On Sun ONE Web Server Enterprise Edition
  1. Type the following URL to start the administration server in your browser:

    2. http://hostname.domain-name:administration_port

    For example: http://budgie.siroe.com:8888

    Sun ONE Web Server then displays a window prompting you for a user name and password.

  2. Type the administration user name and password you specified when installing the web server.

    3. Sun ONE Web Server displays the Administration Server page.

  3. In the Manage Servers page, click Manage.

    4. Sun ONE Web Server displays the Server Manager page.

  4. Click the MIME Types link.
  5. From the MIME file drop-down list, choose a MIME type to edit and click OK.
  6. In the Global MIME Types page, select type from the Category drop-down list.
  7. In the Content-Type text box, type:

    8. application/x-java-jnlp-file

  8. In the File-Suffix text box, type:

    9. jnlp

  9. Click New Type to create the MIME type.

    10. Restart the web server for this change to take effect.

On Apache Web Server

The mime.types file located in the Apache Web Server configuration directory, should be edited to include the line:

application/x-java-jnlp-file jnlp

Note

The location of Apache Web Server configuration directory is site specific.



Previous      Contents      Index      Next     

Copyright 2003 Sun Microsystems, Inc. All rights reserved.