... h1. {anchor:ACHAQ} Configuration Worksheets - Instant Messaging
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 worksheet 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|http://wikis.sun.com/display/CommSuite/Configuring+Instant+Messaging+for+High+Availability+%28Solaris+Only%29#ConfiguringInstantMessagingforHighAvailability%28SolarisOnly%29-InstantMessagingHAOverview] for specific information about values you can use for these parameters and additional parameters for your checklist.
h6. {anchor:FVBYJ} Configuration Parameters for Instant Messaging
|| Parameter || Description || Your Value ||
| Installation Directory | _im-svr-base{_}Directory in which Instant Messaging is installed. By default, Instant Messaging is installed into the {{/opt}} directory as follows:\\
Solaris and Linux: {{/opt/sun/comms/im}} (Solaris Only) If you will be configuring High Availability service for Instant Messaging, see [Selecting the Installation Directory (im-svr-base)|http://wikis.sun.com/display/CommSuite/Configuring+Instant+Messaging+for+High+Availability+%28Solaris+Only%29#ConfiguringInstantMessagingforHighAvailability%28SolarisOnly%29-gaegg] for information about choosing an installation directory. | |
| Instant Messaging Server Domain Name | Domain name for the users being served by this server. \\
Default: None | |
| Multiplexor Port Number\\
(Multiplexor Configuration Only) | The port number on which the Instant Messaging Server listens for incoming requests from Instant Messenger clients.\\
Default: 5222 | |
| Multiplexed XMPP Port | Port on which the server listens for multiplexor connections \\
Default: 45222 | |
| Disable Server | Select this option if the instance you installed will act as a multiplexor and not a server. If you select this option, you must provide a value for Remote Instant Messaging Server Host Name. | |
| Remote Instant Messaging Server Host Name\\
(Multiplexor Configuration Only) | The host name of the Instant Messaging Server for which this multiplexor routes messages. If the multiplexor and server are installed on the same host, use {{localhost}}. (Solaris Only) If you will be configuring High Availability service for Instant Messaging, use the logical host's name.\\
Dependencies: The Disable Server parameter must be selected, that is, server functionality is disabled. | |
| Enable Email Integration, Enable Email Archiving\\
(Optional) | If selected, enables Instant Messaging email archiving. Sun Java System Portal Server search-based archiving for Instant Messaging.\\
Dependencies: SMTP Server such as Sun Java System Messaging Server\\
Alternatively, you can manually enable Sun Java System Portal Server search-based archiving for Instant Messaging.\\
Dependencies: Sun Java System Portal Server and Sun Java System Access Manager. | |
| LDAP Host Name | In a deployment with an LDAP server, the host name of the LDAP server that contains user and group information for Instant Messaging. For example, {{directory.siroe.com}}.\\
Dependencies: LDAP server such as Sun Java System Directory Server. | |
| LDAP Port Number | In a deployment with an LDAP server, the port number on which the directory server listens for incoming requests. For example, {{389}} \\
Dependencies: LDAP server such as Sun Java System Directory Server. | |
| Bind DN | In a deployment with Sun Java System Access Manager, during installation, you must provide the Directory Manager Bind DN and password. This Bind DN is used to update the directory schema with the Instant Messaging and presence service templates and attributes only. This requires Directory Manager access. The Directory Manager Bind DN and password are not saved or used beyond installation and initial configuration.\\
In a deployment with an LDAP server but without Access Manager, Instant Messaging uses this Bind DN to search users and groups in the directory. Leave this blank if the directory can be searched anonymously. You can change the bind credentials later if required as described in [To Configure Bind Credentials for the Instant Messaging Server|http://wikis.sun.com/display/CommSuite/Troubleshooting+and+Monitoring+Instant+Messaging#TroubleshootingandMonitoringInstantMessaging-TroubleshootingInstantMessagingandLDAP].\\
Dependencies: LDAP server such as Sun Java System Directory Server. | |
| Bind Password | In a deployment with an LDAP server, the Bind DN password. | |
| SMTP Server Host Name\\
(Optional) | The host name of the SMTP server used to send email notification of messages to offline users. For example, {{mail.siroe.com}}. If the SMTP server does not use port 25, specify the port along with the host name. For example, if the SMTP server uses port {{1025}}:\\
{{mail.siroe.com:1025{}}}Dependencies: SMTP server such as Sun Java System Messaging Server. | |
| Database, Logs, and Runtime Files Pathname | The location where the runtime files, database, and logs are stored. Also referred to as _im-runtime-base_. Runtime files are read, created, and modified by the server during its normal operations. Some examples include log files, and persistent state information tied to client actions such as alert messages, roster information, conferences, news channels, and so on.\\
If you are configuring High Availability (HA) for Instant Messaging, this path must be globally available. See [Chapter 4, Configuring Instant Messaging for High Availability (Solaris Only)|http://wikis.sun.com/display/CommSuite/Configuring+Instant+Messaging+for+High+Availability] for more information about HA.\\
The {{configure}} utility appends a directory ({{/default}}) to the path you provide for the runtime files. The name of this directory is the instance to which the runtime files apply. Later, you can create multiple instances of Instant Messaging by creating additional instance directories with different names (for example {{/secure}}) and copying over files from the {{/default}} instance runtime directory. See [Creating Multiple Instances from a Single Instant Messaging Installation|http://wikis.sun.com/display/CommSuite/Configuring+Instant+Messaging+After+Installation#ConfiguringInstantMessagingAfterInstallation-CreatingMultipleInstancesfromaSingleInstantMessagingInstallation] for specific instructions.\\
If you accept the following defaults when you run {{configure}}:\\
*Linux:* {{/var/opt/sun/comms/im/}} \\
*Solaris:* {{/var/opt/SUNWiim/}} \\
The {{configure}} utility creates the following directories for the runtime files:\\
*Linux:* {{/var/opt/sun/comms/im/default}} \\
*Solaris:* {{/var/opt/SUNWiim/default}} \\
In addition, the following two subdirectories are created under the runtime directory. \\
The database directory (_im-db-base_) defaults are as follows:\\
*Linux:* {{/var/opt/sun/comms/im/default/db}} \\
*Solaris:* {{/var/opt/SUNWiim/default/db}} \\
The log directory defaults are as follows:\\
*Linux:* {{/var/opt/sun/comms/im/default/log}} \\
*Solaris:* {{/var/opt/SUNWiim/default/log}}| |
| Resources, Help Files, and HTTP Gateway Pathname | Resource Directory.\\
The directory in which the resource files, online help, and the XMPP/HTTP Gateway are installed.\\
If you want to customize the resource files for your deployment, you should run {{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|http://wikis.sun.com/display/CommSuite/Managing+Instant+Messenger#ManagingInstantMessenger-RedeployingResourceFiles] for information.\\
Default: {{{_}im-svr-base_/html}} | |
| XMPP/HTTP Gateway Deployment | Determines whether or not the XMPP/HTTP gateway will be deployed. If you choose to deploy the gateway, the {{configure}} utility creates a default gateway configuration file ({{httpbind.conf}}) in the default Instant Messaging server instance's _im-cfg-base_ directory if one does not already exist. If {{httpbind.conf}} already exists, the {{configure}} utility does not alter or overwrite the file.\\
Default:\\
{{True}} (gateway is deployed)\\
{note}Note: If you are configuring the Instant Messaging Server to support Convergence, do not enable the XMPP/HTTP Gateway Deployment here. Set this value to {{false}}. The XMPP/HTTP Gateway is deployed through the Convergence server; its value is set when you configure Convergence.{note} | |
| XMPP/HTTP Gateway URI | Defines the URI for the HTTP component of the XMPP/HTTP gateway.\\ |