From 8c74e72c8c0fe0ac0c012d43e6ed2f5e7c5b1527 Mon Sep 17 00:00:00 2001 From: muxator Date: Fri, 8 Nov 2019 23:15:03 +0100 Subject: [PATCH] docker: minimal changes to the documentation --- docker/Dockerfile | 2 +- docker/README.md | 9 +++++---- docker/settings.json | 9 +++++++++ 3 files changed, 15 insertions(+), 5 deletions(-) diff --git a/docker/Dockerfile b/docker/Dockerfile index 957cd9508..24e93f082 100644 --- a/docker/Dockerfile +++ b/docker/Dockerfile @@ -1,6 +1,6 @@ # Etherpad Lite Dockerfile # -# https://github.com/ether/etherpad-docker +# https://github.com/ether/etherpad-lite # # Author: muxator # diff --git a/docker/README.md b/docker/README.md index fe824cc4c..613a7960c 100644 --- a/docker/README.md +++ b/docker/README.md @@ -1,6 +1,6 @@ -# Docker image +# Docker -This directory contains the files that are used to build the official Docker image on https://hub.docker.com/r/etherpad/etherpad. +The official Docker image is available on https://hub.docker.com/r/etherpad/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: @@ -9,7 +9,7 @@ If you are ok downloading a [prebuilt image from Docker Hub](https://hub.docker. docker pull etherpad/etherpad # gets a specific version -docker pull etherpad/etherpad:1.7.5 +docker pull etherpad/etherpad:1.8.0 ``` # Build a personalized container @@ -22,7 +22,7 @@ Prepare your custom `settings.json` file: ```bash cd /docker cp ../settings.json.template settings.json -[ further edit your settings.json as needed] +[ 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`. @@ -74,6 +74,7 @@ And point your browser to `http://:` The `settings.json` available by default enables some configuration to be set from the environment. Available options: + * `TITLE`: The name of the instance * `FAVICON`: favicon default name, or a fully specified URL to your own favicon * `SKIN_NAME`: either `no-skin`, `colibris` or an existing directory under `src/static/skins`. diff --git a/docker/settings.json b/docker/settings.json index 8596f81fe..1fef5660f 100644 --- a/docker/settings.json +++ b/docker/settings.json @@ -1,3 +1,12 @@ +/** + * THIS IS THE SETTINGS FILE THAT IS COPIED INSIDE THE DOCKER CONTAINER. + * + * By default, some runtime customizations are supported (see the + * documentation). + * + * If you need more control, edit this file and rebuild the container. + */ + /* * This file must be valid JSON. But comments are allowed *