meedsio/meeds repository overview

⁠Meeds Docker image

Meeds Docker image support HSQLDB (for testing).

⁠Quick start

The prerequisites are :

• Docker daemon version 12+ + internet access
• 4GB of available RAM + 1GB of disk

The most basic way to start Meeds Server for evaluation purpose is to execute

docker run -v meeds_data:/srv/meeds -p 8080:8080 meedsio/meeds

and then waiting the log line which say that the server is started.

When ready just go to http://localhost:8080⁠ and follow the instructions.

⁠Configuration options

⁠Add-ons

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

⁠JVM

The standard Meeds Server environment variables can be used :

⁠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

⁠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 :

⁠ElasticSearch

The following environment variables should be passed to the container in order to configure the search feature on an external Elastic Search server:

⁠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 :

With the default parameters you can connect to JMX with service:jmx:rmi://localhost:10002/jndi/rmi://localhost:10001/jmxrmi without authentication.

⁠Reward Wallet

The following environment variables should be passed to the container in order to configure Meeds Rewards wallet:

⁠How-to

⁠configure Meeds Server behind a reverse-proxy

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

docker run -d \
  -p 8080:8080 \
  -e MEEDS_PROXY_VHOST="my.public-facing-hostname.org" \
  meedsio/meeds

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

⁠see Meeds Server logs

docker logs --follow <CONTAINER_NAME>

⁠install Meeds Server add-ons

To install add-ons in the container, provide a commas separated list of add-ons you want to install in a MEEDS_ADDONS_LIST environment variable to the container:

docker run -d \
  -p 8080:8080 \
  -e MEEDS_ADDONS_LIST="meeds-wallet:2.0.x-SNAPSHOT" \
  meedsio/meeds

INFO: the provided add-ons list will be installed in the container during the container creation.

⁠list Meeds Server add-ons available

In a running container execute the following command:

docker exec <CONTAINER_NAME> /opt/meeds/addon list

⁠list Meeds Server add-ons installed

In a running container execute the following command:

docker exec <CONTAINER_NAME> /opt/meeds/addon list --installed

⁠customize some Meeds Server 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 MEEDS_JVM_SIZE_MAX="8g" \
  meedsio/meeds

Some eXo configuration properties⁠ can also be defined in an exo.properties file. 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/meeds/exo.properties:ro \
  meedsio/meeds

⁠Image build

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

    docker build -t meedsio/meeds .

This will produce an image with the current Meeds Server.