From c008ee36bdc28ae01c7bdbce8dbc195f499af9bd Mon Sep 17 00:00:00 2001 From: muxator Date: Fri, 8 Nov 2019 23:17:34 +0100 Subject: [PATCH] docker: incorporate the docker docs into the official documentation This also means increasing the indentation level. --- README.md | 4 ++++ docker/README.md => doc/docker.md | 16 ++++++++-------- doc/index.md | 1 + 3 files changed, 13 insertions(+), 8 deletions(-) rename docker/README.md => doc/docker.md (94%) diff --git a/README.md b/README.md index 685ba8966..cd9b78a72 100644 --- a/README.md +++ b/README.md @@ -61,6 +61,10 @@ If cloning to a subdirectory within another project, you may need to do the foll 2. Edit the db `filename` in `settings.json` to the relative directory with the file (e.g. `application/lib/etherpad-lite/var/dirty.db`) 3. Add auto-generated files to the main project `.gitignore` +## Docker container + +Find [here](doc/docker.md) information on running Etherpad in a container. + # Next Steps ## Tweak the settings diff --git a/docker/README.md b/doc/docker.md similarity index 94% rename from docker/README.md rename to doc/docker.md index 613a7960c..d40810a68 100644 --- a/docker/README.md +++ b/doc/docker.md @@ -2,7 +2,7 @@ The official Docker image is available on https://hub.docker.com/r/etherpad/etherpad. -# Downloading from Docker Hub +## 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 # gets the latest published version @@ -12,12 +12,12 @@ docker pull etherpad/etherpad docker pull etherpad/etherpad:1.8.0 ``` -# Build a personalized container +## 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 +### Rebuilding with custom settings Prepare your custom `settings.json` file: ```bash cd /docker @@ -27,13 +27,13 @@ cp ../settings.json.template settings.json **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`. -## Rebuilding including some plugins +### Rebuilding including some plugins If you want to install some plugins in your container, it is sufficient to list them in the ETHERPAD_PLUGINS build variable. The variable value has to be a space separated, double quoted list of plugin names (see examples). Some plugins will need personalized settings in the `settings.json` file. Just refer to the previous section, and include them in your custom `settings.json`. -## Examples +### Examples Build the latest development version: ```bash @@ -60,7 +60,7 @@ Include two plugins in the container: docker build --build-arg ETHERPAD_PLUGINS="ep_codepad ep_author_neat" --tag /etherpad . ``` -# Running your instance: +## Running your instance: To run your instance: ```bash @@ -69,7 +69,7 @@ docker run --detach --publish :9001 /etherpad And point your browser to `http://:` -# Options available by default +## Options available by default The `settings.json` available by default enables some configuration to be set from the environment. @@ -93,7 +93,7 @@ Available options: * `USER_PASSWORD`: the password for the first user `user` (leave unspecified if you do not want to create it) * `LOGLEVEL`: valid values are `DEBUG`, `INFO`, `WARN` and `ERROR` -## Examples +### Examples Use a Postgres database, no admin user enabled: diff --git a/doc/index.md b/doc/index.md index 5b93bac68..4f03bbef4 100644 --- a/doc/index.md +++ b/doc/index.md @@ -1,6 +1,7 @@ @include documentation @include stats @include localization +@include docker @include skins @include api/api @include plugins