diff --git a/docker/README.md b/docker/README.md index c8f3de1da..1d1675801 100644 --- a/docker/README.md +++ b/docker/README.md @@ -2,35 +2,6 @@ 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: -```bash -cd /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: -```bash -# builds latest development version -docker build --tag /etherpad . - -# builds latest stable version -docker build --build-arg ETHERPAD_VERSION=master --build-arg NODE_ENV=production --tag /etherpad . - -# builds a specific version -docker build --build-arg ETHERPAD_VERSION=1.7.5 --build-arg NODE_ENV=production --tag /etherpad . - -# builds a specific git hash -docker build --build-arg ETHERPAD_VERSION=4c45ac3cb1ae --tag /etherpad . -``` - # Downloading from Docker Hub If you are ok downloading a [prebuilt image from Docker Hub](https://hub.docker.com/r/etherpad/etherpad), these are the commands: ```bash @@ -41,6 +12,43 @@ docker pull etherpad/etherpad docker pull etherpad/etherpad:1.7.5 ``` +# Build a personalized container + +If you want to use a personalized settings file, **you will have to rebuild your image**. +All of the following instructions are as a member of the `docker` group. + +## Rebuilding with custom settings +Prepare your custom `settings.json` file: +```bash +cd /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`. + +## Examples + +Build the latest development version: +```bash +docker build --tag /etherpad . +``` + +Build the latest stable version: +```bash +docker build --build-arg ETHERPAD_VERSION=master --build-arg NODE_ENV=production --tag /etherpad . +``` + +Build a specific tagged version: +```bash +docker build --build-arg ETHERPAD_VERSION=1.7.5 --build-arg NODE_ENV=production --tag /etherpad . +``` + +Build a specific git hash: +```bash +docker build --build-arg ETHERPAD_VERSION=4c45ac3cb1ae --tag /etherpad . +``` + # Running your instance: To run your instance: