Skip to content
Benjamin Paillereau edited this page Sep 3, 2013 · 7 revisions

eXo Chat can be configured with properties file or system properties.

Available Properties

Services

servicesImplementation

2 possible services implementations : mongo or jcr (jcr implementation is available as demo mode only, it can't be used in Production)

Default value : mongo

weemoKey

Weemo gives access to Video conferencing and screen sharing features. A key is needed. If empty, Video conferencing is deactivated.

Default value : EMPTY

MongoDB

dbServerType

If using MongoDB, you can set mongo db or an embed

Default value : mongo

dbServerHost

Host of DB server.

Default value : localhost

dbServerPort

Port of DB server.

Default value : 27017

dbName

Name of the Chat database in Mongo

Default value : chat

dbAuthentication

Is authentication needed?

Default value : false

dbUser

If authentication, database username

Default value : EMPTY

dbPassword

If authentication, database password

Default value : EMPTY

Chat Server

chatServerBase

Base URL of the Chat Server. Chat server can run on a dedicated server. Base URL must use a format like : http://127.0.0.1:8080

If empty, eXo Chat will use the Client server as the Chat Server BaseURL. Thus, this automatic mode won't run with a Two-Servers installation.

Default value : EMPTY

chatServerUrl

URL to access Chat Server

Default value : /chatServer

chatPortalPage

Page where is installed eXo Chat

Default value : /portal/intranet/chat

chatCronNotifCleanup

Cron job value to clean read notifications

Default value : 0 0/60 * * * ?

publicAdminGroup

eXo group who will answer to Public discussions

Default value : /platform/administrators

teamAdminGroup

eXo group who can create Teams

Default value : /platform/administrators

chatPassPhrase

Secret passphrase to access Rest services

Default value : chat

publicMode

Public mode allows to have unauthenticated discussions in the Chat with a Support team

Default value : false

chatReadDays

When getting message from a room. How many days in the past should we go.

Default value : 30

chatReadTotalJson

How many messages can we get in the Chat room?

Default value : 200

chatReadTotalTxt

How many messages can we export in the Chat room?

Default value : 2000

Chat Client updates

chatIntervalChat

Interval to refresh Chat messages in milliseconds

Default value : 3000

chatIntervalSession

Interval to keep Chat session alive in milliseconds

Default value : 60000

chatIntervalStatus

Interval to refresh User status in milliseconds

Default value : 15000

chatIntervalNotif

Interval to refresh Notifications in the main menu in milliseconds

Default value : 3000

chatIntervalUsers

Interval to refresh Users list in milliseconds

Default value : 5000

chatTokenValidity

Time after which a token won't be valid. A use will then be considered offline

Default value : 25000

SMTP Mail Server

mailHost

For report support in Meeting notes, Host of the SMTP Mail Server.

Default value : smtp.gmail.com

mailPort

Port of SMTP Mail Server

Default value : 587

mailUser

User used for SMTP Authentication

Default value : exo

mailPassword

Password used for SMTP Authentication

Default value : EMPTY

How to change default values

Properties file

you can copy a chat.properties file into tomcat/conf/. Each property will override default values. Example :

servicesImplementation=mongo

weemoKey=---

dbServerType=mongo

dbServerHost=127.0.0.1

dbServerPort=27017

dbName=chat

dbAuthentication=false

dbUser=admin

dbPassword=pass

chatServerBase=localhost

chatServerUrl=/chatServer

chatPortalPage=/portal/intranet/chat

chatIntervalNotif=3000

chatIntervalChat=3000

chatIntervalSession=60000

chatIntervalStatus=15000

chatIntervalUsers=5000

chatPassPhrase=chat

chatCronNotifCleanup=0 0/60 * * * ?

publicMode=false

publicAdminGroup=/platform/administrators

teamAdminGroup=/platform/users

chatTokenValidity=25000

chatReadDays=30

chatReadTotalJson=200

chatReadTotalTxt=2000

mailHost=smtp.gmail.com

mailPort=587

mailUser=exo

mailPassword=---

System properties

You can also use System properties when starting tomcat. In this case, you will use a prefix "chat.".

To override the DB name for example you can use : -Dchat.dbName=chatProd