Sun ONE logo      Previous      Contents      Index      Next     

Sun ONE Instant Messaging Installation Guide

Chapter 2
Installing Sun ONE Instant Messaging on UNIX

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

This chapter contains:

Installation Scenarios on UNIX

You can install and configure Instant Messaging on the UNIX platform either by:

When installing Instant Messaging with Sun ONE Portal Server, you can either install all components on one host, or install the components on different hosts.

Downloading and Unpacking Sun ONE Instant Messaging Installer

To download and unpack the Sun ONE Instant Messaging Installer

  1. Log in to the machine where you want to download the Instant Messaging Installation program.
  2. Create a directory on the machine that will host the Instant Messaging and download or copy the Instant Messaging archive file to that directory.

    3. For example, /export/imsvr.

    Make sure that the directory you use to store the extracted files has a minimum disk space of 140MB.

  3. Download or copy the Instant Messaging Installation archive file

    4. .

    Note

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

      • On Solaris - /cdrom/

      On Linux - /mnt/cdrom/

  4. Change to the directory where you copied or downloaded the archive file.

    5. To extract the contents, type:

    unzip soim - version - platform.zip

    where platform refers to the name of the platform and version the version of the archive file downloaded or copied.

Using the Graphical User Interface Installation on UNIX

The following steps describe how to use the graphical user interface installation program to install 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 root to install Sun ONE Instant Messaging. In the installation directory in which you have extracted the Instant Messaging archive file, type: ./setup

    3. Note

    Do not run the installation in the background.

    If you are installing on a remote machine or if the root does not own the display, set the DISPLAY variable to your host name. For example in C shell type:

    setenv DISPLAY myhost:0.0

  3. The installation program displays a Welcome Message. Click Next to continue.
  4. Read the license agreement and click Yes (Accept License) to accept it and continue. Click No, to abort the installation program without installing Sun ONE Instant Messaging.
  5. The Software Requirements panel displays the requirements and dependencies for standalone and portal deployments.

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

    • The Sun ONE Portal Server, if you are installing Instant Messaging in a portal environment. You need not install Sun ONE Portal Server if you are installing Instant Messaging in the standalone mode.
    • The Sun ONE Identity Server, if you want to install the Sun ONE Identity Server Instant Messaging Service component. The Sun ONE Identity Server and Sun ONE Identity Server Instant Messaging Service component need not be installed on the same host.
    • A webserver, such as the Sun ONE Web Server Enterprise Edition, to serve up Instant Messenger resources. For portal deployments, you can use the web server that ships with Sun ONE Portal Server.
    • A directory (LDAP) server, such as the Sun ONE Directory Server, for user authentication. For portal deployment, Instant Messaging uses the Portal Server’s Directory to search for users.
    • A messaging server (SMTP service), such as the Sun ONE Messaging Server, to send alerts by email when users are not currently logged in to Instant Messaging server, and are unable to receive instant messages. The SMTP server and Sun ONE Instant Messaging server need not be installed on the same host.

      • If you have these products installed, click Next to continue with the installation procedure.

      Click Exit to quit installing the Sun ONE Instant Messaging. Install and configure the necessary products.

  6. On most systems, the installation program automatically detects the host name and DNS domain name of the system on which you are installing the server. Click Next to continue.

    7. If the installation program is unable to detect the host name and DNS domain name, the “Network connection” panel is displayed.

    Enter a valid host name and DNS domain name and click Next. The installation program will then try to establish a network connection using these values.

    An error message “Invalid Network Connection” is displayed by the installation program if it is unable to detect the host name and DNS domain name. Click “Choose New” to enter the correct host name and DNS domain name.

    Note

    The panel only verifies the availability of network connection. The Host and Domain values provided in this step are not used in the Instant Messaging Configuration.

  7. Select the directory in which you want to install the Instant Messaging software. The default directory is /opt.

    8. This panel will not be displayed if any one of the Instant Messaging components is already installed in the system.

    Click Next.

  8. Select the software components you want to install. The Select Components panel displays the following options:
    • Instant Messaging Server - This component includes both the server and the multiplexor software.
    • Sun ONE Instant Messenger Resources.
    • Sun ONE Identity Server Instant Messaging Service. This component can be installed only if the Identity Server or the Identity Server SDK is installed in the system.
    • Sun ONE Portal Server IM Channel and Archive. This component can be installed only if the Portal Server is installed on the system.

      • The installation program automatically selects the components that are already installed on the system.

      Note

      The components appear disabled, if the same or a 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, it allows you to upgrade the existing components and install the new components you have selected. For more information on upgrade considerations, see Instant Messaging Installation Overview.

      Click Next after you have made the selection.

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

      If the disk space in the base directory selected is adequate, the “Confirm, Upgrade and Addition of Components” dialog box with a list of components to be added and upgraded 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 any existing databases, user profiles and preferences, and any other files you have customized.

      Back up the following directory and its subdirectories (on Solaris):

      Configuration Information: /etc/opt/SUNWiim

      Runtime Files: Default directory is /var/opt/SUNWiim

      You need to back up the Instant Messenger Resource from $imdocroot, if the resource files have been customized. The default value of $imdocroot is opt/Sunwiim/html.

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

  9. The Instant Messaging Channel Configurations panel appears only when Sun ONE Portal Server IM Channel and Archive Installation is selected in the Select Components panel.

    10. Enter the following details in the Instant Messaging Channel Configurations panel:

    • Multiplexor Host Name. The host on which the multiplexor is running. The default value is displayed.
    • Remote Server Host Name. The remote host name where the Instant Messaging server is installed.
    • Multiplexor Port. (Default is 49909). The port on which the multiplexor accepts connections from client requests. The default port number should work for most installations.
    • IM Server Port. (Default is 49999.) The port number on which the Instant Messaging server accepts connections from Instant Messaging multiplexors. The default port number should work for most installations.

      • Click Next.

  10. The Instant Messaging Server Configuration panel appears only when Sun ONE Instant Messaging Server is selected in the Select Components panel. Enter the following details to configure Sun ONE Instant Messaging server:
    • 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.
    • IM Server Port. (Default is 49999.) The port number on which the Instant Messaging server accepts connections from Instant Messaging multiplexors. The default port number should work for most installations.
    • Multiplexor Port. (Default is 49909). The port on which the Instant Messaging multiplexor accepts connections from Instant Messenger requests. The default port number should work for most installations.
    • Disable Server. Select this check box, if you are installing the Instant Messaging Server on another (remote) host and you only want this local server to have the multiplexor enabled.
    • Remote IM Server Hostname. The remote host name where you are installing the Instant Messaging server software. If you have selected the “Disable Server” check box, then the installation program considers the value specified here as the remote server host name, otherwise the local host name is taken as the remote server host name.

      • Note

      Only the Multiplexor Port and the Remote IM Server Hostname options are only displayed when Sun ONE Instant Messenger Resources is selected in the Select Components panel.

      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. This message window displays the following 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 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.

  11. The “Assign IM Service to existing users” panel appears only when Sun ONE Identity Server Instant Messaging Service is selected in the Select Components panel.

    12. In the “Assign IM Service to existing users” panel, select the “Assign IM Services to existing users” check box to enable Instant Messaging for the existing users.

    Click Next to continue.

  12. The IM Channel and Archive Options panel appears only when Sun ONE Portal Server IM Channel and Archive Installation is selected in the Select Components panel.

    13. In the IM Channel and Archive Options panel, select the following:

    • Select Enable Secure Mode check box, to install Sun ONE Instant Messaging in a secure mode.

      • In the secure mode, Sun ONE Instant Messenger uses the Sun ONE Portal Server, Secure Remote Access to set up an encrypted session between the user’s computer and Sun ONE Portal Server. A lock icon appears in the Sun ONE Instant Messenger’s Status area when you are running in the secure mode. See the Sun ONE Portal Server, Secure Remote Access documentation for more information on Netlet.

      You can install the Instant Messaging server in secure mode only if the Sun ONE Portal Server, Secure Remote Access is installed. If the Sun ONE Portal Server, Secure Remote Access is not installed, the installation program disables the “Enable Secure Mode” check box.

      Select the following options:

      Deploy Messenger Resources in Portal Web Container. This check box is enabled only when the Instant Messenger Resource component is selected or already installed. Select this check box to download the Instant Messenger Resources using the web server used by the portal server.

      Netlet IM Port. This field is enabled only if you have selected the Enable Secure Mode check box. Enter the port number to which the Netlet listens in this field. The default value is 49917.

      Download Port. This field is enabled only under the following conditions:

      • If you have selected the Enable Secure Mode check box only
      • Not selected the Deploy Messenger Resources in Portal Web Container check box

      or

      Disabled the Deploy Messenger Resources in Portal Web Container check box

      Enter the port number from where the Instant Messenger resources can be downloaded. The default value is 49916.

    • Select the Enable Instant Message Archive check box, to enable portal search-based archiving in Instant Messaging.

      • Click Next to continue.

  13. The Instant Messaging LDAP Configuration panel appears only when Sun ONE Instant Messaging Server or Sun ONE Identity Server Instant Messaging Service is selected in the Select Components panel.

    14. In a standalone deployment, the Instant Messaging LDAP Configuration panel is displayed. Enter the following information:

    • Host Name. The host on which the directory server is running. For example, fiat.siroe.com
    • LDAP Port Number. The port number to which the directory server listens to. For example, 389.
    • BaseDN. 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, the LDAP search operations executed by the Instant Messaging server will examine the o=i-zed.com directory tree. The installation program attempts to verify your entry and displays the invalid Base DN message if the Base DN entered is invalid, or displays the “LDAP Group Search Filter not Specified” message if the Base DN field is left blank.
    • BindDN. (Mandatory). If the Sun ONE Identity Server Instant Messaging Service component is selected in the in the Select Components panel, then you are required to enter the Bind DN (distinguished name) of the Directory Manager to bind to the LDAP directory server. Default is cn = Directory Manager.

      • In a standalone installation, enter the Bind DN (distinguished name) of the user who has the read only privileges to the directory server.

      The “Bind DN not mentioned. LDAP Bind DN required” message is displayed when the Bind DN is not mentioned. The “LDAP Bind DN invalid” message is displayed if an invalid Bind DN is entered.

    • Password. (Mandatory). Enter the password of the Directory Manager to bind to the LDAP directory server, if the Sun ONE Identity Server Instant Messaging Service is installed.

      • In a standalone installation, enter the password of the user who has the read only privileges to bind to the directory server.

      The “Invalid Credentials” message is displayed if an incorrect password or Bind DN is entered. The “Enter the Bind Password for the Directory Manager” message is displayed if the password is not entered.

      Note

      • If the Sun ONE Identity Server Instant Messaging Service is installed then the administrator credentials of the Identity Server are used to bind to the directory server to search for a user.
      • In a standalone installation, if the directory server is configured for anonymous user search, it is not necessary to specify the BindDN and the Password in the IM Server LDAP Configuration panel.

  14. The SMTP Service Configuration panel appears only when Sun ONE Instant Messaging Server Installation is selected in the Select Components panel. In the SMTP Service Configuration panel, enter the SMTP Server name. For example: varrius.siroe.com.

    15. Click Next to continue.

  15. The Instant Messaging Services Identity panel appears when Sun ONE Instant Messaging Server or Sun ONE Instant Messenger Resources Installation is selected in the Select Components panel. In the Instant Messaging Services Identity panel, enter the identity name with which the Instant Messaging server needs to run.

    16. UserID. Enter the user identity with which the Instant Messaging server needs to run.

    GroupID. Enter the group identity with which the Instant Messaging server needs to run.

    This panel will not be displayed if you have selected Sun ONE Identity Server Instant Messaging Service component or Sun ONE Portal Server IM Channel and Archive component in the Select Components panel.

    Note

    • If it is a standalone installation, do not use root for either UNIX userID or group ID.
    • If you are planning to install Sun ONE Identity Server Instant Messaging Service and Sun ONE Portal Server IM Channel and Archive components, use the UserID with which the Identity Server is running as the identity for UserID and GroupID. root is the default UserID with which the Identity Server runs as the identity for UserID and GroupID.

  16. The Instant Messaging Server Runtime Files Directory panel appears when Sun ONE Instant Messenger Resources is selected in the Select Components panel.

    17. The Instant Messaging Server Runtime Files Directory panel displays the path and location of the log and database files. The default base directory for messenger resources is:

    For Solaris: /var/opt/SUNWiim/default

    For Linux: /var/opt/soim/default

    Click Next to continue.

  17. The Sun ONE Instant Messaging Server Configuration panel appears when Sun ONE Instant Messenger Resources is selected but Sun ONE Instant Messaging Server is not selected in the Select Components panel. Enter the following details about the Instant Messaging server in this panel:
    • Remote Server Hostname. The remote host name where you are installing the Instant Messaging server software. If you have selected the “Disable Server” check box, then the installer considers the value specified here as the remote server host name, otherwise the local host name is considered to be the remote server host name.
    • Multiplexor Port Accepting Connection. (Default is 49909.) The port number on which the Instant Messaging multiplexor accepts connections from the Instant Messenger. The default port number should work for most installations.
  18. The “Instant Messenger Resource directory” panel appears when Sun ONE Instant Messenger Resources Installation is selected in the Select Components panel. The “Instant Messenger Resource directory” panel displays the location of the Instant Messenger resource files. The default base directory for messenger resources is:

    19. For Solaris: /opt/SUNWiim/html/

    For Linux: /opt/soim/html

    If you want to select another directory, click Browse, select a directory, and then click OK. You can also:

    • Click Create Directory to install Instant Messenger resources in the specified directory and continue with the installation.
    • Click Choose New to return to the Instant Messenger Document Root panel where you can enter the path to install the Instant Messenger resource files. Click Next to continue.
  19. The Select the CodeBase for Instant Messenger Resources panel appears when Sun ONE Instant Messenger Resources and Sun ONE Portal Server IM Channel and Archive Installation options are selected in the Select Components panel.

    20. Enter the following information in the Select the CodeBase for Instant Messenger Resources panel:

    • 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

      If you have selected the “Deploy Messenger Resources in Portal Web Container” check box in the “IM Channel and Archive options” panel, then the default Codebase value is:

      http://$PortalServer_Hostname:$PortalServer_Portno/portal/im/client

      Click Next to continue.

  20. The Instant Messaging Services Startup panel appears only when Sun ONE Instant Messaging Server Installation is selected in the Select Components panel.

    21. In the Instant Messaging Services Startup panel select an option on when to start Instant Messaging services. The startup options are:

    • Start Instant Messaging Services after successful installation.
    • Start Instant Messaging Services on system startup.

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

  21. The installation program verifies if there is adequate disk space and then displays the Ready to Install panel. To complete the installation, click Install Now.
  22. When the installation process completes, a summary panel is displayed.
    1. Click Details to review the summary information about the installation.
    2. When you have finished reviewing the summary information, click Dismiss to close the “Summary information” window.
    3. Click Exit to end the installation program.

Using the Command-Line Installation on UNIX

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. In a local terminal window, log in as root. You must have superuser privileges to run the installation program.
  3. In the installation directory in which you unzipped the Installation program file, type:

    4. ./setup -nodisplay

    The installation program runs in the current window.

  4. A text explaining how the command-line installation works is displayed. Press Enter to continue.
  5. A welcome message is displayed. Press Enter to continue.
  6. The preparatory text is displayed. Press Enter to display the Sun ONE Software License Agreement.

From this point on, the installation proceeds in the same order as Step 5 to Step 22 in Using the Graphical User Interface Installation on UNIX.

Installing SUNWamsdk Package

If you are installing Sun ONE Instant Messaging server on a machine where Sun ONE Identity Server is not installed and want to use the Identity Server’s Single Sign-on feature then you need to install the SUNWamsdk package on the machine.

To add the SUNWamsdk package

  1. Change to the directory where you have unpacked the Instant Messaging installer file.
  2. To add the SUNWamsdk package, type:

    3. pkgadd -d packages SunWamsdk

  3. Enter the values for the install parameters.
  4. Verify if the iim.conf file contains the following lines:

    5. iim_ldap.useidentityadmin = true

    iim_server.ssoprovider = com.iplanet.im.server.DSAMESSOProvider

  5. Add the following configuration parameters to iim.conf file:

    6. iim_server.usesso=1

    iim_server.ssoprovider=com.siroe.im.server.DSAMESSOProvider

    iim_ldap.useidentityadmin=true

  6. Restart the server using the following command:

    7. imadmin refresh

Adding Additional L10n Client Files to Existing Installation

On Solaris, the installer installs the localized resources bundled with the product after installing the core product. Later, additional localized resources can be added to the localized resource bundle without uninstalling the core product.

To install the localized resources for the messenger resources component

  1. mdir temp
  2. cd temp
  3. copy the localized resources bundle to temp
  4. unzip the localized resources bundle
  5. install_locale messenger

    6. All the localized resources for Sun ONE Instant Messenger Resources component are installed.

Similarly you can add the localized resources for other components using the following commands

Post-Installation Steps for UNIX

After installation, you need to complete the post-installation steps explained in this section.

Enabling Java Web Start

To enable Java Web Start support in your web server, you 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 for starting 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 during the Web Server installation.

    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 the Apache Web Server configuration directory is site-specific.



Previous      Contents      Index      Next     

Copyright 2003 Sun Microsystems, Inc. All rights reserved.