Docker image

The goals of this docker image is to:

Every time the Enonic XP image is built it will be based off the latest enonic/graalvm docker image. This ensures the latest updates to the JVM and OS.

To help with day 2 operations, the image comes with some useful preinstalled tools.

To create a deployment that is stable and easy to back up you should make the following directories persistent.

These are directories that, depending on your application of Enonic XP and deployment policy, should maybe be persistent.

Since this image uses a modern JVM, it will respect the container memory limits set by the docker daemon. There are some pitfalls though. Elasticsearch uses off-heap buffers, that can lead to the container running out of memory. For that reason, as a general rule, you should:

Parameters to achive this are described under the Useful XP_OPTS parameters section.

The image does contain the standard configuration that comes with all Enonic XP distribution. Depending on how you mount volumes into the container you might override that directory. Consider this command:

This will override the standard configuration directory with the host directory that might be empty, hence no configuration will be present for Enonic XP. This is probably not what you want. We recommend when you are mounting your configuration directory to the container, that you base it on the standard configuration directory provided in the docker image. To get a copy of the standard configuration run:

After running these commands you will have the standard configuration copied to your working directory.

The image allows you to supply a custom setenv.sh script. It is sourced just before Enonic XP is started and can be used to setup the environment and run pre-scripts. To enable this, simply mount a script to $XP_HOME/setenv.sh in the container.

This subsection lists some useful environmental variables to set while deploying this image.

First create a directory called demo. Lets get our base configuration, so inside the demo directory run the command:

Next we want to create a setenv.sh to install the snapshotter. Create a file called setenv.sh inside the demo directory.

Now we are almost ready. Lastly create a file called docker-compose.yaml inside the demo directory and paste the following into that file.

Before starting your deployment, you should verify that your demo folder contains:

To start up Enonic XP simply run this command in the demo directory:

You can verify that everything is fine by looking at the logs. To do that run:

You can also open up the admin UI at http://localhost:8080/admin/tool.

Now you have created a single node deployment that is easy to configure, backup and replicate.

You could create a git repository and push the demo folder to that repository to version control you deployment. That way if you want to replicate the deployment on another server, simply checkout the git repository on that server and run docker-compose up -d again.

You might be wondering where the data for Enonic XP will be stored. Since we defined volumes for it, it will be persisted where docker stores its volumes. That will vary depending on your operating system but on linux they are located at /var/lib/docker/volumes. You can query docker to figure out where you volumes are stored like so:

To do backups you would simply back up the mountpoints for demo_snapshots and demo_blobstore. It is not as important to back up other directories.

The old image contained the wget binary. To keep the image size to a minimum and because curl is already present in the new image, wget is not installed in the new image.

The directory $XP_ROOT/home.org is now simply called $XP_ROOT/home. If you are modifying that directory in your build steps you will have make the appropriate changes.