public-offering
/
pad.pub0.org
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docker: incorporate the docker docs into the official documentation 

This also means increasing the indentation level.
pull/3636/head
muxator 2019-11-08 23:17:34 +01:00
parent 8c74e72c8c
commit c008ee36bd
3 changed files with 13 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -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`) 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` 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 # Next Steps
## Tweak the settings ## Tweak the settings

16
docker/README.md → doc/docker.md
View File

@ -2,7 +2,7 @@
The official Docker image is available 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 ## 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: If you are ok downloading a [prebuilt image from Docker Hub](https://hub.docker.com/r/etherpad/etherpad), these are the commands:
```bash ```bash
# gets the latest published version # gets the latest published version
@ -12,12 +12,12 @@ docker pull etherpad/etherpad
docker pull etherpad/etherpad:1.8.0 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**. 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. 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: Prepare your custom `settings.json` file:
```bash ```bash
cd <BASEDIR>/docker cd <BASEDIR>/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`. **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. 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). 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`. 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: Build the latest development version:
```bash ```bash
@ -60,7 +60,7 @@ Include two plugins in the container:
docker build --build-arg ETHERPAD_PLUGINS="ep_codepad ep_author_neat" --tag <YOUR_USERNAME>/etherpad . docker build --build-arg ETHERPAD_PLUGINS="ep_codepad ep_author_neat" --tag <YOUR_USERNAME>/etherpad .
``` ```
# Running your instance: ## Running your instance:
To run your instance: To run your instance:
```bash ```bash
@ -69,7 +69,7 @@ docker run --detach --publish <DESIRED_PORT>:9001 <YOUR_USERNAME>/etherpad
And point your browser to `http://<YOUR_IP>:<DESIRED_PORT>` And point your browser to `http://<YOUR_IP>:<DESIRED_PORT>`
# Options available by default ## Options available by default
The `settings.json` available by default enables some configuration to be set from the environment. 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) * `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` * `LOGLEVEL`: valid values are `DEBUG`, `INFO`, `WARN` and `ERROR`
## Examples ### Examples
Use a Postgres database, no admin user enabled: Use a Postgres database, no admin user enabled:

1
doc/index.md
View File

@ -1,6 +1,7 @@
@include documentation @include documentation
@include stats @include stats
@include localization @include localization
@include docker
@include skins @include skins
@include api/api @include api/api
@include plugins @include plugins