exoplatform/exo
eXo Platform inside a Docker container.
100K+
-
Image | JDK | eXo Platform |
---|---|---|
exoplatform/exo:7.0_latest | 17 | 7.0.x Enterprise edition |
exoplatform/exo:6.5_latest | 17 | 6.5.x Enterprise edition |
exoplatform/exo:6.4_latest | 17 | 6.4.x Enterprise edition |
exoplatform/exo:6.3_latest | 11 | 6.3.x Enterprise edition |
exoplatform/exo:6.2_latest | 11 | 6.2.x Enterprise edition |
exoplatform/exo:6.1_latest | 11 | 6.1.x Enterprise edition |
exoplatform/exo:6.0_latest | 11 | 6.0.x Enterprise edition |
exoplatform/exo:5.3_latest | 8 | 5.3.x Enterprise edition |
exoplatform/exo:5.2_latest (changelog) | 8 | 5.2.x Enterprise edition |
exoplatform/exo:5.1_latest (changelog) | 8 | 5.1.x Enterprise edition |
exoplatform/exo:5.0_latest (changelog) | 8 | 5.0.x Enterprise edition |
exoplatform/exo:4.4_latest (changelog) | 8 | 4.4.x Enterprise edition |
exoplatform/exo:4.3_latest | 8 | 4.3.x Enterprise edition |
The image is compatible with the following databases system : MySQL
(default) / HSQLDB
/ PostgreSQL
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
...
Some add-ons are already installed in eXo image but you can install other one or remove some of the pre-installed one :
VARIABLE | MANDATORY | DEFAULT VALUE | DESCRIPTION |
---|---|---|---|
EXO_ADDONS_LIST | NO | - | commas separated list of add-ons to install (ex: exo-answers,exo-skype:1.0.x-SNAPSHOT) |
EXO_ADDONS_REMOVE_LIST | NO | - | commas separated list of add-ons to uninstall (ex: exo-chat) (since: 4.4.2_3) |
EXO_ADDONS_CATALOG_URL | NO | - | The url of a valid eXo Catalog |
EXO_ADDONS_CONFLICT_MODE | NO | - | decision to make in case of file conflicts (overwrite, ignore or fail) |
EXO_ADDONS_NOCOMPAT_MODE | NO | false | decision to allow to install incompatible addon |
EXO_ADDONS_INSTALL_TIMEOUT | NO | 120 | timeout to install an addon (in seconds) |
Patches can be deployed in eXo image :
VARIABLE | MANDATORY | DEFAULT VALUE | DESCRIPTION |
---|---|---|---|
EXO_PATCHES_LIST | NO | - | commas separated list of patches to install (ex: patch-4.4.4:1,patch-4.4.4:2) |
EXO_PATCHES_CATALOG_URL | YES | - | The url of a valid eXo Patches Catalog (mandatory if something is specified in EXO_PATCHES_LIST) |
The standard eXo Platform environment variables can be used :
VARIABLE | MANDATORY | DEFAULT VALUE | DESCRIPTION |
---|---|---|---|
EXO_JVM_SIZE_MIN | NO | 512m | specify the jvm minimum allocated memory size (-Xms parameter) |
EXO_JVM_SIZE_MAX | NO | 3g | specify the jvm maximum allocated memory size (-Xmx parameter) |
EXO_JVM_PERMSIZE_MAX | NO | 256m | (Java 7) specify the jvm maximum allocated memory to Permgen (-XX:MaxPermSize parameter) |
EXO_JVM_METASPACE_SIZE_MAX | NO | 512m | (Java 8+) specify the jvm maximum allocated memory to MetaSpace (-XX:MaxMetaspaceSize parameter) |
EXO_JVM_USER_LANGUAGE | NO | en | specify the jvm locale for langage (-Duser.language parameter) |
EXO_JVM_USER_REGION | NO | US | specify the jvm local for region (-Duser.region parameter) |
EXO_JVM_LOG_GC_ENABLED | NO | false | activate the JVM GC log file generation (location: $EXO_LOG_DIR/platform-gc.log) |
INFO: This list is not exhaustive (see eXo Platform documentation or {EXO_HOME}/bin/setenv.sh for more parameters)
The following environment variables must be passed to the container to configure Tomcat proxy settings:
VARIABLE | MANDATORY | DEFAULT VALUE | DESCRIPTION |
---|---|---|---|
EXO_PROXY_VHOST | NO | localhost | specify the virtual host name to reach eXo Platform |
EXO_PROXY_PORT | NO | - | which port to use on the proxy server ? (if empty it will automatically defined regarding EXO_PROXY_SSL value : true => 443 / false => 80) |
EXO_PROXY_SSL | NO | true | is ssl activated on the proxy server ? (true / false) |
The following environment variables can be passed to the container to configure Tomcat settings
VARIABLE | MANDATORY | DEFAULT VALUE | DESCRIPTION |
---|---|---|---|
EXO_HTTP_THREAD_MAX | NO | 200 | maximum number of threads in the tomcat http connector |
EXO_HTTP_THREAD_MIN | NO | 10 | minimum number of threads ready in the tomcat http connector |
EXO_ACCESS_LOG_ENABLED | NO | false | activate Tomcat access log with combine format and a daily log file rotation |
EXO_GZIP_ENABLED | NO | true | activate Tomcat Gzip compression for assets mimetypes |
EXO_CONNECTION_TIMEOUT | NO | 20000 | Tomcat Connection timeout |
EXO_SESSION_TIMEOUT | NO | 30 | Tomcat session timeout (minutes) |
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
The following environment variables must be passed to the container in order to work :
VARIABLE | MANDATORY | DEFAULT VALUE | DESCRIPTION |
---|---|---|---|
EXO_DATA_DIR | NO | /srv/exo | the directory to store eXo Platform data |
EXO_JCR_STORAGE_DIR | NO | ${EXO_DATA_DIR}/jcr/values | the directory to store eXo Platform JCR values data |
EXO_JCR_FS_STORAGE_ENABLED | NO | Default value of eXo Server | Whether to store JCR Binary files in RDBMS or File system. Possible values: true (=FS) OR false (=DB) |
EXO_FILE_STORAGE_DIR | NO | ${EXO_DATA_DIR}/files | the directory to store eXo Platform data |
EXO_FILE_STORAGE_TYPE | NO | Default value of eXo Server | Whether to store Files API Binary files in RDBMS or File system. Possible values: rdbms OR fs |
EXO_FILE_STORAGE_RETENTION | NO | 30 | the number of days to keep deleted files on disk before definitively remove it from the disk |
EXO_UPLOAD_MAX_FILE_SIZE | NO | 200 | maximum authorized size for file upload in MB. |
EXO_FILE_UMASK | NO | 0022 | the umask used for files generated by eXo |
The following environment variables must be passed to the container in order to work :
VARIABLE | MANDATORY | DEFAULT VALUE | DESCRIPTION |
---|---|---|---|
EXO_DB_TYPE | NO | mysql | mysql / hsqldb / pgsql / ora |
EXO_DB_HOST | NO | mysql | the host to connect to the database server |
EXO_DB_PORT | NO | 3306 | the port to connect to the database server |
EXO_DB_NAME | NO | exo | the name of the database / schema to use |
EXO_DB_USER | NO | exo | the username to connect to the database |
EXO_DB_PASSWORD | YES | - | the password to connect to the database |
EXO_DB_POOL_IDM_INIT_SIZE | NO | 5 | the init size of IDM datasource pool |
EXO_DB_POOL_IDM_MAX_SIZE | NO | 20 | the max size of IDM datasource pool |
EXO_DB_POOL_JCR_INIT_SIZE | NO | 5 | the init size of JCR datasource pool |
EXO_DB_POOL_JCR_MAX_SIZE | NO | 20 | the max size of JCR datasource pool |
EXO_DB_POOL_JPA_INIT_SIZE | NO | 5 | the init size of JPA datasource pool |
EXO_DB_POOL_JPA_MAX_SIZE | NO | 20 | the max size of JPA datasource pool |
EXO_DB_TIMEOUT | NO | 60 | the number of seconds to wait for database availability before cancelling eXo startup |
MySQL
VARIABLE | MANDATORY | DEFAULT VALUE | DESCRIPTION |
---|---|---|---|
EXO_DB_MYSQL_USE_SSL | NO | false | connecting securely to MySQL using SSL (see MySQL Connector/J documentation for useSSL parameter) |
eXo Chat is available in 2 flavors :
A switch is available to enable the standalone mode :
VARIABLE | MANDATORY | DEFAULT VALUE | DESCRIPTION |
---|---|---|---|
EXO_CHAT_SERVER_STANDALONE | NO | false | are you using a standalone version of eXo Chat server |
embedded
With eXo Chat embedded mode, the client and server part of the chat feature are installed in eXo container.
exo-chat:<VERSION>
The following environment variables should be passed to eXo container to configure eXo Chat :
VARIABLE | MANDATORY | DEFAULT VALUE | DESCRIPTION |
---|---|---|---|
EXO_MONGO_HOST | NO | mongo | the hostname to connect to the mongodb database for eXo Chat |
EXO_MONGO_PORT | NO | 27017 | the port to connect to the mongodb server |
EXO_MONGO_USERNAME | NO | - | the username to use to connect to the mongodb database (no authentication configured by default) |
EXO_MONGO_PASSWORD | NO | - | the password to use to connect to the mongodb database (no authentication configured by default) |
EXO_MONGO_DB_NAME | NO | chat | the mongodb database name to use for eXo Chat |
EXO_MONGO_TIMEOUT | NO | 60 | the number of seconds to wait for mongodb availability before cancelling eXo startup |
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).
exo-chat-client:<VERSION>
The following environment variables should be passed to eXo container to configure eXo Chat client :
VARIABLE | MANDATORY | DEFAULT VALUE | DESCRIPTION |
---|---|---|---|
EXO_CHAT_SERVER_URL | NO | http://localhost:8080 | the url of the eXo Chat server (only needed for eXo Chat standalone edition) |
EXO_CHAT_SERVER_PASSPHRASE | NO | something2change | the passphrase to secure the communication with eXo Chat standalone server (only used for eXo Chat standalone edition) |
The following environment variables should be passed to the container in order to configure the search feature :
VARIABLE | MANDATORY | DEFAULT VALUE | DESCRIPTION |
---|---|---|---|
EXO_ES_SCHEME | NO | http | the elasticsearch server scheme to use from the eXo Platform server jvm perspective (http / https). |
EXO_ES_HOST | NO | localhost | the elasticsearch server hostname to use from the eXo Platform server jvm perspective. |
EXO_ES_PORT | NO | 9200 | the elasticsearch server port to use from the eXo Platform server jvm perspective. |
EXO_ES_USERNAME | NO | - | the username to connect to the elasticsearch server (if authentication is activated on the external elasticsearch). |
EXO_ES_PASSWORD | NO | - | the password to connect to the elasticsearch server (if authentication is activated on the external elasticsearch). |
EXO_ES_INDEX_REPLICA_NB | NO | 0 | the number of replicat for elasticsearch indexes (leave 0 if you don't have an elasticsearch cluster). |
EXO_ES_INDEX_SHARD_NB | NO | 0 | the number of shard for elasticsearch indexes. |
EXO_ES_TIMEOUT | NO | 60 | the number of seconds to wait for elasticsearch availability before cancelling eXo startup |
The following environment variables should be passed to the container in order to configure the ldap connection pool :
VARIABLE | MANDATORY | DEFAULT VALUE | DESCRIPTION |
---|---|---|---|
EXO_LDAP_POOL_DEBUG | NO | - | the level of debug output to produce. Valid values are "fine" (trace connection creation and removal) and "all" (all debugging information). |
EXO_LDAP_POOL_TIMEOUT | NO | 60000 | the number of milliseconds that an idle connection may remain in the pool without being closed and removed from the pool. |
EXO_LDAP_POOL_MAX_SIZE | NO | 100 | the maximum number of connections per connection identity that can be maintained concurrently. |
The following environment variables should be passed to the container in order to configure the mail server configuration to use :
VARIABLE | MANDATORY | DEFAULT VALUE | DESCRIPTION |
---|---|---|---|
EXO_MAIL_FROM | NO | noreply@exoplatform.com | "from" field of emails sent by eXo platform |
EXO_MAIL_SMTP_HOST | NO | localhost | SMTP Server hostname |
EXO_MAIL_SMTP_PORT | NO | 25 | SMTP Server port |
EXO_MAIL_SMTP_STARTTLS | NO | false | true to enable the secure (TLS) SMTP. See RFC 3207. |
EXO_MAIL_SMTP_USERNAME | NO | - | authentication username for smtp server (if needed) |
EXO_MAIL_SMTP_PASSWORD | NO | - | authentication password for smtp server (if needed) |
EXO_SMTP_SSL_ENABLED | NO | false | true to enable SSL connection |
EXO_MAIL_SSL_SOCKETFACTORY_PORT | NO | ${EXO_MAIL_SMTP_PORT} | ssl socketfactory port (default smtp port) |
EXO_SMTP_SSL_PROTOCOLS | NO | - | tls version for smtp server (if needed) |
The following environment variables should be passed to the container in order to configure JMX :
VARIABLE | MANDATORY | DEFAULT VALUE | DESCRIPTION |
---|---|---|---|
EXO_JMX_ENABLED | NO | true | activate JMX listener |
EXO_JMX_RMI_REGISTRY_PORT | NO | 10001 | JMX RMI Registry port |
EXO_JMX_RMI_SERVER_PORT | NO | 10002 | JMX RMI Server port |
EXO_JMX_RMI_SERVER_HOSTNAME | NO | localhost | JMX RMI Server hostname |
docker pull exoplatform/exo