History

Eddie Barraco 7433d749f0 docker: remove supervisord from the Docker image Supervision/management should not be done from inside the container, but externally, by container managers. The container now simply runs node on server.js. The logs are now readable from docker logs <container_name>.		2019-03-21 23:52:35 +01:00
..
Dockerfile	docker: remove supervisord from the Docker image	2019-03-21 23:52:35 +01:00
README.md	Settings.js: support syntax for default values	2019-03-21 23:32:08 +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 --tag <YOUR_USERNAME>/etherpad .

# builds a specific version
docker build --build-arg ETHERPAD_VERSION=1.7.5 --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>