eXo Platform 3.5

## Chapter 2. Configuration

This chapter covers the following topics:

- eXo Platform configuration

  Explanation of eXo Platform configuration, its directory and some parts of eXo Platform internals.

- Database configuration

  Introduction to a database configuration, steps to connect to a production database, and FAQs of database configuration.

- File system paths

  Explanations of several paths in the local file system.

- JCR system and default workspaces

  The configuration of workspaces for the JCR repository.

- Transaction Service

  Information about the default timeout value of JCR transaction, and the value when your application runs longer transactions.

- Mail server

  Introduction to the Email service of eXo Platform that requires the SMTP server to send emails, such as notifications or password reminders.

- Email-notification configuration for watching a document

  Instructions on how to customize the email notification that allows you to receive email notifications of changes on your selected documents.

- WebDAV cache control

  Introduction to the embedded WebDAV server that lets you control the cache-control HTTP header.

- Chat server

  Information about XMPPMessenger, and Chat server configuration.

- Office server

  Instructions on how to start the Office server through which users can view various types of documents directly in the Sites Explorer.

- Logs

  Introduction to the logs of eXo Platform, and where to configure this function.

- JCR

  Details of the set of properties which control the JCR behavior.

- Cache configuration

  Overall introduction to the Cache configuration of eXo Platform, including: Portal, Social, and ECMS.

- Users configuration

  Instructions on how to configure a super-user and to grant users access to toolbar.

- Gadget configuration

  Information about the OAuth key that will be used in case the OAuth gadgets do not indicate a key.

- Other properties

  Introduction to other properties, such as Navigation Controller, JNDI, IDM.

## 2.1. eXo Platform configuration

In eXo Platform, the configuration is performed in a folder whose location is controlled by a system property named exo.conf.dir. By default, the gatein.sh startup script sets this property as follows:

    -Dexo.conf.dir.name=gatein/conf

So the main entry point for the eXo Platform configuration is /gatein/conf/. This directory contains the following files:

- configuration.properties: the main system configuration.

- configuration.xml: contains the default portal container configuration.

- portal/portal/configuration.xml: the main external customization entry point for the default portal container.

This section explains some parts of the eXo Platform internals so that you can understand the roles of these configuration files.

The eXo Platform Kernel collects runtime components in the portal containers. A portal container holds all components to run a portal instance. It serves portal pages under the servlet context for its name.

The default portal container in eXo Platform is simply called "portal". This explains why the default URL of the samples is http://localhost:8080/portal.

The default portal container can be configured directly inside exo.conf.dir.

However, eXo Platform is capable of running several portal instances simultaneously on the same server. Each instance can be configured and customized independently via files located at: /gatein/conf/portal/$PORTAL_NAME, where $PORTAL_NAME is the name of the portal container.

### Note

The name of the configuration file can be altered. Please refer to the PortalContainer section in the Kernel reference for more details on portal containers and other options to modify the location of the properties.

Services that run inside a portal container are declared via the xml configuration files like configuration.xml. Such files exist in jars, wars and below exo.conf.dir.

The .xml configuration files also serve as the main way to customize the portal via the multiple plugins offered by the eXo Platform components.

Additionally, the .xml files may contain variables that are populated via properties defined in configuration.properties. Hence, the configuration.properties file serves as exposing some selected variables that are necessary to configure eXo Platform in a server environment.

configuration.properties

The system configuration is mostly done in the configuration.properties file. In most cases, this should be the only file for the system administrator to configure.

- In the Tomcat bundle, this file is located at /gatein/conf/configuration.properties.

- In the JBoss server, this file is located at server/default/conf/gatein/configuration.properties.

configuration.xml

This file contains the built-in configuration for the "portal" portal container.

- In most cases, you should not change this file.

- In case you do not want to use "portal" as the default portal for your project, this file can be used to import another PortalContainerDefinition into the root container.

### Note

To learn more about how to configure a new portal container, please refer to the Kernel reference guide.

portal/portal/configuration.xml

This file is empty by default. This is where further customizations can be placed. Generally, custom configurations are provided by extension wars. However, this file is the last loaded by the kernel. It has a higher priority over any other configuration files, including extensions. So, you can override any internal component configuration.

This may turn handy services or configurations that are not exposed in configuration.properties.

For example, you can change the default WebDAV update policy by adding the following code to this configuration.xml file:

    <component>

      <key>org.exoplatform.services.jcr.webdav.WebDavServiceImpl</key>

      <type>org.exoplatform.services.jcr.webdav.WebDavServiceImpl</type>

      <init-params>

        <value-param>

          <name>auto-mix-lockable</name>

          <value>false</value>

        </value-param>

        <value-param>

          <name>def-folder-node-type</name>

          <value>nt:folder</value>

        </value-param>

        <value-param>

          <name>def-file-node-type</name>

          <value>nt:file</value>

        </value-param>

        <value-param>

          <name>def-file-mimetype</name>

          <value>text/plain</value>

        </value-param>

        <value-param>

          <name>update-policy</name>

          <value>replace</value>

        </value-param>

      </init-params>

    </component>

`See also`

- Database configuration

- File system paths

## 2.2. Database configuration

- Connect to a production database

  Steps to prepare your database server and to configure eXo Platform.

- FAQs of database configuration

  Questions and answers about configuring eXo Platform to connect to other database systems, removing the idle MySQL connections, and enabling managed DataSource.

eXo Platform relies on the application server for its database access, so the database must be configured as a data source at the AS level. The data source is obtained by accessing the Enterprise Naming Context (ENC) through the Java Naming and Directory Interface (JNDI) service.

`See also`

- eXo Platform configuration

- File system paths

### 2.2.1. Connect to a production database

If you intend to bring your eXo Platform to production, the embedded hsql database will not be appropriate and you will need to configure your app server to use another one. You need to learn how to configure eXo Platform data sources and your app server. If you need to change the data sources name, read the Rename the data source section below.

### Note

The steps below will show you how to configure eXo Platform to use a MySQL database. You need to adapt them to your actual production environment.

### Tip

Refer to the FAQs of database configuration section to find out our sample configuration files for MySQL and other DB systems.

Step 1. Prepare your database server.

You need to prepare two database schema, then do as follows:

1. Connect to your database server using the ssh command:

    ssh root@db.example.org

2. Verify that MySQL is running:

    sudo /etc/init.d/mysqld status

3. Connect to MySQL:

    mysql -u root -p

In this step, you will be prompted for entering your password.

4. Create 2 databases: one for idm ($dbname-idm) and the other for jcr ($dbname-jcr). For example:

i. Create the first database.

    create database _$dbname_;

ii. Configure the user who has the remote access right (not only from the host server):

    grant all on _$dbname_.* to '_$username_'@'_$IP_' identified by '_$password_';

In which, $IP = AS host name, $IP = IP with wildcard (eg 192.168.1.% = all IPs on 192.168.1.x network) and $username = username that eXo Platform will connect with (i.e. 'dbnameuser').

5. Verify that both databases were created successfully.

    show databases;

6. Quit the server with the exit command.

### Note

eXo Platform does not require tables to be created before it starts because these tables are created automatically on the first startup. If you want to run the DDL script to create the database objects, please contact eXo Support to obtain the script for your database.

Step 2. Configure eXo Platform.

After the database is ready, you need to configure eXo Platform to connect to it. The configuration steps may be different, depending on the application server. Here, instructions are for Tomcat and JBoss.

Tomcat bundle:

In Tomcat, the data sources configuration requires you to edit the server.xml file.

### Tip

Please refer to Tomcat's JNDI Resources How To for more details on the JNDI resources binding in Tomcat.

Edit the server.xml file

1. Open the $PLATFORM_TOMCAT_HOME/conf/server.xml file.

2. Declare the binding of the data sources in the GlobalNaming context:

- Change the driver from org.hsqldb.jdbcDriver to com.mysql.jdbc.Driver.

- Change the username and password to the values set above.

- Change the URL to access your DataBase from jdbc:hsqldb:file:../gatein/data/hsql/exo-jcr_portal into jdbc:mysql://_$host_:3306/_$dbname_.

The code now should look like:

    <!-- eXo JCR Datasource for portal -->

    <Resource auth="Container" driverClassName="com.mysql.jdbc.Driver" logAbandoned="true" maxActive="20" maxIdle="10" maxWait="10000" minEvictableIdleTimeMillis="60000" name="exo-jcr_portal" password="_$password_" removeAbandoned="true" removeAbandonedTimeout="10" type="javax.sql.DataSource" url="jdbc:mysql://_$host_:3306/_$dbname-jcr_" username="_$username_"/>

    <!-- eXo IDM Datasource for portal -->

    <Resource auth="Container" driverClassName="com.mysql.jdbc.Driver" logAbandoned="true" maxActive="20" maxIdle="10" maxWait="10000" minEvictableIdleTimeMillis="60000" name="exo-idm_portal" password="_$password_" removeAbandoned="true" removeAbandonedTimeout="10" type="javax.sql.DataSource" url="jdbc:mysql://_$host_:3306/_$dbname-idm_" username="_$username_"/>

3. Add the JDBC driver. In this step, you need to add the MySQL connector to Tomcat by adding mysql-connector-java-5.1.x.jar to $PLATFORM_TOMCAT_HOME/lib/.

JBoss:

Configure the data source for eXo Platform under JBoss

- Edit gatein-ds.xml

- Add the JDBC driver

1. Edit the gatein-ds.xml file.

i. Open the $PLATFORM_JBOSS_HOME/server/default/deploy/gatein-ds.xml file.

ii. Declare the binding of the data sources in the GlobalNaming context:

- Change the driver: org.hsqldb.jdbcDriver into com.mysql.jdbc.Driver.

- Change the username and password to the values set earlier.

- Change the URL to access your database: <connection-url>jdbc:hsqldb:${jboss.server.data.dir}/exo/hypersonic/exo-xxx_portal-localDB</connection-url> to <connection-url>jdbc:mysql://_$host_:3306/_$dbname_</connection-url>.

The configuration should now look like:

    <datasources>

        <no-tx-datasource>

          <jndi-name>exo-idm_portal</jndi-name>

          <connection-url>jdbc:mysql://_$host_:3306/_$dbname-idm_</connection-url>

          <driver-class>com.mysql.jdbc.Driver</driver-class>

          <user-name>_$username_</user-name>

          <password>_$password_</password>

          <min-pool-size>5</min-pool-size>

          <max-pool-size>20</max-pool-size>

          <idle-timeout-minutes>0</idle-timeout-minutes>

          <prepared-statement-cache-size>32</prepared-statement-cache-size>

       </no-tx-datasource>

    <!-- ...  -->

       <no-tx-datasource>

          <jndi-name>exo-jcr_portal</jndi-name>

          <connection-url>jdbc:mysql://_$host_:3306/_$dbname-jcr_</connection-url>

          <driver-class>com.mysql.jdbc.Driver</driver-class>

          <user-name>_$username_</user-name>

          <password>_$password_</password>

          <min-pool-size>5</min-pool-size>

          <max-pool-size>20</max-pool-size>

          <idle-timeout-minutes>0</idle-timeout-minutes>

          <prepared-statement-cache-size>32</prepared-statement-cache-size>

       </no-tx-datasource>

    </datasources>

2. Add the JDBC driver. In this step, you need to add the MySQL connector library in JBoss by adding mysql-connector-java-5.1.x.jar to $PLATFORM_JBOSS_HOME/server/default/lib/.

### Tip

You can get the latest MySQL connector here.

3. Rename the data source.

By default, eXo Platform defines two data sources:

- exo-jcr_portal - for the Java Content Repository (JCR).

- exo-idm_portal - for the organizational model.

You may want to rename the data source as follows:

i. Open and edit the configuration.properties file.

In this step, indicate eXo name of the data sources. The database schema of Hibernate service for IDM tables is optionally defined by the gatein.idm.datasource.schema property.

    # JNDI name of the datasource that will be used by eXo JCR
    gatein.jcr.datasource.name=java:/comp/env/exojcr
    ...
    # JNDI Name of the IDM datasource
    gatein.idm.datasource.name=java:/comp/env/exo-idm

    # Optional database schema for use with IDM tables (empty by default), uncomment this line to specify required schema name
    #gatein.idm.datasource.schema=EXO1

### Note

eXo Platform automatically appends the portal container name ("_portal" by default) to these values before performing a JNDI lookup.

ii. Change the data source name in the application server.

In this step, you need to change the name under which the data sources are bound in the JNDI tree by the app server. This is a dependent application sever.

### 2.2.2. FAQs of database configuration

Q1. How to configure eXo Platform to connect to other database systems?

Configuring eXo Platform to connect to other database can be done easily. eXo Platform provides sample configuration files in the following folders:

- eXo Platform-3.5.x.zip/conf/db/

  - mysql

  - oracle

  - postgres

In each folder, you will find two sample xml files: gatein-ds.xml for JBoss and server.xml for Tomcat.

Each file contains 2 preconfigured data sources. For example: JCR data source in mysql/server.xml:

    <Resource auth="Container" driverClassName="com.mysql.jdbc.Driver" maxActive="128" maxIdle="32" maxWait="10000" name="exo-jcr_portal" password="${db.password}" testWhileIdle="true" timeBetweenEvictionRunsMillis="30000" type="javax.sql.DataSource" url="jdbc:mysql://${db.host}:${db.port}/${db.jcr.name}" username="${db.username}" validationQuery="SELECT 1"/>

You simply replace the variables with the expected values:

Variables | Expected values
--- | ---
db.username | The username that connects to the database.
db.password | The password for the above username.
db.host | The hostname or IP address of the DB server.
db.port | The port to connect to the DB.
db.jcr.name | The DB name for the JCR datasource.
db.idm.name | The DB name for the IDM datasource.

Please remember to add the JDBC connector JAR to the classpath of your application server.

You can download the official JDBC connector JARs from the following websites:

- http://www.mysql.com/downloads/connector/j/

- http://jdbc.postgresql.org/download.html

- http://www.oracle.com/technetwork/database/features/jdbc/index-091264.html

Q2. How to remove the idle MySQL connections?

Some RDBMSs, like MySQL, close the idle connections after a period (8 hours on MySQL by default). Thus, a connection from the pool will be invalid and any application SQL command will fail, resulting in errors as below:

    org.hibernate.SessionException: Session is closed!
    at org.hibernate.impl.AbstractSessionImpl.errorIfClosed(AbstractSessionImpl.java:72)
    at org.hibernate.impl.SessionImpl.getTransaction(SessionImpl.java:1342)

To avoid this, you can use DBCP to monitor the idle connections and drop them when they are invalid, with the testWhileIdle, timeBetweenEvictionRunsMillis, and validationQuery parameters.

The validation query is specific to your RDBMS. For example, on MySQL, you would use:

    testWhileIdle="true" timeBetweenEvictionRunsMillis="30000" validationQuery="SELECT 1"

In which:

- testWhileIdle activates idle connections monitoring.

- timeBetweenEvictionRunsMillis defines the time interval between two checks in milliseconds (5 minutes in the example).

- validationQuery provides a simple SQL command to validate the connection to the RDBMS.

You can add these parameters to the data source configuration file of your application server, for example, conf/server.xml on Tomcat.

For more details on the configuration, or some examples on other RDBMS and applications servers, please refer to the following websites:

- http://markmail.org/message/a3bszoyqbvi5qer4

- http://stackoverflow.com/questions/15949/javatomcat-dying-databse-connection

- http://confluence.atlassian.com/display/JIRA/SurvivingConnectionClosures

Q3. How to enable managed DataSource?

When you want to use a managed data source (which is the case under JBoss), set "true" for the `gatein.jcr.datasource.managed` property in the `configuration.properties` file.

    # indicates if the jcr datasource is using managed transactions.

    # false by default.

    gatein.jcr.datasource.managed=true

## 2.3. File system paths

eXo Platform requires the read/write access to several paths in the local file system.

    # Arjuna configuration
    com.arjuna.ats.arjuna.objectstore.objectStoreDir=${gatein.data.dir}/jta
    .....

    # Directory for common data (in cluster, mount it as a network shared directory between nodes)
    # On standalone JBoss app server it is assignet to ${jboss.server.data.dir} by default.
    exo.shared.dir=../gatein

    # Configuration directory (in cluster, this directory is per node)
    # Usual locations of configuration directory:
    # for Tomcat app server it is ${catalina.home}/gatein/conf.
    # for JBoss app server it is ${jboss.server.home.dir}/conf/gatein.
    gatein.conf.dir=${catalina.home}/${exo.conf.dir.name}

    # Data directory
    gatein.data.dir=${exo.shared.dir}/data

    # path for any JCR data
    gatein.jcr.data.dir=${gatein.data.dir}/jcr

    # path for file data inserted in JCR
    gatein.jcr.storage.data.dir=${gatein.jcr.data.dir}/values

    # path for the jcr index
    gatein.jcr.index.data.dir=${gatein.jcr.data.dir}/index

The following table explains what goes in which path. The Temporary column indicates if the data are temporary or persistent (V: temporary, X: persistent).

Variable | Content | Temporary
--- | --- | ---
`com.arjuna.ats.arjuna.objectstore.objectStoreDir` | JTA transactional data. | V
`gatein.jcr.data.dir` | Directory for JCR data. | X
`gatein.jcr.data.dir`/swap | Directory for swapped data of JCR | V
`gatein.jcr.storage.data.dir` | Binary value storage for JCR. | X
`gatein.jcr.index.data.dir` | Lucene index for JCR. | X

Each variable can be defined as an absolute or a relative path. The default configuration combines them to obtain a compact tree:

    /gatein       # gatein.data.dir
      /data
        /hsql
        /jcr      # gatein.jcr.data.dir
          /index  # gatein.jcr.index.data.dir
          /swap
          /values # gatein.jcr.storage.data.dir
        /jta

`See also`

- eXo Platform configuration

- Database configuration

## 2.4. JCR system and default workspaces

The following is the configuration of workspaces (default and system) for JCR repository.

    # JCR system and default workspaces

    gatein.jcr.repository.default=repository

    gatein.jcr.workspace.default=collaboration

    gatein.jcr.workspace.system=system

`See also`

- eXo Platform configuration

- Database configuration

- File system paths

- Transaction Service

- JCR

## 2.5. Transaction Service

JCR transaction default timeout configured for 7 mins (420 sec) by default. If your application runs longer transactions, you might need a bigger timeout.

    # JCR Transaction Service

    # TransactionService default timeout (in seconds), set it to one hour here:

    gatein.jcr.transaction.timeout=3600

`See also`

- eXo Platform configuration

- Database configuration

- File system paths

- JCR system and default workspaces

- JCR

## 2.6. Mail server

### Note

The Mail portlet and its services are deprecated. It remains fully supported for eXo customers, however it will not receive any enhancement and will be removed from the product scope in the future.

eXo Platform requires the SMTP server to send emails, such as notifications or password reminders.

The Email service can use any SMTP account that needs to be configured in /server/default/conf/gatein/configuration.properties (Or $PLATFORM_TOMCAT_HOME/ gatein/conf/configuration.properties if you are using Tomcat).

The relevant section looks like:

    #EMail

    # Domain name: Help for sending links from email notifications. The default domain name is http://localhost:8080.

    gatein.email.domain.url=http://localhost:8080

    # Email display in "from" field of email notification.

    gatein.email.smtp.from=noreply@exoplatform.com

    gatein.email.smtp.username=

    gatein.email.smtp.password=

    gatein.email.smtp.host=smtp.gmail.com

    gatein.email.smtp.port=465

    gatein.email.smtp.starttls.enable=true

    gatein.email.smtp.auth=true

    gatein.email.smtp.socketFactory.port=465

    gatein.email.smtp.socketFactory.class=javax.net.ssl.SSLSocketFactory

Some authenticated SMTP systems, such as GMail, GMX, MS Exchange, require the value for 'sender' or 'from' in the email message that must be identical to the SMTP user and host.

The Forum application uses it in the notification phase as the default sender. If it is not set, the sender will be empty.

gatein.email.domain.url | Domain name.
gatein.email.smtp.from | Sender's email address.
gatein.email.smtp.host | SMTP hostname.
gatein.email.smtp.port | SMTP port.
gatein.email.smtp.starttls.enable | True to enable the secure (TLS) SMTP. See RFC 3207.
gatein.email.smtp.auth | True to enable the SMTP authentication.
gatein.email.smtp.username | Username to send for authentication.
gatein.email.smtp.password | Password to send for authentication.
gatein.email.smtp.socketFactory.port | Specify the port to connect to when using the specified socket factory.
gatein.email.smtp.socketFactory.class | This class will be used to create SMTP sockets.

To see more details, refer to JavaMail API documentation.

For Knowledge, you have to modify the following properties to the configuration file /gatein/conf/configuration.properties to make sure that this mail service works with the authenticated SMTP systems:

    gatein.email.domain.url=http://localhost:8080

    gatein.email.smtp.from=noreply@exoplatform.com

### Note

The value of email address should be in a valid format.

`See also`

- eXo Platform configuration

- Database configuration

- File system paths

- Email-notification configuration for watching a document

## 2.7. Email-notification configuration for watching a document

eXo Platform 3.5 provides the Watch document function in Sites Explorer that allows you to receive email notifications of changes on your selected documents.

To customize the email notification, simply change the configuration in the configuration.properties file.

Files location

File | Tomcat | JBoss
--- | --- | ---
configuration.properties | $PLARFORM_TOMCAT_HOME/gatein/conf/configuration.properties | /server/default/conf/gatein/configuration.properties

The relevant section looks like:

    # Email content for WatchDocumentService

    gatein.ecms.watchdocument.sender=support@exoplatform.com

    gatein.ecms.watchdocument.subject=Your watching document is changed

    gatein.ecms.watchdocument.mimetype=text/html

    gatein.ecms.watchdocument.content=<![CDATA[Dear $user_name,<br><br>The document $doc_name ($doc_title) has changed.<br>

    <br>Please go to <a href="$doc_url">$doc_title</a> to see this change.<br><br>]]>

Details:

Property | Default value | Description
--- | --- | ---
gatein.ecms.watchdocument.sender | support@exoplatform.com | The email address of the sender.
gatein.ecms.watchdocument.subject | Your watching document is changed | The subject of the notification email.
gatein.ecms.watchdocument.mimetype | text/html | The mimeType which is used to write the notification email. There are two types: text/html and text/plain.
gatein.ecms.watchdocument.content | <![CDATA[Dear $user_name,<br><br>The document $doc_name ($doc_title) has changed.<br><br>Please go to <a href="$doc_url">$doc_title</a> to see this change.<br><br>]]> | The content of the notification email.

At present, eXo Platform provides 4 parameters below in the gatein.ecms.watchdocument.content property of the email:

- $user_name: The full name of the receiver.

- $doc_name: The name of the document.

- $doc_title: The title of the document.

- $doc_url: The link to view the document in Sites Explorer.

### Note

If the values above are not set in the configuration.properties file, the server will use the default values defined in an .xml file.

`See also`

- eXo Platform configuration

- Database configuration

- File system paths

- Mail server

## 2.8. WebDAV cache control

The embedded WebDAV server lets you control the cache-control HTTP header that transmits to clients by the MIME type. This is useful for fine-tuning your website.

The configuration property is exo.webdav.cache-control.

    exo.webdav.cache-control=text/*:max-age=3600;image/*:max-age=1800;*/*:no-cache;

The property expects a comma-separated list of key=pair values, where keys are a list of MIME types followed by the cache-control value to set.

`See also`

- eXo Platform configuration

- Database configuration

- File system paths

- Cache configuration

## 2.9. Chat server

### Note

The Chat portlet and its services are deprecated. It remains fully supported for eXo customers, however it will not receive any enhancement and will be removed from the product scope in the future.

XMPPMessenger

If you change the host name and port for the Chat server, you will need to edit two properties:

    # IP or hostname for the eXo Chat XMPP server
    exo.chat.server=127.0.0.1

    # TCP port for where the eXo Chat server listens for XMPP calls
    exo.chat.port=5222

Chat server configuration

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

Ports: 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.

`See also`

- eXo Platform configuration

- Database configuration

- File system paths

## 2.10. Office server

eXo Platform allows users to view various types of documents directly in the Sites Explorer through the office server. To do so, the office application must be available in your local device first.

Since eXo Platform 3.5.4, this service has been manually enabled/disabled by setting value of the wcm.jodconverter.enable parameter in configuration.properties.

- true: Activate JODConverter service. It's the default value when this parameter is missing.

- false: Deactivate JODConverter service. This service maybe does not work in several environment like Microsoft Windows. The performance is also gained when Office service is turned off. JODConverter will use the default values below to start the office server.

You can customize the default values by adding the properties below in the configuration.properties file:

    # JODConverter 3.0
    wcm.jodconverter.portnumbers=8100,8101,8102,8103,8104
    wcm.jodconverter.officehome=/usr/lib/libreoffice
    wcm.jodconverter.taskqueuetimeout=30000
    wcm.jodconverter.taskexecutiontimeout=120000
    wcm.jodconverter.maxtasksperprocess=200
    wcm.jodconverter.retrytimeout=120000

Key | Default value | Description
--- | --- | ---
wcm.jodconverter.portnumbers | 2002 | List of ports, separated by commas, those used by each JODConverter processing thread. The number of office instances is equal to the number of ports.
wcm.jodconverter.officehome | See here | The absolute path to the office home on the current local device. It means that the office needs to be installed in the local device before using it.
wcm.jodconverter.taskqueuetimeout | 30000 | The maximum living time of a task in the conversation queue. The task will be removed out of the queue if the waiting time is longer than taskQueueTimeout.
wcm.jodconverter.taskexecutiontimeout | 120000 | The maximum time to process a task. If the processing time of a task is longer than taskExecutionTimeout, this task will be aborted and the next task is processed.
wcm.jodconverter.maxtasksperprocess | 200 | The maximum number of tasks are processed.
wcm.jodconverter.retrytimeout | 120000 | The interval time to try to restart the office services after an unexpected crash.

The default office home

- Linux

    "/opt/openoffice.org3"
    "/opt/libreoffice"
    "/usr/lib/openoffice"
    "/usr/lib/libreoffice"

- Windows

    "<SYSTEM_PROGRAMFILES>/OpenOffice.org 3"
    "<SYSTEM_PROGRAMFILES>/LibreOffice 3"

- Mac

    "/Applications/OpenOffice.org.app/Contents"
    "/Applications/LibreOffice.app/Contents"

`See also`

- eXo Platform configuration

- Database configuration

- File system paths

## 2.11. Logs

The logs of eXo Platform are controlled by the Java Logging API.

By default, the logs are configured to:

- log errors and warnings on the console.

- log /gatein/logs/gatein-YYYY-MM-DD.log.

In Tomcat, the logs are configured via the conf/logging.properties file. Please refer to Tomcat's Logging Documentation for more information on how to adjust this file to your needs.

`See also`

- eXo Platform configuration

- Database configuration

- File system paths

## 2.12. JCR

The set of properties controls the JCR behaviour.

    # Type of JCR configuration to use. Possible values are:
    # local : local JBC configuration
    # cluster : cluster JBC configuration
    gatein.jcr.config.type=local

    ....

    # JCR dialect.
    # auto : enabled auto detection
    gatein.jcr.datasource.dialect=auto

    # JCR Session Registry configuration
    # Define here the Max Age of the JCR Session in the session registry (in seconds)
    gatein.jcr.sessionregistry.sessionmaxage=300

    # JCR cache configuration
    gatein.jcr.cache.config=file:${gatein.conf.dir}/jcr/jbosscache/${gatein.jcr.config.type}/cache-config.xml
    gatein.jcr.cache.expiration.time=15m

    # JCR Locks configuration
    gatein.jcr.lock.cache.config=file:${gatein.conf.dir}/jcr/jbosscache/${gatein.jcr.config.type}/lock-config.xml

    # JCR Index configuration
    gatein.jcr.index.cache.config=file:${gatein.conf.dir}/jcr/jbosscache/${gatein.jcr.config.type}/indexer-config.xml

    # JGroups configuration
    # for eXo Cache and IDM org-service (in cluster cache-config.xml files)
    gatein.jgroups.config=${gatein.conf.dir}/jgroups/jgroups-udp.xml
    # for JCR
    gatein.jcr.jgroups.config=file:${gatein.jgroups.config}

Details:

`gatein.jcr.config.type` | Set to cluster if you want to use eXo Platform in the cluster mode. Otherwise, leave local.
`gatein.jcr.cache.config` | Path to the JBoss Cache configuration for the JCR cache.
`gatein.jcr.cache.expiration.time` | JCR cache expiration time.
`gatein.jcr.lock.cache.config` | Path to the JBoss Cache configuration for the JCR lock.
`gatein.jcr.index.cache.config` | Path to the JBoss Cache configuration for the JCR index.
`gatein.jgroups.config` | Path to the JGroups configuration to use for the cluster mode of eXo Cache and PicketLink IDM organization service (see below in IDM caches).
`gatein.jcr.jgroups.config` | Path to the JGroups configuration to use for the cluster mode.

For more details on configuring these files, please refer to the eXo JCR Reference Guide.

`See also`

- eXo Platform configuration

- Database configuration

- File system paths

## 2.13. Cache configuration

Portal Cache Configuration

    # Portal Cache Configuration - TemplateService
    cache.exo.portal.TemplateService.capacity=3000
    cache.exo.portal.TemplateService.liveTime=600

    # Portal Cache Configuration - ResourceBundleData
    cache.exo.portal.ResourceBundleData.capacity=3000
    cache.exo.portal.ResourceBundleData.liveTime=600

    # Portal Cache Configuration - MOPSessionManager
    cache.exo.portal.MOPSessionManager.Capacity=5000
    cache.exo.portal.MOPSessionManager.TimeToLive=60000
    cache.exo.portal.MOPSessionManager.ExpirationTimeout=60000

Cache Name | Description
--- | ---
`TemplateService` | Cache all Groovy templates of portal by its template path and ResourceResolver.
`ResourceBundleData` | Cache all resource bundles by name and locale.
`MOPSessionManager` | Cache all model objects of portal by storageId, such as pages, navigations, and preferences.

Social Cache Configuration

    # Social Cache Configuration - IdentityCache
    cache.exo.social.IdentityCache.Capacity:300
    cache.exo.social.IdentityCache.TimeToLive:-1

    # Social Cache Configuration - IdentityIndexCache
    cache.exo.social.IdentityIndexCache.Capacity:300
    cache.exo.social.IdentityIndexCache.TimeToLive:-1

    # Social Cache Configuration - ProfileCache
    cache.exo.social.ProfileCache.Capacity:300
    cache.exo.social.ProfileCache.TimeToLive:-1

    # Social Cache Configuration - IdentitiesCountCache
    cache.exo.social.IdentitiesCountCache.Capacity:2000
    cache.exo.social.IdentitiesCountCache.TimeToLive:86400

    # Social Cache Configuration - IdentitiesCache
    cache.exo.social.IdentitiesCache.Capacity:2000
    cache.exo.social.IdentitiesCache.TimeToLive:86400

    # Social Cache Configuration - RelationshipCache
    cache.exo.social.RelationshipCache.Capacity:10000
    cache.exo.social.RelationshipCache.TimeToLive:-1

    # Social Cache Configuration - RelationshipFromIdentityCache
    cache.exo.social.RelationshipFromIdentityCache.Capacity:10000
    cache.exo.social.RelationshipFromIdentityCache.TimeToLive:-1

    # Social Cache Configuration - RelationshipsCountCache
    cache.exo.social.RelationshipsCountCache.Capacity:800
    cache.exo.social.RelationshipsCountCache.TimeToLive:-1

    # Social Cache Configuration - RelationshipsCache
    cache.exo.social.RelationshipsCache.Capacity:800
    cache.exo.social.RelationshipsCache.TimeToLive:-1

    # Social Cache Configuration - ActivityCache
    cache.exo.social.ActivityCache.Capacity:6000
    cache.exo.social.ActivityCache.TimeToLive:-1

    # Social Cache Configuration - ActivitiesCountCache
    cache.exo.social.ActivitiesCountCache.Capacity:4000
    cache.exo.social.ActivitiesCountCache.TimeToLive:-1

    # Social Cache Configuration - ActivitiesCache
    cache.exo.social.ActivitiesCache.Capacity:4000
    cache.exo.social.ActivitiesCache.TimeToLive:-1

    # Social Cache Configuration - SpaceCache
    cache.exo.social.SpaceCache.Capacity:100
    cache.exo.social.SpaceCache.TimeToLive:-1

    # Social Cache Configuration - SpaceRefCache
    cache.exo.social.SpaceRefCache.Capacity:400
    cache.exo.social.SpaceRefCache.TimeToLive:-1

    # Social Cache Configuration - SpacesCountCache
    cache.exo.social.SpacesCountCache.Capacity:2000
    cache.exo.social.SpacesCountCache.TimeToLive:86400

    # Social Cache Configuration - SpacesCache
    cache.exo.social.SpacesCache.Capacity:2000
    cache.exo.social.SpacesCache.TimeToLive:86400

Cache Name | Description
--- | ---
`IdentityCache` | Cache identity by IdentityKey (based on the identity ID) .
`IdentityIndexCache` | Cache identity index by IdentityCompositeKey (based on the provider ID and the remote ID).
`ProfileCache` | Cache profile by IdentityKey (based on the identity ID).
`IdentitiesCountCache` | Cache identity count by IdentityFilterKey (based on the provider ID, remote ID, name, positon, company, skills, first character of the identity, and the List<IdentityKey>).
`IdentitiesCache` | Cache identity list by ListIdentitiesKey (based on IdentityFilterKey, offset, limit).
`RelationshipCache` | Cache relationship by RelationshipKey (based on the ID of the relationship).
`RelationshipFromIdentityCache` | Cache relationship key by RelationshipIdentityKey (based on the identity ID of 2 users which have relationship).
`RelationshipsCountCache` | Cache relationship count by RelationshipCountKey.
`RelationshipsCache` | Cache list identity wich have relation by ListRelationshipsKey.
`ActivityCache` | Cache activity by ActivityKey (based on the activity ID).
`ActivitiesCountCache` | Cache count of activities by activity ID, identity ID (the identity who makes request) and the type of activity.
`ActivitiesCache` | Cache activities list by ListActivitiesKey.
`SpaceCache` | Cache space by SpaceKey (based on the space ID).
`SpaceRefCache` | Cache ref space by SpaceRefKey (base on the display name, pretty name, group ID and the space URL).
`SpacesCountCache` | Cache spaces count by spaceFilterKey (based on the user ID, the first character of space name, the space name search condition, and space type (MEMBER,PENDING,INVITED,PUBLIC,ACCESSIBLE, VISIBLE, EDITABLE, ALL)).
`SpacesCache` | Cache list space by ListSpacesKey (based on SpaceFilterKey, offset and limit).

ECMS Cache Configuration

    # ECMS Cache Configuration - Viewer
    cache.exo.ecms.Viewer.PDFViewer.Capacity=300
    cache.exo.ecms.Viewer.PDFViewer.TimeToLive=3600

    # ECMS Cache Configuration - Drives
    cache.exo.ecms.Drives.ManageDrive.Capacity=300
    cache.exo.ecms.Drives.ManageDrive.TimeToLive=86400

    # ECMS Cache Configuration - Scripts
    cache.exo.ecms.Scripts.ScriptService.Capacity=300
    cache.exo.ecms.Scripts.ScriptService.TimeToLive=86400

    # ECMS Cache Configuration - Templates
    cache.exo.ecms.Templates.TemplateService.Capacity=300
    cache.exo.ecms.Templates.TemplateService.TimeToLive=86400

    # ECMS Cache Configuration - Webcontent
    cache.exo.ecms.Webcontent.InitialWebContentPlugin.Capacity=300
    cache.exo.ecms.Webcontent.InitialWebContentPlugin.TimeToLive=600

    # ECMS Cache Configuration - WCM Composer
    cache.exo.ecms.WCMComposer.Capacity=1000
    cache.exo.ecms.WCMComposer.TimeToLive=3600

Cache Name | Description
--- | ---
`PDFViewerREST` | Cache data of PDF files by the ObjectKey object.
`ManageDrive` | Cache all drives of Sites Explorer by the drive group name (String constant).
`ScriptService` | Cache all Groovy script files by the script name.
`TemplateService` | Cache all Groovy templates by the mechanism of org.exoplatform.groovyscript. text.TemplateService.
`InitialWebContentPlugin` | Cache all artifact data by sourcePath of deploymentDescriptor. These data are reused when a new portal is deployed.
`WCMComposer` | Cache published contents by the hash generated from path, version, remoteUser, language, recursive, orderBy, orderType, primaryType of cached nodes in Content.

### Note

To further understand about the cache configuration, refer to the Cache Levelscontent in eXo Platform User Guide and the Cache management view section in this document.

PageRenderingCache Configuration

    # Page rendering cache setting
    cache.exo.wiki.PageRenderingCache.Capacity=1000
    cache.exo.wiki.PageRenderingCache.TimeToLive=-1

Cache Name | Description
--- | ---
`PageRenderingCache` | Cache a rendered content of a wiki page.

`See also`

- eXo Platform configuration

- Database configuration

- File system paths

- Users configuration

- Gadget configuration

## 2.14. Users configuration

- Super-user configuration

  Definition of a super-user and the way to set a user account as the super-user.

- Grant users access to toolbar

  Steps to grant users access to toolbar in 2 usecases: access to toolbar but not CMS, and access to both the toolbar and the underlying CMS implementation.

### Note

In eXo Platform, the default users, excluding Super-admin user, are defined in "Acme WebSite" and "Office Intranet" extensions. By deleting those extensions, the users "john", "demo", "james" and "mary" will not be created.

`See also`

- eXo Platform configuration

- Database configuration

- File system paths

### 2.14.1. Super-user configuration

Super-user is a special user who has full privileges and can do anything. However, only one user account may be declared as the super-user. By default, the super-user is set to the "root" user. The "root" user is preconfigured as below:

- Account details: Root, Root, root@localhost.

- Memberships: member:/organization/management/executive-board, *:/platform/administrators, *:/platform/users, *:/platform/web-contributors, *:/organization/employees.

- All permissions on folders and other users.

- Permission to use some locked features in eXo Platform.

For example, if you want to set a user account as the super-user, you can configure it as follows:

### Note

You must do this configuration before the first boot of eXo Platform.

1. Modify the system property named exo.super.user defined in configuration.properties before starting eXo platform.

    # Super User declaration

    exo.super.user=root

2. Make sure the user whom you want to set as the "super-user" already exists into your configuration. By default, the users including "john", "demo", "james" and "mary" are created.

3. Remove the "root" user declaration defined in the organization-configuration.xml file:

    <field name="user">

      <collection type="java.util.ArrayList">

        <value>

          <object type="org.exoplatform.services.organization.OrganizationConfig$User">

            <field name="userName">

              <string>${exo.super.user}</string>

            </field>

            <field name="password">

              <string>gtn</string>

            </field>

            <field name="firstName">

              <string>Root</string>

            </field>

            <field name="lastName">

              <string>Root</string>

            </field>

            <field name="email">

              <string>root@localhost</string>

            </field>

            <field name="groups">

              <string>*:/platform/administrators,*:/platform/users,*:/platform/web-contributors,*:/organization/employees

              </string>

            </field>

          </object>

        </value>

      </collection>

    </field>

4. Add some privileges to your user into the organization-configuration.xml file.

Files location

File | Tomcat | JBoss
--- | --- | ---
organization-configuration.xml | $PLATFORM_TOMCAT_HOME/webapps/platform-extension/WEB-INF/conf/organization/ | $PLATFORM_JBOSS_HOME/default/deploy/exo-platform-extension-$PLF_Version.ear/WEB-INF/conf/organization/

For example:

- Set the "demo" user as a super-user.

    # Super User declaration

    exo.super.user=demo

- Assign some privileges to the "demo" user:

    <value>

        <object type="org.exoplatform.services.organization.OrganizationConfig$User">

          <field name="userName">

            <string>demo</string>

          </field>

          <field name="password">

            <string>gtn</string>

          </field>

          <field name="firstName">

            <string>Jack</string>

          </field>

          <field name="lastName">

            <string>Miller</string>

          </field>

          <field name="email">

            <string>jack.miller@acme.exoplatform.com</string>

          </field>

          <field name="groups">

            <string>*:/platform/administrators,*:/platform/users,*:/platform/web-contributors,*:/organization/employees</string>

          </field>

        </object>

    </value>

### 2.14.2. Grant users access to toolbar

Grant all users access to toolbar but not CMS

If all new members require access to the toolbar (but NOT the Content Management System (CMS)), administrators can change the default portal behavior to meet your request by doing the following steps:

1. Define the group of new members in the organization-configuration.xml file defined in the path tomcat/webapps/ecmdemo/WEB-INF/conf/sample-portal/portal/organization-configuration.xml.

    <component-plugin>

          <name>wcm.new.user.event.listener</name>

          <set-method>addListenerPlugin</set-method>

          <type>org.exoplatform.services.organization.impl.NewUserEventListener</type>

          <description>this listener assign group and membership to a new created user</description>

          <init-params>

            <object-param>

              <name>configuration</name>

              <description>description</description>

              <object type="org.exoplatform.services.organization.impl.NewUserConfig">

                <field name="group">

                  <collection type="java.util.ArrayList">

                    <value>

                      <object type="org.exoplatform.services.organization.impl.NewUserConfig$JoinGroup">

                        <field name="groupId"><string>/platform/users</string></field>

                        <field name="membership"><string>member</string></field>

                      </object>

                    </value>

                  </collection>

                </field>

                <field name="ignoredUser">

                  <collection type="java.util.HashSet">

                    <value><string>james</string></value>

                  </collection>

                </field>

              </object>

            </object-param>

          </init-params>

    </component-plugin>

The sample configuration above sets the group of new users to the /platform/users group with the member role.

2. Customize the value of `<access-permissions>` in the sharedlayout.xml file defined in the path tomcat/webapps/ecm-wcm-extension/WEB-INF/conf/portal/portal/sharedlayout.xml file as follows:

    <container template="system:/groovy/portal/webui/container/UIContainer.gtmpl">

         <container template="system:/groovy/portal/webui/container/UIToolbarContainer.gtmpl">

              <!-- users containing to the following group can see the top toolbar -->

           <access-permissions>*:/platform/users</access-permissions>

           ...........................

         </container>

    </container>

3. Restart the server.

Grant all new users access to toolbar and CMS

If all users require access to both the toolbar and the underlying CMS implementation, administrators can change the default portal behavior to grant the appropriate permissions to newly registered users:

1. Do the same as Step 1 and Step 2 of "Grant all users access to toolbar but not CMS".

2. Edit the organization-configuration.xml file and add /platform/web-contributors to wcm.new.user.event.listener. See the example below:

    <component-plugin>

          <name>wcm.new.user.event.listener</name>

          <set-method>addListenerPlugin</set-method>

          <type>org.exoplatform.services.organization.impl.NewUserEventListener</type>

          <description>this listener assign group and membership to a new created user</description>

          <init-params>

            <object-param>

              <name>configuration</name>

              <description>description</description>

              <object type="org.exoplatform.services.organization.impl.NewUserConfig">

                <field name="group">

                  <collection type="java.util.ArrayList">

                    <value>

                      <object type="org.exoplatform.services.organization.impl.NewUserConfig$JoinGroup">

                        <field name="groupId"><string>/platform/users</string></field>

                        <field name="membership"><string>member</string></field>

                      </object>

                    </value>

                    <!-- new users should also be a member of the web-contributors group to see the top toolbar -->

                    <value>

                      <object type="org.exoplatform.services.organization.impl.NewUserConfig$JoinGroup">

                        <field name="groupId"><string>/platform/web-contributors</string></field>

                        <field name="membership"><string>member</string></field>

                      </object>

                    </value>

                  </collection>

                </field>

                <field name="ignoredUser">

                  <collection type="java.util.HashSet">

                    <value><string>james</string></value>

                  </collection>

                </field>

              </object>

            </object-param>

          </init-params>

    </component-plugin>

3. Restart the server.

## 2.15. Gadget configuration

Default OAuth key configuration

In eXo Platform, OAuth gadgets use a OAuth key to authorize with external service providers. There is always a default key defined in the oauthkey.pem file. This key will be used in case the OAuth gadgets do not indicate a key. It is strongly recommended that you create your own oauthkey.pem file by using the openssl tool and some commands as follows:

    openssl req -newkey rsa:1024 -days 365 -nodes -x509 -keyout testkey.pem -out testkey.pem -subj '/CN=mytestkey'
    openssl pkcs8 -in testkey.pem -out oauthkey.pem -topk8 -nocrypt -outform PEM

After creating the new oauthkey.pem file, you can use it to replace the default oauthkey.pem file in the data/gadgets/ folder.

Files location

File | Tomcat | JBoss
--- | --- | ---
oauthkey.pem | $PLATFORM_TOMCAT_HOME/gatein/gadgets | $PLATFORM_JBOSS_HOME/server/<PROFILE>/data/gadgets

`See also`

- eXo Platform configuration

- Database configuration

- File system paths

## 2.16. Other properties

    # navigation controller file
    gatein.portal.controller.config=${gatein.conf.dir}/controller.xml

    # global portlet.xml
    gatein.portlet.config=${gatein.conf.dir}/portlet.xml

    # JNDI Name of the IDM datasource
    # portal name will be appended to this name before the JNDI lookup
    # example : java:/comp/env/exo-idm in "portal" portal will result in a JNDI lookup on context : java:/comp/env/exo-idm_portal
    gatein.idm.datasource.name=java:exo-idm
    # Optional database schema for use with IDM tables (empty by default), uncomment this line to specify required schema name
    #gatein.idm.datasource.schema=EXO1

    # IDM
    gatein.portal.idm.createuserportal=false
    gatein.portal.idm.destroyuserportal=true

    # IDM caches
    gatein.idm.api.cache.config=file:${gatein.conf.dir}/idm/jbosscache/${gatein.jcr.config.type}/api-cache-config.xml
    gatein.idm.store.cache.config=file:${gatein.conf.dir}/idm/jbosscache/${gatein.jcr.config.type}/store-cache-config.xml

    # Key files for gadget
    gatein.gadgets.securitytokenkeyfile=${exo.shared.dir}/gadgets/key.txt
    gatein.gadgets.signingkeyfile=${exo.shared.dir}/gadgets/oauthkey.pem

`See also`

- eXo Platform configuration

- Database configuration

- File system paths

Copyright © 2009-2012. All rights reserved. eXo Platform SAS