3.46. Chat Configuration

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:

Note

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.

Database

ParameterDefaultDescription
dbServerTypemongoYou should always use the default value. The other value, embed, is used for unit testing.
dbServerHostlocalhostThe host name or IP of MongoDB.
dbServerPort27017The 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".
dbNamechatName of the Mongo database name.
dbAuthenticationfalseSet it true if authentication is required to access MongoDB.
dbUserEMPTYProvide the username to access the database if authentication needed.
dbPasswordEMPTYProvide the password to access the database if authentication needed.

Warning

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.

Mail Server

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.

Chat Server

ParameterDefaultDescription
standaloneChatServerfalse

The mode of the chat server:

  • The parameter is set to true if the chat is in a standalone mode.

  • The parameter is set to false if the the chat is in embedded mode.

chatPassPhrasechat

The password to access REST service on the eXo Chat server.

chatCronNotifCleanup0 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.

chatReadDays30 (days)

When a user reads a chat, the application displays messages of some days in the past.

chatReadTotalJson200

The number of messages that you can get in the Chat room.

Chat Client updates

ParameterDefaultDescription
chatIntervalChat5000 (milliseconds)

Time interval to refresh messages in a chat.

chatIntervalSession60000 (milliseconds)

Time interval to keep a chat session alive in milliseconds.

chatIntervalStatus60000 (milliseconds)

Time interval to refresh user status in milliseconds.

chatIntervalNotif5000 (milliseconds)

Time interval to refresh Notifications in the main menu in milliseconds.

chatIntervalUsers60000 (milliseconds)

Time interval to refresh Users list in milliseconds.

chatTokenValidity60000 (milliseconds)

Time after which a token will be invalid. The use will then be considered offline.

Copyright ©. All rights reserved. eXo Platform SAS
blog comments powered byDisqus