History

muxator e8e2284884 docker: move WORKDIR as on top as possible. WORKDIR is also valid at build time, thus it makes sense to move it as towards the top as possible. This will come in hand in the next commits, when we will introduce support for installing plugins while building the container. Source: https://docs.docker.com/develop/develop-images/dockerfile_best-practices/#workdir [...] you should use WORKDIR instead of proliferating instructions like RUN cd … && do-something, which are hard to read, troubleshoot, and maintain.		2019-07-16 14:14:34 +02:00
..
Dockerfile	docker: move WORKDIR as on top as possible.	2019-07-16 14:14:34 +02:00
README.md	remove devdeps from prod builds	2019-03-29 17:52:06 +01:00
nop	docker: move the docker image creation inside the main repository	2019-03-08 01:38:36 +01:00

README.md

Docker image

This directory contains the files that are used to build the official Docker image on https://hub.docker.com/r/etherpad/etherpad.

Rebuilding with custom settings

In order to use a personalized settings file, you will have to rebuild your image.

All of these instructions are as a member of the docker group.

Prepare your custom settings.json file:

cd <BASEDIR>/docker
cp ../settings.json.template settings.json
[ further edit your settings.json as needed]

Each configuration parameter can also be set via an environment variable, using the syntax "${ENV_VAR}" or "${ENV_VAR:default_value}". For details, refer to settings.json.template.

Build the version you prefer:

# builds latest development version
docker build --tag <YOUR_USERNAME>/etherpad .

# builds latest stable version
docker build --build-arg ETHERPAD_VERSION=master --build-arg NODE_ENV=production --tag <YOUR_USERNAME>/etherpad .

# builds a specific version
docker build --build-arg ETHERPAD_VERSION=1.7.5 --build-arg NODE_ENV=production --tag <YOUR_USERNAME>/etherpad .

# builds a specific git hash
docker build --build-arg ETHERPAD_VERSION=4c45ac3cb1ae --tag <YOUR_USERNAME>/etherpad .

Downloading from Docker Hub

If you are ok downloading a prebuilt image from Docker Hub, these are the commands:

# gets the latest published version
docker pull etherpad/etherpad

# gets a specific version
docker pull etherpad/etherpad:1.7.5

Running your instance:

To run your instance:

docker run --detach --publish <DESIDERED_PORT>:9001 <YOUR_USERNAME>/etherpad

And point your browser to http://<YOUR_IP>:<DESIDERED_PORT>