Configuring Instant Messaging After Installation

After installation, you need to complete a few configuration steps before using Sun Java System Instant Messaging. This chapter describes these configuration steps in the following sections:

Before you configure Instant Messaging, you should read and understand the information in the Sun Java Communications Suite Deployment Planning Guide, perform the installation as described in Sun Java Communications Suite 6 Update 1 Installation Guide, complete the configuration checklist, and finally configure the software. In addition, if you are configuring Instant Messaging with Sun Cluster for High Availability, you need to read Configuring Instant Messaging for High Availability (Solaris Only) before completing the steps in this chapter.

Completing the Configuration Checklist

You should gather this information before you begin. You will be prompted for some or all of the information depending on the components you installed.

Print out the following table and write the values for your deployment in the space provided. You can reuse this checklist for multiple installations of Instant Messaging. This table contains passwords and other sensitive information, so you should store this information in a safe place.

(Solaris Only) If you will be configuring High Availability service for Instant Messaging, see Instant Messaging HA Overview for specific information about values you can use for these parameters and additional parameters for your checklist.

Table 1-1 Configuration Parameters for Instant Messaging

Top

Creating a UNIX System User and Group

System users run specific server processes. Certain privileges need to be designated for these users to ensure they have appropriate permissions for the processes they run. Normally, the configure utility creates the following users and groups:

• User: inetuser
• Group: inetgroup
  If the configure utility does not create a UNIX user and group for Instant Messaging, you need to create them manually as described in this section. After you create the user and group for Instant Messaging, you should then set permissions appropriately for the directories and files owned by that user.

Do not choose root as a server user ID unless you are deploying Instant Messaging with Access Manager. In this case, you need to use root in order to allow access to the Access Manager configuration.

To Create the Appropriate UNIX User and Group

1. Log in as superuser.
2. Create a group to which your system user will belong.
   For example, to create a group named imgroup on a Solaris platform, type the following:
   groupadd imgroup
3. Create the system user and associate it with the group you just created and associate it with the group you just created. In addition, set the password for that user.
   For example, to create a user named imuser and associate it with the group imgroup on a Solaris platform, type the following:
   useradd -g imgroup imuser
   For more information on adding users and groups, refer to your operating system documentation.
4. Ensure that the user and group have been added to the /etc/groups file.

Top

configure Utility

You use the configure utility after you install Instant Messaging to configure the software and to generate the configuration files you use to administer Instant Messaging.

This section has the following topics:

• Overview of the configure Utility
• Syntax and Options of the configure Utility
• Configuring Instant Messaging After Installation
• Performing a Silent Instant Messaging Configuration
• Examples of the configure Utility
• Sample Configuration Using the configure Utility

Overview of the configure Utility

If you want to customize the resource files for your deployment, you should run the configure utility, customize the files, then redeploy the resource files. You need to run configure first because the configure utility creates some of the index and .jnlp files that you can customize. See Redeploying Resource Files for information. Also see Completing the Configuration Checklist for information on locating these files after configuration.

The utility displays panels that prompt you for information and provide additional instructions for you to configure your Instant Messaging system.

The Instant Messaging software is not configured by the installer. Instead, you need to run the configure utility after you install the software.

If you are using the BEA web container, you need to create a PASSFILE before you can configure Instant Messaging. If you are not using the BEA web container, skip to Configuring Instant Messaging After Installation.

To create the PASSFILE for the BEA web container, perform the following steps:

1. Create a file named installation directory/SUNWiim/lib/PASSFILE.
2. Add the following lines to the file you created:

   DS_DIRMGR_DN=_Directory Manager Bind DN_ 
   DS_DIRMGR_PASSWORD=_Directory Manager Bind Password_
   DS_HOST=_LDAP Host Name_
   DS_PORT=_LDAP Port Number_
   DS_BASE_DN=_Base DN_
   

3. Fill in the values for each of the variables.

Syntax and Options of the configure Utility

The configure utility has the following syntax:

Note Instant Messaging version 8 release does not support Graphical User Interface based configuration.

./configure --nodisplay --silent --savestate --state --verbose --no --novalidate --debug --help

The configure utility has the following options:

Note The --id, --noconsole, and --loglevel options are removed in Instant Messaging version 8.

--nodisplay
Required if the --silent option is not used. Optional if the --silent option is used. Use this option to configure the Instant Messaging server in the command-line mode.

--help
Optional. Displays the help content for this command.

--verbose
Optional. Prints information messages to the standard output.

--savestate <statefilename>
Optional. Should be used with the --nodisplay option. If you use this option, the inputs that you provide during configuration are saved in the state file. Specify the name and location of the state file along with this option. Your responses are stored as a list of parameters in the state file. Each parameter represents a single entry or field value.

--silent <statefilename>
Required if the --nodisplay option is not used. Use this option to run the configure command in the silent mode. Specify the name and path of the state file with this option. If you are configuring the Instant Messaging server by using a state file, you are not prompted to specify the configuration information. Instead, the values from the state file are used to configure the server.

--state <statefilename>
Optional. During configuration, the configure utility provides default values for configuration. You can either use the default values or specify your own value. If you use this option, the configure utility uses all the default values for configuration.

--no
Optional. Use this option to perform a dry run of the configuration.

--novalidate
Optional. If you use this option, the configure utility does not validate the inputs that you provide during configuration.

--debug
Optional. Use this option to view the debug messages on your terminal.

Note The configure utility ignores any incorrect or invalid command-line options and proceeds with the configuration process by using the valid options.

Configuring Instant Messaging After Installation

1. Change to the directory in which you installed Instant Messaging.
   By default, this directory is /opt/sun/comms/im on the Solaris platform, and /opt/sun/comms/im on the Linux platform.
2. Invoke the configure utility.
   Command-line:
   configure --nodisplay
   From a state file:
   configure --nodisplay --state statefile
   where statefile is the path to the state file you want to use. If you are configuring using a state file, you will not be prompted for configuration information. Instead, the values from the state file are used to configure the software. See Performing a Silent Instant Messaging Configuration for information on generating a state file.
   If you are configuring using the GUI or the command line, a series of prompts appears, requesting information that will set up the initial configuration for Instant Messaging. The prompts that appear vary depending on the components you installed. Fill in the requested information using the values from your Instant Messaging checklist. See Completing the Configuration Checklist.
3. If you install the Sun Java System Access Manager on a different host from the Instant Messaging server, you need to manually copy the imServices files from the Instant Messaging server host to the Access Manager host after you run the configure utility.
   To do this:
   a. Locate the imService_*.properties files on the Instant Messaging server host.
   By default, these files are located under /opt/SUNWiim/lib/ on Solaris and /opt/sun/im/lib/ on Linux.
   b. Copy the files to the locale directory on the Access Manager host.
   By default this directory is /opt/SUNWam/locale on Solaris and /opt/sun/identity/locale on Linux.
   
4. If you are using Access Manager to manage Instant Messaging policies, run the imadmin assign_services command.
   imadmin assign_services
   You will be prompted for the Base DN of the organization under which user entries are stored. This command adds Instant Messaging and presence services to existing users under the organization you specify.
5. Restart Sun Java System Application Server.
   If Instant Messaging will use Access Manager policies in a Sun Java System Application Server deployment, you need to restart the Application Server when you finish configuring Instant Messaging. If you do not restart the Application Server, Instant Messaging services will not appear in the Access Manager console (amconsole).
6. If you intend to use the XMPP/HTTP Gateway, you may need to modify the location of the default log file for the XMPP/HTTP gateway in httpbind_log4j.conf if:
   On Solaris, you chose to use a location for logs other than the default
   On Linux, regardless of the path you chose
   To do this:
   a. Open the httpbind_log4j.conf file.
   This file is stored at the location you specified in httpbind.conf file as the value for the httpbind.log4j.config parameter. By default the file is stored in the following directory under the default Instant Messaging instance:
   im-cfg-base/httpbind_log4j.conf
   b. Set the value of the log4.appender.appender_ID.file parameter to the location where log files are stored.
   By default, on Linux, this value is /var/opt/sun/im/default/log. If you chose another location for log files when you ran configure, enter that path as the value for the parameter.
7. If necessary, configure Access Manager-based services for SSO and policy management.
   See Adding Instant Messaging and Presence Services to a Sub-organization in Access Manager for Single Sign-On and Policy Management Support for information.
8. Configure the web container and client systems to support Instant Messaging.
   For instructions, see Setting up and Launching Instant Messenger.

Performing a Silent Instant Messaging Configuration

To run a silent configuration, you first complete a false configuration to create a state file. During this false configuration session, your responses to the configure utility are captured in the state file, but no software is modified. In the state file, your responses are retained as a list of parameters, each representing a single prompt or field.

You can then run the configure utility on many hosts using the state file as input. This process allows you to quickly propagate one configuration across multiple hosts in your enterprise. See Configuring Instant Messaging After Installing or Upgrading for information on using the state file to configure a new instance of Instant Messaging.

To generate a state file, perform the following steps:

1. Log in as superuser.
2. Change to the directory in which you installed Instant Messaging.
   By default, this directory is /opt/sun/comms/im on Solaris, and //opt/sun/comms/im on Linux.
3. Run the configure utility by typing the following at the command-line:
   configure --no --nodisplay --saveState statefile
   Where statefile is the name you want to use for the state file.
   To use the state file to configure a different installation of Instant Messaging, use the following command:
   configure --nodisplay --silent --state statefile
   As you proceed through the configure utility, your answers are captured in the state file. When you complete the configuration, the state file is available in the location that you specified.
   

Examples of the configure Utility

This section lists a few examples of using the configure command.

To configure through the Command-Line Interface (CLI) mode and save the inputs that you provide in the state file, type the following command:

./configure --nodisplay --savestate /tmp/imstate

To configure through the CLI mode and use the values from the state file, type the following command:

./configure --nodisplay --state /tmp/imsilent

To configure through the silent mode and use the values from the state file, type the following command:

./configure --silent <stateFileName>

To configure through the CLI mode and use the values from the state file, type the following command. The command saves a state file. It does not do the actual configuration as the --no option is used.

./configure --nodisplay --state /tmp/imsilent --savestate /tmp/imstate --no

Sample Configuration Using the configure Utility

The following table lists a sample configuration using default values for all options.

Select all components you wish to configure.
   1. [X] Server components
   2. [X] Client components

 Use Access Manager for Single-Sign-On [no] 

 Use Access Manager for Policy [no] 

Instant Messaging user properties can be maintained using 
one of the following storage systems:
	1. On the file system
	2. In the directory
Enter the number corresponding to your choice: [1] 

 Runtime User ID : [inetuser] 

 Runtime Group ID: [inetgroup] 

 Runtime Directory [/var/opt/SUNWiim] 

 Domain Name 

 XMPP Port [5222] 

 Multiplexed XMPP Port [45222] 

 XMPP Server Port [5269] 

 Disable Server (enable only multiplexor)  [no] 

 LDAP Host Name [imhost.siroe.com] 

 LDAP Port Number [389] 

 Base DN [dc=siroe,dc=com] 

 Base DN 

 Base Password 

 Are you sure you want to use this host for LDAP connections? 
 1. Choose New
 2. Accept
 Enter the number corresponding to your choice: [1] 

 Enable Email Integration [yes] 

 SMTP Server [imhost]  

 Enable Email Archiving [yes] 

 Deploy Messenger Resources [yes] 

 Codebase [http://imhost:80/im] 

 Enable Audio? [no] 

 Webcontainer Path [ ] 

 Web Administration URL [ ] 

 Web Administrator User Id [admin] 

 Web Administrator Password 

 Deploy IM HTTP Gateway [yes] 

 Context Root [http://imhost:80/httpbind] 

 Deploy IM IMPS Gateway [yes] 

 Context Root [http://imhost:80/httpbind] 

 Enable Calendar Agent [no] 

 Enable local component [no] 

 Enable SMS Gateway [no] 

 Enable local component [no] 

 Enable MSN Gateway [no] 

 Enable local component [no] 

 Enable AIM Gateway [no] 

 Enable local component [no] 

 Enable YAHOO Gateway [no] 

 Enable local component [no] 

 Start Services After Successful Configuration [yes] 

 Start Services When System starts [yes] 

Top

Adding Instant Messaging and Presence Services to a Sub-organization in Access Manager for Single Sign-On and Policy Management Support

If you are using Instant Messaging with other server products in the Communications Suite, such as Messaging Server, and you want to use Access Manager for single sign-on (SSO) or policy management, you need to manually configure Access Manager-based services for Instant Messaging. This is because configuration of some Communications Suite products, for example Messaging Server, creates one or more domains under the top-level organization in Access Manager. The configure utility automatically adds these services to the top-level organization if you select yes when prompted to leverage an Access Manager deployment for SSO or policy management.

To Manually Assign Instant Messaging and Presence Services to a Sub-organization in Access Manager

1. In a web browser, log into the Access Manager admin console:
   http://hostname:port/amconsole
   For example,
   http://amserver.company22.example.com:80/amconsole
2. Select Organizations from the View drop-down list in the navigation pane (left pane).
   A list of the domains under the top-level organization is displayed in the left pane.
3. In the navigation pane, click the name of domain under the top-level organization to which you want to add services.
   For example:
   mydomain.example.com
4. In the navigation pane, select Services from the View drop-down list.
   A list of services assigned to the domain appear in the navigation pane.
5. Click Add in the navigation pane.
   The data pane (right pane) displays a list of services you can add to the domain.
6. Under Instant Messaging Configuration in the data pane, select the Instant Messaging service and Presence Service check boxes and click OK.
   The services you selected are now listed in the navigation pane and have been assigned to the domain under the top-level organization.

Top

Creating Multiple Instances from a Single Instant Messaging Installation

You can create multiple instances of Instant Messaging on a single host from one installation. You may want to do this in order to create a secure version of Instant Messaging, or to support multiple directory namespaces. A namespace is a node in the directory under which each UID is unique. All instances of Instant Messaging on a single host share binaries but have unique versions of runtime and configuration files.

To Create an Additional Instance of Instant Messaging from an Existing Installation

This procedure assumes that you have used default installation and configuration values for im-svr-base and im-runtime-base. If you installed using the default values, the original runtime directory is:

Solaris: /var/opt/SUNWiim/default
Linux: /var/opt/sun/im/default

If you used paths other than the defaults, you will need to substitute your paths for the paths used in this procedure.

1. Create a runtime directory for the new instance.
   For example, to create a new runtime directory for instance xyz, type
   mkdir /var/opt/SUNWiim/xyz on Solaris OS
   mkdir /var/opt/sun/im/xyz on Linux OS
2. Create a log directory for the new instance.
   For example, to create a new log directory for instance xyz, type
   mkdir /var/opt/SUNWiim/xyz/log on Solaris OS
   mkdir /var/opt/sun/im/xyz/log on Linux OS
3. If you are using a file-based property store for user data, you need to create a database directory (im-db-base) for the new instance.
   For example, to create a new database directory for instance xyz, type
   mkdir /var/opt/SUNWiim/xyz/db on Solaris OS
   mkdir /var/opt/sun/im/xyz/db on Linux OS
4. Copy the contents of the im-svr-base directory and all of its subdirectories into the newly created directories:
   For example:
   cp -r /etc/opt/SUNWiim/default /etc/opt/SUNWiim/xyz on Solaris OS
   cp -r /etc/opt/sun/im/default /etc/opt/sun/im/xyz on Linux OS
5. Open the new instance's imadmin script in a text editor.
   By default, this script is stored under the im-svr-base directory you just created for the new instance.
   Solaris: /etc/opt/SUNWiim/xyz/imadmin
   Linux: /etc/opt/sun/im/xyz/imadmin
6. In the imadmin script, change the configuration file path to the path for the new configuration file for the new instance.
   For example:
   On Solaris, change /etc/opt/SUNWiim/default/config/iim.conf to /etc/opt/SUNWiim/xyz/config/iim.conf
   On Linux, change /etc/opt/sun/im/default/config/iim.conf to /etc/opt/sun/im/xyz/config/iim.conf
7. Save and close the imadmin script.
8. Open the new instance's iim.conf file in a text editor.
   By default, the iim.conf file is stored in the im-cfg-base directory you created for the new instance.
   Solaris: /etc/opt/SUNWiim/xyz/config/iim.conf
   Linux: /etc/opt/sun/im/xyz/config/iim.conf
9. Modify the port numbers in iim.conf so they do not conflict with the original instance.
   The default port numbers are as follows:
   -> Server port (iim_server.port) - 5269
   -> Multiplexor listen port (iim_mux.listenport) - 5222
   -> Multiplexor to server communication port (iim_mux.serverport) - 45222
   For more information about these parameters, see Instant Messaging Configuration Parameters in iim.conf.
   
10. Modify iim.instancedir to point to im-svr-base.
    See Instant Messaging Server Directory Structure for information on im-svr-base.
11. Modify iim.instancevardir to point to the runtime directory for the new instance.
    For example:
    On Solaris, change /var/opt/SUNWiim/default to /var/opt/SUNWiim/xyz
    On Linux, change /var/opt/sun/im/default to /var/opt/sun/im/xyz
12. Save and close iim.conf.
13. Ensure that file and directory ownership and permissions are the same for all instances.
14. Make renamed copies of /opt/sun/comms/im/html/locale/im.html, im.jnlp, and index.html resource files , and modify the copies to point to the new instance's port number.
15. Redeploy the renamed resource files.
    See Redeploying Resource Files for instructions.
16. Start the new instance:
    Solaris: /etc/opt/SUNWiim/xyz/imadmin start
    Linux: /etc/opt/sun/im/xyz/imadmin start