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

258 lines
22 KiB
Markdown
Raw Normal View History

docker: minimal changes to the documentation
2019-11-08 22:15:03 +00: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 00:38:36 +00:00
docker: minimal changes to the documentation
2019-11-08 22:15:03 +00: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 00:38:36 +00:00
docker: incorporate the docker docs into the official documentation This also means increasing the indentation level.
2019-11-08 22:17:34 +00: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 00:38:47 +00: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 00:38:36 +00: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 00:38:47 +00:00
# gets a specific version
docker: minimal changes to the documentation
2019-11-08 22:15:03 +00: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 00:38:47 +00:00
```
docker: incorporate the docker docs into the official documentation This also means increasing the indentation level.
2019-11-08 22:17:34 +00: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 00:38:47 +00: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 02:35:27 +00: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 00:38:36 +00:00
docker: incorporate the docker docs into the official documentation This also means increasing the indentation level.
2019-11-08 22:17:34 +00:00
### Rebuilding with custom settings
fixed typo
2021-08-31 14:51:34 +00:00
Edit `<BASEDIR>/settings.json.docker` at your will. When rebuilding the image, this file will be copied inside your image and renamed to `settings.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 00:38:36 +00: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 00:37:19 +00: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 22:01:21 +00:00
docker: incorporate the docker docs into the official documentation This also means increasing the indentation level.
2019-11-08 22:17:34 +00: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 00:32:34 +00: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 22:50:50 +00: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 00:32:34 +00:00
feat(docker): Add build var for optionally installing abiword (#4796) This MR introduces a docker build variable `INSTALL_ABIWORD`. When set to any value other than `0`, ABIWORD is installed in the resulting docker container, enabling the possibility to configure ABIWORD in settings.json.docker or via ENV VAR `ABIWORD` for exporting to DOC/PDF/ODT. Documentation is included inline and in the docker markdown file.
2021-02-18 09:27:52 +00:00
### Rebuilding including export functionality for DOC/PDF/ODT
If you want to be able to export your pads to DOC/PDF/ODT files, you can install
either Abiword or Libreoffice via setting a build variable.
#### Via Abiword
For installing Abiword, set the `INSTALL_ABIWORD` build variable to any value.
Also, you will need to configure the path to the abiword executable
via setting the `abiword` property in `<BASEDIR>/settings.json.docker` to
`/usr/bin/abiword` or via setting the environment variable `ABIWORD` to
`/usr/bin/abiword`.
#### Via Libreoffice
For installing Libreoffice instead, set the `INSTALL_SOFFICE` build variable
to any value.
Also, you will need to configure the path to the libreoffice executable
via setting the `soffice` property in `<BASEDIR>/settings.json.docker` to
`/usr/bin/soffice` or via setting the environment variable `SOFFICE` to
`/usr/bin/soffice`.
docker: incorporate the docker docs into the official documentation This also means increasing the indentation level.
2019-11-08 22:17:34 +00: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 00:38:47 +00: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 21:56:30 +00: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 00:38:36 +00: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 00:38:47 +00: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 00:38:36 +00: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 00:32:34 +00:00
Include two plugins in the container:
```bash
doc: in the Docker example with custom plugins, replace ep_codepad -> ep_comments_page Prefer promoting ep_comments_page, since it has a wider audience and is better maintained.
2020-05-13 21:16:51 +00:00
docker build --build-arg ETHERPAD_PLUGINS="ep_comments_page ep_author_neat" --tag <YOUR_USERNAME>/etherpad .
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 00:32:34 +00:00
```
docker: incorporate the docker docs into the official documentation This also means increasing the indentation level.
2019-11-08 22:17:34 +00: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 00:38:36 +00:00
To run your instance:
```bash
docker: typos in the readme
2019-11-07 22:02:34 +00: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 00:38:36 +00:00
```
docker: typos in the readme
2019-11-07 22:02:34 +00: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 05:03:59 +00:00
docker: incorporate the docker docs into the official documentation This also means increasing the indentation level.
2019-11-08 22:17:34 +00: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 05:03:59 +00:00
docker: make settings fully configurable via env vars Now every setting in the official Etherpad container will be configurable via environment variables.
2020-04-16 21:24:49 +00:00
The `settings.json.docker` available by default allows to control almost every setting via environment variables.
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 05:03:59 +00: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 20:34:19 +00:00
### General
docker: minimal changes to the documentation
2019-11-08 22:15:03 +00: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 02:29:51 +00:00
| Variable | Description | Default |
| ------------------ | ------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
docker: fill in the default values in the documentation
2020-04-19 20:43:19 +00:00
| `TITLE` | The name of the instance | `Etherpad` |
| `FAVICON` | favicon default name, or a fully specified URL to your own favicon | `favicon.ico` |
| `DEFAULT_PAD_TEXT` | The default text of a pad | `Welcome to Etherpad! This pad text is synchronized as you type, so that everyone viewing this page sees the same text. This allows you to collaborate seamlessly on documents! Get involved with Etherpad at https://etherpad.org` |
| `IP` | IP which etherpad should bind at. Change to `::` for IPv6 | `0.0.0.0` |
| `PORT` | port which etherpad should bind at | `9001` |
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 02:29:51 +00:00
| `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 20:34:19 +00: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 02:29:51 +00:00
| Variable | Description | Default |
| ------------- | -------------------------------------------------------------- | --------------------------------------------------------------------- |
docker: fill in the default values in the documentation
2020-04-19 20:43:19 +00:00
| `DB_TYPE` | a database supported by https://www.npmjs.com/package/ueberdb2 | not set, thus will fall back to `DirtyDB` (please choose one instead) |
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 02:29:51 +00:00
| `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) | |
doc/docker.md - add sqlite to DB_FILENAME The configuration option `DB_FILENAME` is also used in conjunction with the `sqlite` ueberdb2 adapter.
2021-06-30 16:03:37 +00:00
| `DB_FILENAME` | in case `DB_TYPE` is `DirtyDB` or `sqlite`, the database file. | `var/dirty.db`, `var/etherpad.sq3` |
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 20:34:19 +00:00
docker: in the db documentation, specify that we are not going to include every single variable a driver may want
2020-04-21 02:24:32 +00: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 20:34:19 +00:00
docker: make settings fully configurable via env vars Now every setting in the official Etherpad container will be configurable via environment variables.
2020-04-16 21:24:49 +00:00
### Pad Options
| Variable | Description | Default |
| -------------------------------- | ----------- | ------- |
| `PAD_OPTIONS_NO_COLORS` | | `false` |
| `PAD_OPTIONS_SHOW_CONTROLS` | | `true` |
| `PAD_OPTIONS_SHOW_CHAT` | | `true` |
| `PAD_OPTIONS_SHOW_LINE_NUMBERS` | | `true` |
| `PAD_OPTIONS_USE_MONOSPACE_FONT` | | `false` |
pad: Use `null` as default for `userName`, `userColor` options These options are used as strings, so it doesn't make sense to default them to a boolean value. Note that this change has no effect due to a bug in how pad options are processed; that bug will be fixed in a future commit.
2021-12-05 02:36:02 +00:00
| `PAD_OPTIONS_USER_NAME` | | `null` |
| `PAD_OPTIONS_USER_COLOR` | | `null` |
docker: make settings fully configurable via env vars Now every setting in the official Etherpad container will be configurable via environment variables.
2020-04-16 21:24:49 +00:00
| `PAD_OPTIONS_RTL` | | `false` |
| `PAD_OPTIONS_ALWAYS_SHOW_CHAT` | | `false` |
| `PAD_OPTIONS_CHAT_AND_USERS` | | `false` |
pad: Use `null` as default for `lang` option It doesn't make sense to override the browser's language with `en-gb` by default. Note that this change has no effect due to a bug in how pad options are processed; that bug will be fixed in a future commit.
2021-12-05 02:33:38 +00:00
| `PAD_OPTIONS_LANG` | | `null` |
docker: make settings fully configurable via env vars Now every setting in the official Etherpad container will be configurable via environment variables.
2020-04-16 21:24:49 +00:00
### Shortcuts
| Variable | Description | Default |
| ----------------------------------- | ------------------------------------------------ | ------- |
| `PAD_SHORTCUTS_ENABLED_ALT_F9` | focus on the File Menu and/or editbar | `true` |
| `PAD_SHORTCUTS_ENABLED_ALT_C` | focus on the Chat window | `true` |
| `PAD_SHORTCUTS_ENABLED_CMD_S` | save a revision | `true` |
| `PAD_SHORTCUTS_ENABLED_CMD_Z` | undo/redo | `true` |
| `PAD_SHORTCUTS_ENABLED_CMD_Y` | redo | `true` |
| `PAD_SHORTCUTS_ENABLED_CMD_I` | italic | `true` |
| `PAD_SHORTCUTS_ENABLED_CMD_B` | bold | `true` |
| `PAD_SHORTCUTS_ENABLED_CMD_U` | underline | `true` |
| `PAD_SHORTCUTS_ENABLED_CMD_H` | backspace | `true` |
| `PAD_SHORTCUTS_ENABLED_CMD_5` | strike through | `true` |
| `PAD_SHORTCUTS_ENABLED_CMD_SHIFT_1` | ordered list | `true` |
| `PAD_SHORTCUTS_ENABLED_CMD_SHIFT_2` | shows a gritter popup showing a line author | `true` |
| `PAD_SHORTCUTS_ENABLED_CMD_SHIFT_L` | unordered list | `true` |
| `PAD_SHORTCUTS_ENABLED_CMD_SHIFT_N` | ordered list | `true` |
| `PAD_SHORTCUTS_ENABLED_CMD_SHIFT_C` | clear authorship | `true` |
| `PAD_SHORTCUTS_ENABLED_DELETE` | | `true` |
| `PAD_SHORTCUTS_ENABLED_RETURN` | | `true` |
| `PAD_SHORTCUTS_ENABLED_ESC` | in mozilla versions 14-19 avoid reconnecting pad | `true` |
| `PAD_SHORTCUTS_ENABLED_TAB` | indent | `true` |
| `PAD_SHORTCUTS_ENABLED_CTRL_HOME` | scroll to top of pad | `true` |
| `PAD_SHORTCUTS_ENABLED_PAGE_UP` | | `true` |
| `PAD_SHORTCUTS_ENABLED_PAGE_DOWN` | | `true` |
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 20:34:19 +00:00
### Skins
docker: make settings fully configurable via env vars Now every setting in the official Etherpad container will be configurable via environment variables.
2020-04-16 21:24:49 +00:00
You can use the UI skin variants builder at `/p/test#skinvariantsbuilder`
For the colibris skin only, you can choose how to render the three main containers:
* toolbar (top menu with icons)
* editor (containing the text of the pad)
* background (area outside of editor, mostly visible when using page style)
For each of the 3 containers you can choose 4 color combinations:
* super-light
* light
* dark
* super-dark
For the editor container, you can also make it full width by adding `full-width-editor` variant (by default editor is rendered as a page, with a max-width of 900px).
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 02:29:51 +00:00
| Variable | Description | Default |
| --------------- | ------------------------------------------------------------------------------ | --------------------------------------------------------- |
docker: fill in the default values in the documentation
2020-04-19 20:43:19 +00:00
| `SKIN_NAME` | either `no-skin`, `colibris` or an existing directory under `src/static/skins` | `colibris` |
docker: make settings fully configurable via env vars Now every setting in the official Etherpad container will be configurable via environment variables.
2020-04-16 21:24:49 +00:00
| `SKIN_VARIANTS` | multiple skin variants separated by spaces | `super-light-toolbar super-light-editor light-background` |
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 20:34:19 +00: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 02:29:51 +00:00
| Variable | Description | Default |
| -------------------- | ---------------------------------------------------- | ------- |
docker: fill in the default values in the documentation
2020-04-19 20:43:19 +00:00
| `LOGLEVEL` | valid values are `DEBUG`, `INFO`, `WARN` and `ERROR` | `INFO` |
docker: make settings fully configurable via env vars Now every setting in the official Etherpad container will be configurable via environment variables.
2020-04-16 21:24:49 +00:00
| `DISABLE_IP_LOGGING` | Privacy: disable IP logging | `false` |
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 20:34:19 +00:00
### Advanced
docker: Add variables for cookie settings
2022-01-19 21:53:25 +00:00
| Variable | Description | Default |
| --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------ |
| `COOKIE_SAME_SITE` | Value of the SameSite cookie property. | `"Lax"` |
| `COOKIE_SESSION_LIFETIME` | How long (ms) a user can be away before they must log in again. | `864000000` (10 days) |
| `COOKIE_SESSION_REFRESH_INTERVAL` | How often (ms) to write the latest cookie expiration time. | `86400000` (1 day) |
| `SHOW_SETTINGS_IN_ADMIN_PAGE` | hide/show the settings.json in admin page | `true` |
| `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 | `false` |
| `IMPORT_MAX_FILE_SIZE` | maximum allowed file size when importing a pad, in bytes. | `52428800` (50 MB) |
| `IMPORT_EXPORT_MAX_REQ_PER_IP` | maximum number of import/export calls per IP. | `10` |
| `IMPORT_EXPORT_RATE_LIMIT_WINDOW` | the call rate for import/export requests will be estimated in this time window (in milliseconds) | `90000` |
| `COMMIT_RATE_LIMIT_DURATION` | duration of the rate limit window for commits by individual users/IPs (in seconds) | `1` |
| `COMMIT_RATE_LIMIT_POINTS` | maximum number of changes per IP to allow during the rate limit window | `10` |
| `SUPPRESS_ERRORS_IN_PAD_TEXT` | Should we suppress errors from being visible in the default Pad Text? | `false` |
| `REQUIRE_SESSION` | If this option is enabled, a user must have a session to access pads. This effectively allows only group pads to be accessed. | `false` |
| `EDIT_ONLY` | Users may edit pads but not create new ones. Pad creation is only via the API. This applies both to group pads and regular pads. | `false` |
| `MINIFY` | If true, all css & js will be minified before sending to the client. This will improve the loading performance massively, but makes it difficult to debug the javascript/css | `true` |
| `MAX_AGE` | How long may clients use served javascript code (in seconds)? Not setting this may cause problems during deployment. Set to 0 to disable caching. | `21600` (6 hours) |
| `ABIWORD` | Absolute path to the Abiword executable. Abiword is needed to get advanced import/export features of pads. Setting it to null disables Abiword and will only allow plain text and HTML import/exports. | `null` |
| `SOFFICE` | This is the absolute path to the soffice executable. LibreOffice can be used in lieu of Abiword to export pads. Setting it to null disables LibreOffice exporting. | `null` |
| `TIDY_HTML` | Path to the Tidy executable. Tidy is used to improve the quality of exported pads. Setting it to null disables Tidy. | `null` |
| `ALLOW_UNKNOWN_FILE_ENDS` | Allow import of file types other than the supported ones: txt, doc, docx, rtf, odt, html & htm | `true` |
| `REQUIRE_AUTHENTICATION` | This setting is used if you require authentication of all users. Note: "/admin" always requires authentication. | `false` |
| `REQUIRE_AUTHORIZATION` | Require authorization by a module, or a user with is_admin set, see below. | `false` |
| `AUTOMATIC_RECONNECTION_TIMEOUT` | Time (in seconds) to automatically reconnect pad when a "Force reconnect" message is shown to user. Set to 0 to disable automatic reconnection. | `0` |
| `FOCUS_LINE_PERCENTAGE_ABOVE` | Percentage of viewport height to be additionally scrolled. e.g. 0.5, to place caret line in the middle of viewport, when user edits a line above of the viewport. Set to 0 to disable extra scrolling | `0` |
| `FOCUS_LINE_PERCENTAGE_BELOW` | Percentage of viewport height to be additionally scrolled. e.g. 0.5, to place caret line in the middle of viewport, when user edits a line below of the viewport. Set to 0 to disable extra scrolling | `0` |
| `FOCUS_LINE_PERCENTAGE_ARROW_UP` | Percentage of viewport height to be additionally scrolled when user presses arrow up in the line of the top of the viewport. Set to 0 to let the scroll to be handled as default by Etherpad | `0` |
| `FOCUS_LINE_DURATION` | Time (in milliseconds) used to animate the scroll transition. Set to 0 to disable animation | `0` |
| `FOCUS_LINE_CARET_SCROLL` | Flag to control if it should scroll when user places the caret in the last line of the viewport | `false` |
| `SOCKETIO_MAX_HTTP_BUFFER_SIZE` | The maximum size (in bytes) of a single message accepted via Socket.IO. If a client sends a larger message, its connection gets closed to prevent DoS (memory exhaustion) attacks. | `10000` |
| `LOAD_TEST` | Allow Load Testing tools to hit the Etherpad Instance. WARNING: this will disable security on the instance. | `false` |
| `DUMP_ON_UNCLEAN_EXIT` | Enable dumping objects preventing a clean exit of Node.js. WARNING: this has a significant performance impact. | `false` |
| `EXPOSE_VERSION` | Expose Etherpad version in the web interface and in the Server http header. Do not enable on production machines. | `false` |
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 20:34:19 +00: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 05:03:59 +00:00
docker: incorporate the docker docs into the official documentation This also means increasing the indentation level.
2019-11-08 22:17:34 +00: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 05:03:59 +00: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 09:44:40 +00: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
```