Skip to content

Latest commit

 

History

History
193 lines (120 loc) · 7.62 KB

content.md

File metadata and controls

193 lines (120 loc) · 7.62 KB
Raw

What is Nuxeo ?

The Nuxeo Platform is a highly customizable and extensible content management platform for building business applications.

%%LOGO%%

How to use this image

Start a bare nuxeo instance

$ docker run --name mynuxeo -p 8080:8080 -d nuxeo

This image includes EXPOSE 8080 (the nuxeo port). The default Nuxeo configuration is applied which feature an embedded database (H2), and an embedded Elasticsearch instance. This setup is not suitable for production. See below to know how to setup a production ready container by specifying environment variables.

The Nuxeo platform is accesible at http://${DOCKER_HOST}:8080/ and default User and Password are Administrator/Administrator.

Start a nuxeo with some additional packages

$ docker run --name mynuxeo -p 8080:8080 -e NUXEO_PACKAGES="nuxeo-web-mobile nuxeo-drive nuxeo-diff nuxeo-spreadsheet nuxeo-dam nuxeo-template-rendering nuxeo-template-rendering-samples nuxeo-showcase-content"
nuxeo

This will install the same image as above but comes with some demo Nuxeo packages to demonstrate its various usage (DAM, DM, search etc...)

You can find additional informations on how to use this image in Nuxeo documentation

Environment Variables

The Nuxeo image uses several environment variable that allow to specify a more specific setup.

NUXEO_DB_TYPE

This defines the database type to use. By default it sets an H2 embedded database that is suitable for test purpose only. When specifying a DB type, other variable mays help :

  • NUXEO_DB_HOST : If NUXEO_DB_TYPE is defined, this variable is mandatory and has to point to the DB server host.
  • NUXEO_DB_NAME : name of the database to use (nuxeo by default)
  • NUXEO_DB_USER : user to connect to the database (nuxeo by default)
  • NUXEO_DB_PASSWORD : the password to connect to the database (nuxeo by default)

NUXEO_TEMPLATES

This variables allows to add additional Nuxeo configuration templates in the nuxeo.templates configuration variable.

NUXEO_ES_HOSTS

This variables allows to setup an external Elasticsearch cluster. Use a comma separated list of Elasticsearch hosts with the 9300 port. Additional environment vars may be setup like :

  • NUXEO_ES_CLUSTER_NAME : name of the Elasticsearch cluster to join
  • NUXEO_ES_INDEX_NAME: name of the index (nuxeo by default)
  • NUXEO_ES_REPLICAS : number or replicas (1 by default). If not 0, it means that your ES cluster must have enough node to fullfill the replicas setup.
  • NUXEO_ES_SHARDS : number or shards (5 by default).

For instance :

NUXEO_ES_HOSTS=es1:9300,es2:9300
NUXEO_ES_CLUSTER_NAME=dockerCluster
NUXEO_ES_INDEX_NAME=nuxeo1
NUXEO_ES_REPLICAS=0
NUXEO_ES_SHARDS=5

NUXEO_REDIS_HOST

In order to use Redis, just set up this variable to the Redis host address.

NUXEO_REDIS_PORT

If Redis is setup, you can ovewrite the default port configuration (default to 6379)

NUXEO_CLID

Allow to setup a CLID for Nuxeo Connect registration. This parameter is in the form part1\npart2, so depending on the environment you may have to escape the \ character.

You can find additional informations the registration process in the Nuxeo documentation

NUXEO_INSTALL_HOTFIX

This launch the install of latest Hotfixes. (true by default, but needs a NUXEO_CLID to be setup)

NUXEO_PACKAGES

Allows to install Nuxeo packages at startup.

NUXEO_URL

This variable sets the URL where your Nuxeo instance will be joinable. It's used for instance to refer to it when sending server's address in mails.

NUXEO_DATA

Location of the Nuxeo data directory. (/var/lib/nuxeo/data by default). You will likely customize NUXEO_DATA to map it on docker volume so data like binaries stay persistent.

NUXEO_LOG

Location of the Nuxeo log directory. (/var/log/nuxeo by default)

NUXEO_AUTOMATION_TRACE

If set to "true", this will enable the automation trace mode.

NUXEO_DEV_MODE

If set to "true", this will enable the development mode that will allow hot reload when developing with Nuxeo Studio.

NUXEO_BINARY_STORE

Tells the location of the binary store which configure the binary storage

NUXEO_TRANSIENT_STORE

Tells the location of the transient storage

NUXEO_DDL_MODE

Allows to setup Database creation option by fixing the ddlMode value.

NUXEO_CUSTOM_PARAM

Allows to add custom parameters to nuxeo.conf. Multiple parameters can be splitted by a \n. For instance:

NUXEO_CUSTOM_PARAM="repository.clustering.enabled=false\nrepository.clustering.delay=1000"

How to extend this image

Adding additional configuration

If you would like to do additional setup in an image derived from this one, you can add a /nuxeo.conf file that will be appended to the end of the regular nuxeo.conf file.

FROM nuxeo:7.10
ADD nuxeo.conf /nuxeo.conf

If you need a root account to run some installation steps in your Dockerfile, then you need to put those steps between two USER command as the image is run with the user 1000 (nuxeo). For instance:

FROM nuxeo:LTS
USER root
RUN apt-get update && apt-get install -y --no-install-recommends vim
USER 1000

Launching custom shell scripts

You can add your own shell scripts in a special /docker-entrypoint-initnuxeo.d directory. When ending in .sh, they will be run on default entrypoint startup.

ffmpeg

As it contains some non-free Codecs, we dont't ship a binary version of ffmpeg as part of this image. However, you can simply add the compilation in a derived images by adding these lines to your Dockerfile.

FROM nuxeo:7.10

USER root

RUN echo "deb http://httpredir.debian.org/debian jessie non-free" >> /etc/apt/sources.list
RUN apt-get update && apt-get install -y --no-install-recommends libfaac-dev git

WORKDIR /tmp
# Build ffmpeg
ENV BUILD_YASM true
ENV LIBFAAC true
RUN git clone https://github.com/nuxeo/ffmpeg-nuxeo.git
WORKDIR ffmpeg-nuxeo
RUN ./prepare-packages.sh \
 && ./build-yasm.sh \
 && ./build-x264.sh \
 && ./build-libvpx.sh \
 && ./build-ffmpeg.sh \
 && cd /tmp \
 && rm -Rf ffmpeg-nuxeo \
 && rm -rf /var/lib/apt/lists/*

USER 1000

Using Oracle JVM

For the same reasons as ffmpeg we don't ship the Oracle JVM and rely by default on OpenJDK. If you want to use the Hotspot JVM you cans add the following lines in a derived Dockerfile

RUN apt-get remove -y --purge openjdk-8-jdk \
  && add-apt-repository -y ppa:webupd8team/java && apt-get update \
  && echo "debconf shared/accepted-oracle-license-v1-1 select true" | debconf-set-selections \
  && echo "debconf shared/accepted-oracle-license-v1-1 seen true" | debconf-set-selections \
  && apt-get install -y oracle-java8-installer \
  && rm -rf /var/lib/apt/lists/*

Why is this images so big ?

This image is big because it contains a lot of features. The nuxeo distribution itself is about 250M and in order to make cool things work like generating thumbnails or converting document to PDF we need some additional tools that are bundled in the image. We hope that in the future we will be able to delegate those conversions to external services that would be bundled as additional docker images.