libretic
/
etherpad-lite
5
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
etherpad-lite/doc/docker.md

146 lines
10 KiB
Markdown
Raw Normal View History

docker: minimal changes to the documentation
2019-11-08 23:15:03 +01:00
# Docker
docker: move the docker image creation inside the main repository This is a super simple start. At minimum, configuration via environment variables (see #3543) needs to be integrated in Etherpad to make this user-friendly. Resolves #3524.
2019-03-08 01:38:36 +01:00
docker: minimal changes to the documentation
2019-11-08 23:15:03 +01:00
The official Docker image is available on https://hub.docker.com/r/etherpad/etherpad.
docker: move the docker image creation inside the main repository This is a super simple start. At minimum, configuration via environment variables (see #3543) needs to be integrated in Etherpad to make this user-friendly. Resolves #3524.
2019-03-08 01:38:36 +01:00
docker: incorporate the docker docs into the official documentation This also means increasing the indentation level.
2019-11-08 23:17:34 +01:00
## Downloading from Docker Hub
docker: reorganized the README, same infos This is in preparation for the next commit, which will introduce support for custom builds with plugins.
2019-07-12 02:38:47 +02:00
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
docker pull etherpad/etherpad
docker: move the docker image creation inside the main repository This is a super simple start. At minimum, configuration via environment variables (see #3543) needs to be integrated in Etherpad to make this user-friendly. Resolves #3524.
2019-03-08 01:38:36 +01:00
docker: reorganized the README, same infos This is in preparation for the next commit, which will introduce support for custom builds with plugins.
2019-07-12 02:38:47 +02:00
# gets a specific version
docker: minimal changes to the documentation
2019-11-08 23:15:03 +01:00
docker pull etherpad/etherpad:1.8.0
docker: reorganized the README, same infos This is in preparation for the next commit, which will introduce support for custom builds with plugins.
2019-07-12 02:38:47 +02:00
```
docker: incorporate the docker docs into the official documentation This also means increasing the indentation level.
2019-11-08 23:17:34 +01:00
## Build a personalized container
docker: reorganized the README, same infos This is in preparation for the next commit, which will introduce support for custom builds with plugins.
2019-07-12 02:38:47 +02:00
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.
docker: build & run the container in production mode This is leaner (no development dependencies are included in the container) and faster (among other things, assets are minified & compressed).
2020-04-19 04:35:27 +02:00
By default, the Etherpad Docker image is built and run in `production` mode: no development dependencies are installed, and asset bundling speeds up page load time.
docker: move the docker image creation inside the main repository This is a super simple start. At minimum, configuration via environment variables (see #3543) needs to be integrated in Etherpad to make this user-friendly. Resolves #3524.
2019-03-08 01:38:36 +01:00
docker: incorporate the docker docs into the official documentation This also means increasing the indentation level.
2019-11-08 23:17:34 +01:00
### Rebuilding with custom settings
docker: move docker/settings.json to /settings.json.docker
2019-11-08 23:50:50 +01:00
Edit `<BASEDIR>/settings.json.docker` at your will. When rebuilding the image, this file will be copied inside your image and renamed to `setting.json`.
docker: move the docker image creation inside the main repository This is a super simple start. At minimum, configuration via environment variables (see #3543) needs to be integrated in Etherpad to make this user-friendly. Resolves #3524.
2019-03-08 01:38:36 +01:00
Settings.js: support syntax for default values +---------------------------+---------------+------------------+ | Configuration string in | Value of | Resulting confi- | | settings.json | ENV_VAR | guration value | |---------------------------|---------------|------------------| | "${ENV_VAR}" | "some_string" | "some_string" | | "${ENV_VAR}" | "9001" | 9001 | | "${ENV_VAR}" | undefined | null | | "${ENV_VAR:some_default}" | "some_string" | "some_string" | | "${ENV_VAR:some_default}" | undefined | "some_default" | +---------------------------+---------------+------------------+ Mention this briefly in the main README.md, also. Closes #3578.
2019-03-21 01:37:19 +01:00
**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`.
Settings.js: support configuration via environment variables. All the configuration values can be read from environment variables using the syntax "${ENV_VAR_NAME}". This is useful, for example, when running in a Docker container. EXAMPLE: "port": "${PORT}" "minify": "${MINIFY}" "skinName": "${SKIN_NAME}" Would read the configuration values for those items from the environment variables PORT, MINIFY and SKIN_NAME. REMARKS: Please note that a variable substitution always needs to be quoted. "port": 9001, <-- Literal values. When not using substitution, "minify": false only strings must be quoted: booleans and "skin": "colibris" numbers must not. "port": ${PORT} <-- ERROR: this is not valid json "minify": ${MINIFY} "skin": ${SKIN_NAME} "port": "${PORT}" <-- CORRECT: if you want to use a variable "minify": "${MINIFY}" substitution, put quotes around its name, "skin": "${SKIN_NAME}" even if the required value is a number or a boolean. Etherpad will take care of rewriting it to the proper type if necessary. Resolves #3543
2019-03-09 23:01:21 +01:00
docker: incorporate the docker docs into the official documentation This also means increasing the indentation level.
2019-11-08 23:17:34 +01:00
### Rebuilding including some plugins
docker: support including plugins in custom builds. This commit introduces the support for the ETHERPAD_PLUGINS build parameter, which contains a list of plugins to be installed while building the container. EXAMPLE: docker build --build-arg ETHERPAD_PLUGINS="ep_codepad ep_author_neat" --tag <YOUR_USERNAME>/etherpad . Resolves #3618.
2019-07-12 02:32:34 +02:00
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).
docker: move docker/settings.json to /settings.json.docker
2019-11-08 23:50:50 +01:00
Some plugins will need personalized settings. Just refer to the previous section, and include them in your custom `settings.json.docker`.
docker: support including plugins in custom builds. This commit introduces the support for the ETHERPAD_PLUGINS build parameter, which contains a list of plugins to be installed while building the container. EXAMPLE: docker build --build-arg ETHERPAD_PLUGINS="ep_codepad ep_author_neat" --tag <YOUR_USERNAME>/etherpad . Resolves #3618.
2019-07-12 02:32:34 +02:00
docker: incorporate the docker docs into the official documentation This also means increasing the indentation level.
2019-11-08 23:17:34 +01:00
### Examples
docker: reorganized the README, same infos This is in preparation for the next commit, which will introduce support for custom builds with plugins.
2019-07-12 02:38:47 +02:00
docker: build from the local working directory With this change, the Dockerfile builds the Docker image from the code checked out in the local filesystem, instead of downloading a revision from git. Implements #3657
2019-11-08 22:56:30 +01:00
Build a Docker image from the currently checked-out code:
docker: move the docker image creation inside the main repository This is a super simple start. At minimum, configuration via environment variables (see #3543) needs to be integrated in Etherpad to make this user-friendly. Resolves #3524.
2019-03-08 01:38:36 +01:00
```bash
docker build --tag <YOUR_USERNAME>/etherpad .
docker: reorganized the README, same infos This is in preparation for the next commit, which will introduce support for custom builds with plugins.
2019-07-12 02:38:47 +02:00
```
docker: move the docker image creation inside the main repository This is a super simple start. At minimum, configuration via environment variables (see #3543) needs to be integrated in Etherpad to make this user-friendly. Resolves #3524.
2019-03-08 01:38:36 +01:00
docker: support including plugins in custom builds. This commit introduces the support for the ETHERPAD_PLUGINS build parameter, which contains a list of plugins to be installed while building the container. EXAMPLE: docker build --build-arg ETHERPAD_PLUGINS="ep_codepad ep_author_neat" --tag <YOUR_USERNAME>/etherpad . Resolves #3618.
2019-07-12 02:32:34 +02:00
Include two plugins in the container:
```bash
docker build --build-arg ETHERPAD_PLUGINS="ep_codepad ep_author_neat" --tag <YOUR_USERNAME>/etherpad .
```
docker: incorporate the docker docs into the official documentation This also means increasing the indentation level.
2019-11-08 23:17:34 +01:00
## Running your instance:
docker: move the docker image creation inside the main repository This is a super simple start. At minimum, configuration via environment variables (see #3543) needs to be integrated in Etherpad to make this user-friendly. Resolves #3524.
2019-03-08 01:38:36 +01:00
To run your instance:
```bash
docker: typos in the readme
2019-11-07 23:02:34 +01:00
docker run --detach --publish <DESIRED_PORT>:9001 <YOUR_USERNAME>/etherpad
docker: move the docker image creation inside the main repository This is a super simple start. At minimum, configuration via environment variables (see #3543) needs to be integrated in Etherpad to make this user-friendly. Resolves #3524.
2019-03-08 01:38:36 +01:00
```
docker: typos in the readme
2019-11-07 23:02:34 +01:00
And point your browser to `http://<YOUR_IP>:<DESIRED_PORT>`
docker: enable environment variables settings by default By leveraging the templating mechanism in `settings.json`, this change allows a Docker client to run a prebuilt image and change some basic configuration settings, like the instance name or, more importantly, the database coordinates. By default, the image runs witho no administrative user enabled. If a value is given to ADMIN_PASSWORD, the `admin` user will be activated. Also closes https://github.com/ether/etherpad-lite/issues/3623 --- Modified by muxator to support conditional user activation at runtime.
2019-10-01 07:03:59 +02:00
docker: incorporate the docker docs into the official documentation This also means increasing the indentation level.
2019-11-08 23:17:34 +01:00
## Options available by default
docker: enable environment variables settings by default By leveraging the templating mechanism in `settings.json`, this change allows a Docker client to run a prebuilt image and change some basic configuration settings, like the instance name or, more importantly, the database coordinates. By default, the image runs witho no administrative user enabled. If a value is given to ADMIN_PASSWORD, the `admin` user will be activated. Also closes https://github.com/ether/etherpad-lite/issues/3623 --- Modified by muxator to support conditional user activation at runtime.
2019-10-01 07:03:59 +02:00
docker: move docker/settings.json to /settings.json.docker
2019-11-08 23:50:50 +01:00
The `settings.json.docker` available by default enables some configuration to be set from the environment.
docker: enable environment variables settings by default By leveraging the templating mechanism in `settings.json`, this change allows a Docker client to run a prebuilt image and change some basic configuration settings, like the instance name or, more importantly, the database coordinates. By default, the image runs witho no administrative user enabled. If a value is given to ADMIN_PASSWORD, the `admin` user will be activated. Also closes https://github.com/ether/etherpad-lite/issues/3623 --- Modified by muxator to support conditional user activation at runtime.
2019-10-01 07:03:59 +02:00
docker: in the documentation, reorganize categorically the available parameters No functional changes. This is in preparation of a future commit by Paul Tiedke.
2020-04-19 22:34:19 +02:00
### General
docker: minimal changes to the documentation
2019-11-08 23:15:03 +01:00
docker: switch to table layout in the docs about the available settings In this way, we also gain an explicit place for the default setting (still not filled in). No functional changes. This is in preparation of a future commit by Paul Tiedke.
2020-04-21 04:29:51 +02:00
| Variable | Description | Default |
| ------------------ | ------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `TITLE` | The name of the instance | |
| `FAVICON` | favicon default name, or a fully specified URL to your own favicon | |
| `DEFAULT_PAD_TEXT` | The default text of a pad | |
| `IP` | IP which etherpad should bind at. Change to `::` for IPv6 | |
| `PORT` | port which etherpad should bind at | |
| `ADMIN_PASSWORD` | the password for the `admin` 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) | |
docker: in the documentation, reorganize categorically the available parameters No functional changes. This is in preparation of a future commit by Paul Tiedke.
2020-04-19 22:34:19 +02:00
### Database
docker: switch to table layout in the docs about the available settings In this way, we also gain an explicit place for the default setting (still not filled in). No functional changes. This is in preparation of a future commit by Paul Tiedke.
2020-04-21 04:29:51 +02:00
| Variable | Description | Default |
| ------------- | -------------------------------------------------------------- | --------------------------------------------------------------------- |
| `DB_TYPE` | a database supported by https://www.npmjs.com/package/ueberdb2 | |
| `DB_HOST` | the host of the database | |
| `DB_PORT` | the port of the database | |
| `DB_NAME` | the database name | |
| `DB_USER` | a database user with sufficient permissions to create tables | |
| `DB_PASS` | the password for the database username | |
| `DB_CHARSET` | the character set for the tables (only required for MySQL) | |
| `DB_FILENAME` | in case `DB_TYPE` is `DirtyDB`, the database filename. | |
docker: in the documentation, reorganize categorically the available parameters No functional changes. This is in preparation of a future commit by Paul Tiedke.
2020-04-19 22:34:19 +02:00
docker: in the db documentation, specify that we are not going to include every single variable a driver may want
2020-04-21 04:24:32 +02:00
If your database needs additional settings, you will have to use a personalized `settings.json.docker` and rebuild the container (or otherwise put the updated `settings.json` inside your image).
docker: in the documentation, reorganize categorically the available parameters No functional changes. This is in preparation of a future commit by Paul Tiedke.
2020-04-19 22:34:19 +02:00
### Skins
docker: switch to table layout in the docs about the available settings In this way, we also gain an explicit place for the default setting (still not filled in). No functional changes. This is in preparation of a future commit by Paul Tiedke.
2020-04-21 04:29:51 +02:00
| Variable | Description | Default |
| --------------- | ------------------------------------------------------------------------------ | --------------------------------------------------------- |
| `SKIN_NAME` | either `no-skin`, `colibris` or an existing directory under `src/static/skins` | |
docker: in the documentation, reorganize categorically the available parameters No functional changes. This is in preparation of a future commit by Paul Tiedke.
2020-04-19 22:34:19 +02:00
### Logging
docker: switch to table layout in the docs about the available settings In this way, we also gain an explicit place for the default setting (still not filled in). No functional changes. This is in preparation of a future commit by Paul Tiedke.
2020-04-21 04:29:51 +02:00
| Variable | Description | Default |
| -------------------- | ---------------------------------------------------- | ------- |
| `LOGLEVEL` | valid values are `DEBUG`, `INFO`, `WARN` and `ERROR` | |
docker: in the documentation, reorganize categorically the available parameters No functional changes. This is in preparation of a future commit by Paul Tiedke.
2020-04-19 22:34:19 +02:00
### Advanced
docker: switch to table layout in the docs about the available settings In this way, we also gain an explicit place for the default setting (still not filled in). No functional changes. This is in preparation of a future commit by Paul Tiedke.
2020-04-21 04:29:51 +02:00
| Variable | Description | Default |
| --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------ |
| `SHOW_SETTINGS_IN_ADMIN_PAGE` | hide/show the settings.json in admin page | |
| `TRUST_PROXY` | set to `true` if you are using a reverse proxy in front of Etherpad (for example: Traefik for SSL termination via Let's Encrypt). This will affect security and correctness of the logs if not done | |
| `IMPORT_MAX_FILE_SIZE` | maximum allowed file size when importing a pad, in bytes. | |
| `IMPORT_EXPORT_MAX_REQ_PER_IP` | maximum number of import/export calls per IP. | |
| `IMPORT_EXPORT_RATE_LIMIT_WINDOW` | the call rate for import/export requests will be estimated in this time window (in milliseconds) | |
docker: in the documentation, reorganize categorically the available parameters No functional changes. This is in preparation of a future commit by Paul Tiedke.
2020-04-19 22:34:19 +02:00
docker: enable environment variables settings by default By leveraging the templating mechanism in `settings.json`, this change allows a Docker client to run a prebuilt image and change some basic configuration settings, like the instance name or, more importantly, the database coordinates. By default, the image runs witho no administrative user enabled. If a value is given to ADMIN_PASSWORD, the `admin` user will be activated. Also closes https://github.com/ether/etherpad-lite/issues/3623 --- Modified by muxator to support conditional user activation at runtime.
2019-10-01 07:03:59 +02:00
docker: incorporate the docker docs into the official documentation This also means increasing the indentation level.
2019-11-08 23:17:34 +01:00
### Examples
docker: enable environment variables settings by default By leveraging the templating mechanism in `settings.json`, this change allows a Docker client to run a prebuilt image and change some basic configuration settings, like the instance name or, more importantly, the database coordinates. By default, the image runs witho no administrative user enabled. If a value is given to ADMIN_PASSWORD, the `admin` user will be activated. Also closes https://github.com/ether/etherpad-lite/issues/3623 --- Modified by muxator to support conditional user activation at runtime.
2019-10-01 07:03:59 +02:00
Use a Postgres database, no admin user enabled:
```shell
docker run -d \
--name etherpad \
-p 9001:9001 \
-e 'DB_TYPE=postgres' \
-e 'DB_HOST=db.local' \
-e 'DB_PORT=4321' \
-e 'DB_NAME=etherpad' \
-e 'DB_USER=dbusername' \
-e 'DB_PASS=mypassword' \
etherpad/etherpad
```
Run enabling the administrative user `admin`:
```shell
docker run -d \
--name etherpad \
-p 9001:9001 \
-e 'ADMIN_PASSWORD=supersecret' \
etherpad/etherpad
```
docker: Add Run with volume example Supersedes https://github.com/ether/etherpad-lite/pull/3631 Co-authored-by: RaymondCavallaro <RaymondCavallaro@users.noreply.github.com>
2019-11-15 10:44:40 +01:00
Run a test instance running DirtyDB on a persistent volume:
```
docker run -d \
-v etherpad_data:/opt/etherpad-lite/var \
-p 9001:9001 \
etherpad/etherpad
```