exoplatform/exo-community repository overview

⁠eXo Platform Community Docker image

The eXo Platform Community edition Docker image support HSQLDB (for testing) and MySQL (for production).

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

• Quick start⁠
  • Easy way⁠
  • Advanced way⁠
• Configuration options⁠
  • JVM⁠
  • Frontend proxy⁠
  • Tomcat⁠
    • Data on disk⁠
  • Database⁠
    • MySQL⁠
  • ElasticSearch⁠
  • LDAP / Active Directory⁠
  • JOD Converter⁠
  • Mail⁠
  • JMX⁠
  • Remote Debugging⁠
  • Rememberme Token Expiration⁠
  • Reward Wallet⁠
  • Agenda⁠
• How-to⁠
  • configure eXo Platform behind a reverse-proxy⁠
  • use MySQL database⁠
  • see eXo Platform logs⁠
  • customize some eXo Platform settings⁠
• Image build⁠
• Image signature⁠

⁠Quick start

⁠Easy way : with docker-compose

Follow the quick start guide⁠

⁠Advanced way : with docker images

Follow the advanced guide⁠

⁠Configuration options

Configuration options are available here⁠

⁠How-to

⁠configure eXo Platform behind a reverse-proxy

You have to specify the following environment variables to configure eXo Platform (see upper section for more parameters and details) :

docker run -d \
  -p 8080:8080 \
  -e EXO_PROXY_VHOST="my.public-facing-hostname.org" \
  exoplatform/exo-community

You can also use Docker Compose (see the provided docker-compose.yml file as an example).

⁠use MySQL database

You have to specify the following environment variables to point to an external MySQL database server (see upper section for more parameters and details) :

docker run -d \
  -p 8080:8080 \
  -e EXO_DB_TYPE="mysql" \
  -e EXO_DB_HOST="mysql.server-hostname.org" \
  -e EXO_DB_USER="exo" \
  -e EXO_DB_PASSWORD="my-secret-pw" \
  exoplatform/exo-community

You can also use Docker Compose (see the provided docker-compose.yml file as an example).

⁠see eXo Platform logs

docker logs --follow <CONTAINER_NAME>

⁠customize some eXo Platform settings

All previously mentioned environment variables⁠ can be defined in a standard Docker way with -e ENV_VARIABLE="value" parameters :

docker run -d \
  -p 8080:8080 \
  -e EXO_JVM_SIZE_MAX="8g" \
  exoplatform/exo-community

Some eXo configuration properties⁠ can also be defined in an exo.properties file (starting from exoplatform/exo-community:5.1 version). In this case, just create this file and bind mount it in the Docker container :

docker run -d \
  -p 8080:8080 \
  -v /absolute/path/to/exo.properties:/etc/exo/exo.properties:ro \
  exoplatform/exo-community

⁠Image build

The simplest way to build this image is to use default values :

docker build -t exoplatform/exo-community .

This will produce an image with the current eXo Platform Community edition.

⁠Image Signature

⁠:octocat: ghcr.io Docker image signature

Starting with eXo Community 6.3 from the github container registry, eXo Community docker images will be signed with [cosign] (https://github.com/sigstore/cosign⁠) tool.

In order to verify the signature of the eXo Community docker image, please install the "cosign" command line tool. Then please follow these instructions:

• Save the following public key to cosign.pub file:

-----BEGIN PUBLIC KEY-----
MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEgYKR7SoWbXjHya1Bc2Ih3kX8wv8w
Y7StaVsRXzbcIL0jECiKzKarPxQQ69uVmZ6c0JEVQhBeN9w3pr75D4o2/A==
-----END PUBLIC KEY-----

• Execute the following command:

cosign verify --key cosign.pub ghcr.io/exo-docker/exo-community:<tag>

Example:

cosign verify --key cosign.pub ghcr.io/exo-docker/exo-community:6.4

Output:

[{"critical":{"identity":{"docker-reference":"ghcr.io/exo-docker/exo-community"},"image":{"docker-manifest-digest":"sha256:906afd0b16900e9ba...."},"type":"cosign container image signature"},"optional":{"Bundle":{"SignedEntryTimestamp":"MEQCIGtU3...","Payload":{"body":"eyJhcGlWZX....","integratedTime":1689844562,"logIndex":28114552,"logID":"c0d23d6..."}}}}]