You are looking at documentation for an older release. Not what you want? See the current release documentation.
Configuring the eXo Chat add-on can be done by creating a chat.properties file or using the exo.properties file (if you have not created this file, see Configuration Overview).
These configuration files are located in:
$PLATFORM_TOMCAT_HOME/gatein/conf/ for Tomcat.
$PLATFORM_JBOSS_HOME/standalone/configuration/gatein/ for JBoss.
You were asked to create the files for security during the setup. If you include any parameter below into the exo.properties, you should add the prefix chat. to its name, such as chat.dbServerHost. Besides, in case both of these files are used, parameters in the exo.properties file will have higher priority than those in the chat.properties file.
| Parameter | Default | Description |
|---|---|---|
dbServerType | mongo | You should always use the default value. The other value, embed, is used for unit testing. |
dbServerHost | localhost | The host name or IP of MongoDB. |
dbServerPort | 27017 | The port number to connect to MongoDB host. |
dbServerHosts | The MongoDB nodes to connect to, as a comma-separated list of <host:port> values. For example "host1:27017,host2:27017,host3:27017". | |
dbName | chat | Name of the Mongo database name. |
dbAuthentication | false | Set it true if authentication is required to access MongoDB. |
dbUser | EMPTY | Provide the username to access the database if authentication needed. |
dbPassword | EMPTY | Provide the password to access the database if authentication needed. |
It is highly recommended to define the parameter dbServerHosts instead of defining the two parameters
dbServerHost and dbServerPort as they are depracated starting from eXo Platform 5.0 version.
Generally, you do not need to configure those unless you have secured your MongoDB. See details about connecting to secured MongoDB in Secured MongoDB.
This server is used for Sending meeting notes (see Recording a discussion). The parameters of mail configuration for the eXo Chat server are the same as those of Outgoing Mail Service, but without the prefix exo.. Notice that if you include these parameters into the exo.properties file, you should add the prefix chat. to their name.
| Parameter | Default | Description |
|---|---|---|
standaloneChatServer | false |
The mode of the chat server:
|
chatPassPhrase | chat |
The password to access REST service on the eXo Chat server. |
chatCronNotifCleanup | 0 0/60 * * * ? |
The notifications are cleaned up every one hour by default. To learn the syntax of Cron expression, see Scheduled synchronization, Administrator guide. |
teamAdminGroup | /platform/administrators |
The eXo group who can create teams. |
chatReadDays | 30 (days) |
When a user reads a chat, the application displays messages of some days in the past. |
chatReadTotalJson | 200 |
The number of messages that you can get in the Chat room. |
| Parameter | Default | Description |
|---|---|---|
chatIntervalChat | 5000 (milliseconds) |
Time interval to refresh messages in a chat. |
chatIntervalSession | 60000 (milliseconds) |
Time interval to keep a chat session alive in milliseconds. |
chatIntervalStatus | 60000 (milliseconds) |
Time interval to refresh user status in milliseconds. |
chatIntervalNotif | 5000 (milliseconds) |
Time interval to refresh Notifications in the main menu in milliseconds. |
chatIntervalUsers | 60000 (milliseconds) |
Time interval to refresh Users list in milliseconds. |
chatTokenValidity | 60000 (milliseconds) |
Time after which a token will be invalid. The use will then be considered offline. |