{anchor:achbc}
h1. Instant Messaging Configuration File and Directory Structure Overview{anchor:indexterm-85} {anchor:indexterm-86} {anchor:indexterm-87} {anchor:indexterm-88}
This chapter provides information about the configuration files you use to administer Instant Messaging. Familiarize yourself with the locations of these files before making changes to your deployment's configuration.
This chapter describes the Instant Messaging server directory structure and the properties files used to store Instant Messaging operational data and configuration information in the following sections:
{toc:minLevel=2|maxLevel=2}{anchor:achbd}
h2. Instant Messaging Server Directory Structure
[Instant Messaging Server Directory Structure|#achbd] shows the platform-specific directory structure for the Instant Messaging server.
h5. {anchor:fvbyk} Table 3-1 Instant Messaging server directories
||Description ||Solaris Location ||Linux Location ||
|Program Files \\ \\ These files include the native executable files, the library files in the {{bin}} or {{lib}} directory, the shell scripts in the {{sbin}} directory, the Java classes, and templates files in the {{lib}} directory. |Instant Messaging Installation Directory \\ \\ The default value for the Installation Directory is: \\ {{/opt/sun/comms/im}} |Instant Messaging Installation Directory \\ \\ The default value for the Installation Directory is: \\ {{/opt/sun/comms/im}} |
|Server Configuration files \\ \\ These files are in the Configuration Directory and include the {{iim.conf}} file and a subdirectory which contains all the server-wide access control files. |Instant Messaging Configuration Directory \\ \\ The default value for the Configuration Directory is: \\ {{/etc/opt/SUNWiim/default/config}} \\ \\ For convenience, the installer creates a symbolic link from {{/etc/opt/SUNWiim/default/config}} to {{/opt/SUNWiim/config}}. \\ \\ In addition, if you create multiple instances of Instant Messaging, the name of the {{/default}} directory will vary depending on the instance. See [Creating Multiple Instances from a Single Instant Messaging Installation|http://wikis.sun.com/display/CommSuite/Configuring+Instant+Messaging+After+Installation#ConfiguringInstantMessagingAfterInstallation-CreatingMultipleInstancesfromaSingleInstantMessagingInstallation] for more information. |Instant Messaging Configuration Directory \\ \\ The default value for the Configuration Directory is:
{{/etc/opt/sun/im/default/config}}
\\ \\ For convenience, the installer creates a symbolic link from {{/etc/opt/sun/im/default/config}} to {{/opt/sun/im/config}}.
\\ \\ In addition, if you create multiple instances of Instant Messaging, the name of the {{/default}} directory will vary depending on the instance. See [Creating Multiple Instances from a Single Instant Messaging Installation|http://wikis.sun.com/display/CommSuite/Configuring+Instant+Messaging+After+Installation#ConfiguringInstantMessagingAfterInstallation-CreatingMultipleInstancesfromaSingleInstantMessagingInstallation] for more information. |
|Runtime Directory Contains Instant Messaging server data. \\ \\
These files include the configurable directory for the files generated by the server at runtime. It includes the end user data in the data directory. It also contains the server, multiplexor, Calendar agent, and XMPP service log files, in the {{log}} directory. |Instant Messaging Runtime Directory \\
The default value for the Runtime Directory is: {{/var/opt/SUNWiim/default}}
\\ \\ In addition, if you create multiple instances of Instant Messaging, the name of the {{/default}} directory will vary depending on the instance. See [Creating Multiple Instances from a Single Instant Messaging Installation|http://wikis.sun.com/display/CommSuite/Configuring+Instant+Messaging+After+Installation#ConfiguringInstantMessagingAfterInstallation-CreatingMultipleInstancesfromaSingleInstantMessagingInstallation] for more information. |Instant Messaging Runtime Directory \\ \\ The default value for the Runtime Directory is: {{/var/opt/sun/im/default}}
\\ \\ In addition, if you create multiple instances of Instant Messaging, the name of the {{/default}} directory will vary depending on the instance. See [Creating Multiple Instances from a Single Instant Messaging Installation|http://wikis.sun.com/display/CommSuite/Configuring+Instant+Messaging+After+Installation#ConfiguringInstantMessagingAfterInstallation-CreatingMultipleInstancesfromaSingleInstantMessagingInstallation] for more information. |
|Database
\\ \\ If you are using a file-based property store, the database directory contains end user information such as the user and news channels directory. If you are using LDAP to store user data, the database directory is not used. |Instant Messaging Database Directory \\
The default value for the Database Directory is: {{/var/opt/SUNWiim/default/db}}
\\ \\ In addition, if you create multiple instances of Instant Messaging, the name of the {{/default}} directory will vary depending on the instance. See [Creating Multiple Instances from a Single Instant Messaging Installation|http://wikis.sun.com/display/CommSuite/Configuring+Instant+Messaging+After+Installation#ConfiguringInstantMessagingAfterInstallation-CreatingMultipleInstancesfromaSingleInstantMessagingInstallation] for more information. |Instant Messaging Database Directory \\
The default value for the Database Directory is: {{/var/opt/sun/im/default/db}}
\\ \\ In addition, if you create multiple instances of Instant Messaging, the name of the {{/default}} directory will vary depending on the instance. See [Creating Multiple Instances from a Single Instant Messaging Installation|http://wikis.sun.com/display/CommSuite/Configuring+Instant+Messaging+After+Installation#ConfiguringInstantMessagingAfterInstallation-CreatingMultipleInstancesfromaSingleInstantMessagingInstallation] for more information. |
|Instant Messenger resources. \\ \\ These files contain HTML documents and {{jar}} files used by Instant Messenger. The topmost directory contains the locale-independent resources, and the locale-specific directories contain the localized resources. |Instant Messaging Resource directory.
\\ \\ The default value for the Resource Directory is:
{{/opt/sun/comms/im/html}} |Instant Messaging Resource directory
\\ \\ The default value for the Resource Directory is:
{{/opt/sun/im/html}} |
{anchor:achbe}
h2. Instant Messaging Server Configuration File{anchor:indexterm-89} {anchor:indexterm-90} {anchor:indexterm-91}
Instant Messaging stores all configuration options in the {{iim.conf}} file. For more information on the parameters and their values stored in this file, see [Instant Messaging Configuration Parameters in iim.conf|Instant Messaging Configuration Parameters in iim.conf].{anchor:achbf}
h2. Instant Messaging Data
Instant Messaging server stores the following data used by Instant Messenger in the database directory, and is indicated by the {{iim.instancevardir}} parameter in {{iim.conf}}:
* End user properties, such as contact lists, messenger settings, subscribed news channels and access control (alternatively, these properties can be stored in LDAP).
* News channel messages and access rules.
* Alert Messages that are to be delivered. These messages are delivered and removed when the recipient logs in.
* Public conferences. This does not involve instant messages which are not persistent, but only properties of the conference objects themselves, such as access rules.
h1. Instant Messaging Configuration File and Directory Structure Overview{anchor:indexterm-85} {anchor:indexterm-86} {anchor:indexterm-87} {anchor:indexterm-88}
This chapter provides information about the configuration files you use to administer Instant Messaging. Familiarize yourself with the locations of these files before making changes to your deployment's configuration.
This chapter describes the Instant Messaging server directory structure and the properties files used to store Instant Messaging operational data and configuration information in the following sections:
{toc:minLevel=2|maxLevel=2}{anchor:achbd}
h2. Instant Messaging Server Directory Structure
[Instant Messaging Server Directory Structure|#achbd] shows the platform-specific directory structure for the Instant Messaging server.
h5. {anchor:fvbyk} Table 3-1 Instant Messaging server directories
||Description ||Solaris Location ||Linux Location ||
|Program Files \\ \\ These files include the native executable files, the library files in the {{bin}} or {{lib}} directory, the shell scripts in the {{sbin}} directory, the Java classes, and templates files in the {{lib}} directory. |Instant Messaging Installation Directory \\ \\ The default value for the Installation Directory is: \\ {{/opt/sun/comms/im}} |Instant Messaging Installation Directory \\ \\ The default value for the Installation Directory is: \\ {{/opt/sun/comms/im}} |
|Server Configuration files \\ \\ These files are in the Configuration Directory and include the {{iim.conf}} file and a subdirectory which contains all the server-wide access control files. |Instant Messaging Configuration Directory \\ \\ The default value for the Configuration Directory is: \\ {{/etc/opt/SUNWiim/default/config}} \\ \\ For convenience, the installer creates a symbolic link from {{/etc/opt/SUNWiim/default/config}} to {{/opt/SUNWiim/config}}. \\ \\ In addition, if you create multiple instances of Instant Messaging, the name of the {{/default}} directory will vary depending on the instance. See [Creating Multiple Instances from a Single Instant Messaging Installation|http://wikis.sun.com/display/CommSuite/Configuring+Instant+Messaging+After+Installation#ConfiguringInstantMessagingAfterInstallation-CreatingMultipleInstancesfromaSingleInstantMessagingInstallation] for more information. |Instant Messaging Configuration Directory \\ \\ The default value for the Configuration Directory is:
{{/etc/opt/sun/im/default/config}}
\\ \\ For convenience, the installer creates a symbolic link from {{/etc/opt/sun/im/default/config}} to {{/opt/sun/im/config}}.
\\ \\ In addition, if you create multiple instances of Instant Messaging, the name of the {{/default}} directory will vary depending on the instance. See [Creating Multiple Instances from a Single Instant Messaging Installation|http://wikis.sun.com/display/CommSuite/Configuring+Instant+Messaging+After+Installation#ConfiguringInstantMessagingAfterInstallation-CreatingMultipleInstancesfromaSingleInstantMessagingInstallation] for more information. |
|Runtime Directory Contains Instant Messaging server data. \\ \\
These files include the configurable directory for the files generated by the server at runtime. It includes the end user data in the data directory. It also contains the server, multiplexor, Calendar agent, and XMPP service log files, in the {{log}} directory. |Instant Messaging Runtime Directory \\
The default value for the Runtime Directory is: {{/var/opt/SUNWiim/default}}
\\ \\ In addition, if you create multiple instances of Instant Messaging, the name of the {{/default}} directory will vary depending on the instance. See [Creating Multiple Instances from a Single Instant Messaging Installation|http://wikis.sun.com/display/CommSuite/Configuring+Instant+Messaging+After+Installation#ConfiguringInstantMessagingAfterInstallation-CreatingMultipleInstancesfromaSingleInstantMessagingInstallation] for more information. |Instant Messaging Runtime Directory \\ \\ The default value for the Runtime Directory is: {{/var/opt/sun/im/default}}
\\ \\ In addition, if you create multiple instances of Instant Messaging, the name of the {{/default}} directory will vary depending on the instance. See [Creating Multiple Instances from a Single Instant Messaging Installation|http://wikis.sun.com/display/CommSuite/Configuring+Instant+Messaging+After+Installation#ConfiguringInstantMessagingAfterInstallation-CreatingMultipleInstancesfromaSingleInstantMessagingInstallation] for more information. |
|Database
\\ \\ If you are using a file-based property store, the database directory contains end user information such as the user and news channels directory. If you are using LDAP to store user data, the database directory is not used. |Instant Messaging Database Directory \\
The default value for the Database Directory is: {{/var/opt/SUNWiim/default/db}}
\\ \\ In addition, if you create multiple instances of Instant Messaging, the name of the {{/default}} directory will vary depending on the instance. See [Creating Multiple Instances from a Single Instant Messaging Installation|http://wikis.sun.com/display/CommSuite/Configuring+Instant+Messaging+After+Installation#ConfiguringInstantMessagingAfterInstallation-CreatingMultipleInstancesfromaSingleInstantMessagingInstallation] for more information. |Instant Messaging Database Directory \\
The default value for the Database Directory is: {{/var/opt/sun/im/default/db}}
\\ \\ In addition, if you create multiple instances of Instant Messaging, the name of the {{/default}} directory will vary depending on the instance. See [Creating Multiple Instances from a Single Instant Messaging Installation|http://wikis.sun.com/display/CommSuite/Configuring+Instant+Messaging+After+Installation#ConfiguringInstantMessagingAfterInstallation-CreatingMultipleInstancesfromaSingleInstantMessagingInstallation] for more information. |
|Instant Messenger resources. \\ \\ These files contain HTML documents and {{jar}} files used by Instant Messenger. The topmost directory contains the locale-independent resources, and the locale-specific directories contain the localized resources. |Instant Messaging Resource directory.
\\ \\ The default value for the Resource Directory is:
{{/opt/sun/comms/im/html}} |Instant Messaging Resource directory
\\ \\ The default value for the Resource Directory is:
{{/opt/sun/im/html}} |
{anchor:achbe}
h2. Instant Messaging Server Configuration File{anchor:indexterm-89} {anchor:indexterm-90} {anchor:indexterm-91}
Instant Messaging stores all configuration options in the {{iim.conf}} file. For more information on the parameters and their values stored in this file, see [Instant Messaging Configuration Parameters in iim.conf|Instant Messaging Configuration Parameters in iim.conf].{anchor:achbf}
h2. Instant Messaging Data
Instant Messaging server stores the following data used by Instant Messenger in the database directory, and is indicated by the {{iim.instancevardir}} parameter in {{iim.conf}}:
* End user properties, such as contact lists, messenger settings, subscribed news channels and access control (alternatively, these properties can be stored in LDAP).
* News channel messages and access rules.
* Alert Messages that are to be delivered. These messages are delivered and removed when the recipient logs in.
* Public conferences. This does not involve instant messages which are not persistent, but only properties of the conference objects themselves, such as access rules.