eXo Platform Docker image

-

The image is compatible with the following databases system : MySQL (default) / HSQLDB / PostgreSQL

• Configuration options
  • Add-ons
  • Patches
  • JVM
  • Frontend proxy
  • Tomcat
  • Data on disk
  • Database
    • MySQL
  • eXo Chat
    • embedded
    • standalone
  • ElasticSearch
  • LDAP / Active Directory
  • Mail
  • JMX
  • Remote Debugging
  • Self-Signed Certifcates import
  • Rememberme Token Expiration
  • Cluster
  • Reward Wallet
  • Agenda
  • License
  • exo.properties
• Testing
• Image build

Configuration options

All the following options can be defined with standard Docker -e parameter

docker run -e MY_ENV_VARIABLE="value" ... exoplatform/exo

or Docker Compose way of defining environment variables

version: '2'
services:
...
  exo:
    image: exoplatform/exo
    environment:
...
      EXO_ADDONS_LIST: exo-chat
      EXO_PATCHES_LIST:
      EXO_PATCHES_CATALOG_URL:
      EXO_ES_HOST: search
...

Add-ons

Some add-ons are already installed in eXo image but you can install other one or remove some of the pre-installed one :

Patches

Patches can be deployed in eXo image :

JVM

The standard eXo Platform environment variables can be used :

INFO: This list is not exhaustive (see eXo Platform documentation or {EXO_HOME}/bin/setenv.sh for more parameters)

Frontend proxy

The following environment variables must be passed to the container to configure Tomcat proxy settings:

Tomcat

The following environment variables can be passed to the container to configure Tomcat settings

Valves and Listeners

A file containing the list of valves and listeners can be attached to the container in the path {{/etc/exo/host.yml}}. If a file is specified, the default valves and listeners configuration will be overridden.

The file format is :

components:
  - type: Valve
    className: org.acme.myvalves.WithoutAttributes
  - type: Valve
    className: org.acme.myvalves.WithAttributes
    attributes:
      - name: param1
        value: value1
      - name: param2
        value: value2
  - type: Listener
    className: org.acme.mylistener.WthAttributes
    attributes:
      - name: param1
        value: value1
      - name: param2
        value: value2

Data on disk

The following environment variables must be passed to the container in order to work :

Database

The following environment variables must be passed to the container in order to work :

MySQL

eXo Chat

eXo Chat is available in 2 flavors :

• embedded (default) : satisfy to most cases, the simplest to install and need only an external MongoDB instance.
• standalone : if you want to separate eXo and Chat JVM (for high throughput performance or architecture concerns).

A switch is available to enable the standalone mode :

embedded

With eXo Chat embedded mode, the client and server part of the chat feature are installed in eXo container.

• add-on to install : exo-chat:<VERSION>

The following environment variables should be passed to eXo container to configure eXo Chat :

INFO: an external MongoDB server should be installed

standalone

With eXo Chat standalone mode, only the client part of the chat feature is installed in eXo container. The server part must be installed separately in another container (doc⁠).

• add-on to install : exo-chat-client:<VERSION>
• eXo Chat standalone : see exoplatform/chat-server⁠ docker image documentation

The following environment variables should be passed to eXo container to configure eXo Chat client :

ElasticSearch

The following environment variables should be passed to the container in order to configure the search feature :

LDAP / Active Directory

The following environment variables should be passed to the container in order to configure the ldap connection pool :

Mail

The following environment variables should be passed to the container in order to configure the mail server configuration to use :

JMX

The following environment variables should be passed to the container in order to configure JMX :