https://github.com/Monogramm/docker-etherpad
:whale: Custom Docker container for Etherpad
https://github.com/Monogramm/docker-etherpad
docker etherpad node
Last synced: about 1 month ago
JSON representation
:whale: Custom Docker container for Etherpad
- Host: GitHub
- URL: https://github.com/Monogramm/docker-etherpad
- Owner: Monogramm
- License: agpl-3.0
- Created: 2020-03-21T17:15:32.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2020-06-18T00:25:53.000Z (almost 5 years ago)
- Last Synced: 2025-03-27T20:11:19.040Z (about 1 month ago)
- Topics: docker, etherpad, node
- Language: Shell
- Homepage: https://github.com/ether/etherpad-lite
- Size: 101 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-starred - Monogramm/docker-etherpad - :whale: Custom Docker container for Etherpad (node)
README
[![License: AGPL v3][uri_license_image]][uri_license]
[](https://monogramm.github.io/etherpad/)
[](https://travis-ci.org/Monogramm/docker-etherpad)
[](https://www.codacy.com/gh/Monogramm/docker-etherpad?utm_source=github.com&utm_medium=referral&utm_content=Monogramm/docker-etherpad&utm_campaign=Badge_Grade)
[](https://hub.docker.com/r/monogramm/docker-etherpad/)
[](https://hub.docker.com/r/monogramm/docker-etherpad/)
[](https://microbadger.com/images/monogramm/docker-etherpad)
[](https://microbadger.com/images/monogramm/docker-etherpad)
[](https://github.com/Monogramm/docker-etherpad)
# **Etherpad** Docker image
Docker image for **Etherpad** setup for production and with additionnal plugins.
:construction: **This image is still in beta!**
Additionnal plugins installed:
- [ep_hash_auth](https://www.npmjs.com/package/ep_hash_auth)
- [ep_markdown](https://www.npmjs.com/package/ep_markdown)
- [ep_ldapauth](https://www.npmjs.com/package/ep_ldapauth)
- [ep_piwik](https://www.npmjs.com/package/ep_piwik)
- [ep_webpack](https://www.npmjs.com/package/ep_webpack)
This image also includes custom wait scripts. See docker-compose examples on how to use it.
## What is **Etherpad**
Real-time collaborative document editor.
> [**Etherpad**](https://etherpad.org/)
## Supported tags
[Dockerhub monogramm/docker-etherpad](https://hub.docker.com/r/monogramm/docker-etherpad/)
- From Etherpad-lite [`master` branch](https://github.com/ether/etherpad-lite/tree/master)
- `alpine` `latest`
- `debian`
- From Etherpad-lite [`develop` branch](https://github.com/ether/etherpad-lite/tree/develop)
- `develop-alpine` `develop`
- `develop-debian`
- From Etherpad-lite [`1.8.4` tag](https://github.com/ether/etherpad-lite/releases/tag/1.8.4)
- `1.8.4-alpine` `1.8.4`
- `1.8.4-debian`
- From Etherpad-lite [`1.8.3` tag](https://github.com/ether/etherpad-lite/releases/tag/1.8.3)
- `1.8.3-alpine` `1.8.3`
- `1.8.3-debian`
- From Etherpad-lite [`1.8.0` tag](https://github.com/ether/etherpad-lite/releases/tag/1.8.0)
- `1.8.0-alpine` `1.8.0`
- `1.8.0-debian`
## How to run this image
To run your instance:
```bash
docker run --detach --publish :9001 monogramm/docker-etherpad
```
And point your browser to `http://:`
## Options available by default
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`.
- `IP`: IP which etherpad should bind at. Change to `::` for IPv6
- `PORT`: port which etherpad should bind at
- `SHOW_SETTINGS_IN_ADMIN_PAGE`: hide/show the settings.json in admin page
- `DB_TYPE`: a database supported by
- `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. Default: `var/dirty.db`
- `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)
- `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
- `LOGLEVEL`: valid values are `DEBUG`, `INFO`, `WARN` and `ERROR`
- `LOCALE`: default locale
- `REQUIRE_AUTH`: if you require authentication of all users.
- `REQUIRE_SESSION`: if you require session and effectively allows only group pads to be accessed.
- `MINIFY`: if you wish to disable minify.
[ep_ldapauth](https://www.npmjs.com/package/ep_ldapauth) options:
- `LDAP_ENABLED`: LDAP enabled. Format: any non null value will enable `ldapauth`
- `LDAP_URL`: LDAP URL. Format: `ldaps://ldap.example.com`
- `LDAP_BASE_DN`: LDAP Account Base. Format: `ou=Users,dc=example,dc=com`
- `LDAP_ACCOUNT_PATTERN`: LDAP Account Pattern. Format: `(&(objectClass=*)(uid={{username}}))`
- `LDAP_DISPLAY_NAME_ATTR`: LDAP Display name attribute. Format: `cn`
- `LDAP_SEARCH_DN`: LDAP Search DN. Format: `uid=searchuser,dc=example,dc=com`
- `LDAP_SEARCH_PASSWD`: LDAP Search Password. Format: `supersecretpassword`
- `LDAP_GROUP_DN`: LDAP Group DN. Format: `ou=Groups,dc=example,dc=com`
- `LDAP_GROUP_ATTR`: LDAP Group attribute. Format: `member`
- `LDAP_GROUP_ATTR_IS_DN`: LDAP Group attribute is DN. Format: `false` or `true` (default)
- `LDAP_GROUP_SCOPE`: LDAP Group scope. Format: `sub`
- `LDAP_GROUP_SEARCH`: LDAP Group search pattern. Format: `(&(cn=etherpad-admin)(objectClass=groupOfNames))`
- `LDAP_ANON_RO`: LDAP Anonymous read only. Format: `false` (default) or `true`
[ep_piwik](https://www.npmjs.com/package/ep_piwik) options:
- `PIWIK_URL`: Matomo / Piwik URL
- `PIWIK_SITE_ID`: Matomo / Piwik Site ID
[ep_markdown](https://www.npmjs.com/package/ep_markdown) options:
- `MARKDOWN`: Enable/disable markdown support
### Examples
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' \
monogramm/docker-etherpad
```
Run enabling the administrative user `admin`:
```shell
docker run -d \
--name etherpad \
-p 9001:9001 \
-e 'ADMIN_PASSWORD=supersecret' \
monogramm/docker-etherpad
```
Run a test instance running DirtyDB on a persistent volume:
```shell
docker run -d \
-v etherpad_data:/opt/etherpad-lite/var \
-p 9001:9001 \
monogramm/docker-etherpad
```
## Questions / Issues
If you got any questions or problems using the image, please visit our [Github Repository](https://github.com/Monogramm/docker-etherpad) and write an issue.
[uri_license]: http://www.gnu.org/licenses/agpl.html
[uri_license_image]: https://img.shields.io/badge/License-AGPL%20v3-blue.svg