Server

Build a Custom Docker Image

Updated: April 12, 2021

To build an application from Nuxeo, we strongly recommend to customize the Nuxeo Docker Image by building a Docker image from the Nuxeo one. Let's see how you can do this.

Build a Custom Docker Image From the Nuxeo One

You can simply write a Dockerfile using the Nuxeo image as parent image. A good practice is to use a build argument before the FROM instruction to easily set the version of the Nuxeo parent image, as in the example below:

ARG NUXEO_VERSION=latest

FROM docker.packages.nuxeo.com/nuxeo/nuxeo:${NUXEO_VERSION}

# Execute some commands to add layers on top of the parent image

Then, the custom image can be built by running the following command in the directory of the Dockerfile:

docker build -t mycompany/myapplication:mytag --build-arg NUXEO_VERSION=11.4 .

To upgrade the custom image to a newer version of Nuxeo, for instance from 11.4 to 11.5, you can just rebuild the custom image by updating the NUXEO_VERSION build argument.

Below, you can find some examples of customization that can be done in such a custom Docker image.

Installing Nuxeo Packages

We provide a utility script to install remote Nuxeo packages from Nuxeo Connect and local Nuxeo packages when building an image from the Nuxeo image:

For instance, you can use this script in the following Dockerfile:

FROM docker.packages.nuxeo.com/nuxeo/nuxeo

ARG CLID
ARG CONNECT_URL

COPY --chown=900:0 path/to/local-package-nodeps-*.zip $NUXEO_HOME/local-packages/local-package-nodeps.zip
COPY --chown=900:0 path/to/local-package-*.zip $NUXEO_HOME/local-packages/local-package.zip

# Install a local package without its dependencies (`mp-install --nodeps`)
RUN /install-packages.sh --offline $NUXEO_HOME/local-packages/local-package-nodeps.zip
# Install remote packages and a local package with its dependencies
RUN /install-packages.sh --clid ${CLID} --connect-url ${CONNECT_URL} nuxeo-web-ui nuxeo-drive $NUXEO_HOME/local-packages/local-package.zip
RUN rm -rf $NUXEO_HOME/local-packages

Adding Configuration Properties

As described in this section about the nuxeo.conf file, the files from the /etc/nuxeo/conf.d directory of the Nuxeo image have their properties appended to the final nuxeo.conf file used by the server.

If you want to embed some additional configuration properties in your custom image, you can simply copy some properties files to the /etc/nuxeo/conf.d directory when building the custom image.

For instance:

FROM docker.packages.nuxeo.com/nuxeo/nuxeo

COPY /path/to/my-configuration.properties /etc/nuxeo/conf.d/my-configuration.properties

Installing FFmpeg

As it contains some non-free codecs, FFmpeg isn't part of the Nuxeo image. However, you can build a custom Docker image, based on the Nuxeo one, including the ffmpeg package provided by RPM Fusion, see the Dockerfile sample below. The resulting ffmpeg binary embeds all the codecs required for Nuxeo video conversions.

FROM docker.packages.nuxeo.com/nuxeo/nuxeo

# we need to be root to run yum commands
USER 0
# install RPM Fusion free repository
RUN yum -y localinstall --nogpgcheck https://mirrors.rpmfusion.org/free/el/rpmfusion-free-release-7.noarch.rpm
# install ffmpeg package
RUN yum -y install ffmpeg
# set back original user
USER 900

You can use the above method to install any software in the custom image.

We'd love to hear your thoughts!

All fields required