JBoss.orgCommunity Documentation
The standalone Chat server is configured in the $CHATSERVER/conf/openfire.xml file.
Configuration is based on properties expressed in the XML syntax. For example, to set the prop.name.is.blah=value property, you would write this xml snippet:
<prop>
<name>
<is>
<blah>value</blah>
</is>
</name>
</prop>
Openfire has an extensive list of configuration properties. Please read the list of all properties in Openfire documentation for more details.
The Chat server is an Openfire server bundled with plugins and configurations that allow connectivity to eXo Platform. The following properties are used to configure it.
| Property | Description | Default value |
|---|---|---|
| env | ||
| serverbaseURL | Base URL for all URLs below. | http://localhost:8080/ |
| restContextName | Name of the rest context. | rest |
| provider | ||
| authorizedUser.name | Username to authenticate against the HTTP REST service. | root |
| authorizedUser.password | Password matching with provider.authorizeduser.name. | password |
| eXoAuthProvider | ||
| authenticationURL | URL to authenticate users. | /organization/authenticate/ |
| authenticationMethod | HTTP method used to pass parameters. | POST |
| eXoUserProvider | ||
| findUsersURL | URL to find all users. | /organization/xml/user/find-all/ |
| findUsersMethod | HTTP method for user/find-all. | GET |
| getUsersURL | URL to retrieve a range of users. | /organization/xml/user/view-range/ |
| getUsersMethod | HTTP method for user/view-range. | GET |
| usersCountURL | URL to count users. | /organization/xml/user/count/ |
| usersCountMethod | HTTP method for user/count. | GET |
| userInfoURL | URL to get user information. | /organization/xml/user/info/ |
| userInfoMethod | HTTP method for user/information. | GET |
| eXoGroupProvider | ||
| groupInfoURL | URL to get group information. | /organization/xml/group/info/ |
| groupInfoMethod | HTTP method for information. | GET |
| getGroupsAllURL | URL to view all groups. | /organization/xml/group/view-all/ |
| getGroupsAllMethod | HTTP method for group/view-all. | GET |
| getGroupsRangeURL | URL to view a group range. | /organization/xml/group/view-from-to/ |
| getGroupsRangeMethod | HTTP method for group/view-from-to. | GET |
| getGroupsForUserURL | URL to get groups for a user. | /organization/xml/group/groups-for-user/ |
| getGroupsForUserMethod | HTTP method for groups-for-user. | GET |
| groupsCountURL | URL to count groups. | organization/xml/group/count |
| groupsCountMethod | HTTP method for group/count. | GET |
To run the chat server properly, several ports must be opened in the firewall.
| Port | Type | Description |
|---|---|---|
| 5222 (1) | Client to server (xmpp) | The standard port for clients is to connect to the server. Connections may or may not be encrypted. You can update the security settings for this port with the exo.chat.port property. |
| 9090 & 9091 | Admin Console (http) | The ports used for accessing the unsecured and secured Openfire Admin Console respectively. |
| 3478 & 3479 | STUN service | The port used for the service that ensures connectivity between entities behind a NAT. |