{"id":20532019,"url":"https://github.com/monogramm/docker-etherpad","last_synced_at":"2025-10-09T11:16:02.722Z","repository":{"id":93144430,"uuid":"249024163","full_name":"Monogramm/docker-etherpad","owner":"Monogramm","description":":whale: Custom Docker container for Etherpad","archived":false,"fork":false,"pushed_at":"2020-06-18T00:25:53.000Z","size":103,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-27T20:11:19.040Z","etag":null,"topics":["docker","etherpad","node"],"latest_commit_sha":null,"homepage":"https://github.com/ether/etherpad-lite","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Monogramm.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-03-21T17:15:32.000Z","updated_at":"2021-10-14T13:00:05.000Z","dependencies_parsed_at":"2023-06-05T05:15:19.339Z","dependency_job_id":null,"html_url":"https://github.com/Monogramm/docker-etherpad","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":"Monogramm/docker-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Monogramm%2Fdocker-etherpad","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Monogramm%2Fdocker-etherpad/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Monogramm%2Fdocker-etherpad/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Monogramm%2Fdocker-etherpad/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Monogramm","download_url":"https://codeload.github.com/Monogramm/docker-etherpad/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248831062,"owners_count":21168395,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker","etherpad","node"],"created_at":"2024-11-16T00:12:03.953Z","updated_at":"2025-10-09T11:15:57.666Z","avatar_url":"https://github.com/Monogramm.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![License: AGPL v3][uri_license_image]][uri_license]\n[![Docs](https://img.shields.io/badge/Docs-Github%20Pages-blue)](https://monogramm.github.io/etherpad/)\n[![Build Status](https://travis-ci.org/Monogramm/docker-etherpad.svg)](https://travis-ci.org/Monogramm/docker-etherpad)\n[![Codacy Badge](https://api.codacy.com/project/badge/Grade/f861617056b245fe909f9f7ed1878018)](https://www.codacy.com/gh/Monogramm/docker-etherpad?utm_source=github.com\u0026amp;utm_medium=referral\u0026amp;utm_content=Monogramm/docker-etherpad\u0026amp;utm_campaign=Badge_Grade)\n[![Docker Automated buid](https://img.shields.io/docker/cloud/build/monogramm/docker-etherpad.svg)](https://hub.docker.com/r/monogramm/docker-etherpad/)\n[![Docker Pulls](https://img.shields.io/docker/pulls/monogramm/docker-etherpad.svg)](https://hub.docker.com/r/monogramm/docker-etherpad/)\n[![Docker Version](https://images.microbadger.com/badges/version/monogramm/docker-etherpad.svg)](https://microbadger.com/images/monogramm/docker-etherpad)\n[![Docker Size](https://images.microbadger.com/badges/image/monogramm/docker-etherpad.svg)](https://microbadger.com/images/monogramm/docker-etherpad)\n[![GitHub stars](https://img.shields.io/github/stars/Monogramm/docker-etherpad?style=social)](https://github.com/Monogramm/docker-etherpad)\n\n# **Etherpad** Docker image\n\nDocker image for **Etherpad** setup for production and with additionnal plugins.\n\n:construction: **This image is still in beta!**\n\nAdditionnal plugins installed:\n\n-   [ep_hash_auth](https://www.npmjs.com/package/ep_hash_auth)\n-   [ep_markdown](https://www.npmjs.com/package/ep_markdown)\n-   [ep_ldapauth](https://www.npmjs.com/package/ep_ldapauth)\n-   [ep_piwik](https://www.npmjs.com/package/ep_piwik)\n-   [ep_webpack](https://www.npmjs.com/package/ep_webpack)\n\nThis image also includes custom wait scripts. See docker-compose examples on how to use it.\n\n## What is **Etherpad**\n\nReal-time collaborative document editor.\n\n\u003e [**Etherpad**](https://etherpad.org/)\n\n## Supported tags\n\n[Dockerhub monogramm/docker-etherpad](https://hub.docker.com/r/monogramm/docker-etherpad/)\n\n-   From Etherpad-lite [`master` branch](https://github.com/ether/etherpad-lite/tree/master)\n    -   `alpine` `latest`\n    -   `debian`\n\n-   From Etherpad-lite [`develop` branch](https://github.com/ether/etherpad-lite/tree/develop)\n    -   `develop-alpine` `develop`\n    -   `develop-debian`\n\n-   From Etherpad-lite [`1.8.4` tag](https://github.com/ether/etherpad-lite/releases/tag/1.8.4)\n    -   `1.8.4-alpine` `1.8.4`\n    -   `1.8.4-debian`\n\n-   From Etherpad-lite [`1.8.3` tag](https://github.com/ether/etherpad-lite/releases/tag/1.8.3)\n    -   `1.8.3-alpine` `1.8.3`\n    -   `1.8.3-debian`\n\n-   From Etherpad-lite [`1.8.0` tag](https://github.com/ether/etherpad-lite/releases/tag/1.8.0)\n    -   `1.8.0-alpine` `1.8.0`\n    -   `1.8.0-debian`\n\n## How to run this image\n\nTo run your instance:\n\n```bash\ndocker run --detach --publish \u003cDESIRED_PORT\u003e:9001 monogramm/docker-etherpad\n```\n\nAnd point your browser to `http://\u003cYOUR_IP\u003e:\u003cDESIRED_PORT\u003e`\n\n## Options available by default\n\nThe `settings.json` available by default enables some configuration to be set from the environment.\n\nAvailable options:\n\n-   `TITLE`: The name of the instance\n-   `FAVICON`: favicon default name, or a fully specified URL to your own favicon\n-   `SKIN_NAME`: either `no-skin`, `colibris` or an existing directory under `src/static/skins`.\n-   `IP`: IP which etherpad should bind at. Change to `::` for IPv6\n-   `PORT`: port which etherpad should bind at\n-   `SHOW_SETTINGS_IN_ADMIN_PAGE`: hide/show the settings.json in admin page\n-   `DB_TYPE`: a database supported by \u003chttps://www.npmjs.com/package/ueberdb2\u003e\n-   `DB_HOST`: the host of the database\n-   `DB_PORT`: the port of the database\n-   `DB_NAME`: the database name\n-   `DB_USER`: a database user with sufficient permissions to create tables\n-   `DB_PASS`: the password for the database username\n-   `DB_CHARSET`: the character set for the tables (only required for MySQL)\n-   `DB_FILENAME`: in case `DB_TYPE` is `DirtyDB`, the database filename. Default: `var/dirty.db`\n-   `ADMIN_PASSWORD`: the password for the `admin` user (leave unspecified if you do not want to create it)\n-   `USER_PASSWORD`: the password for the first user `user` (leave unspecified if you do not want to create it)\n-   `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\n-   `LOGLEVEL`: valid values are `DEBUG`, `INFO`, `WARN` and `ERROR`\n-   `LOCALE`: default locale\n-   `REQUIRE_AUTH`: if you require authentication of all users.\n-   `REQUIRE_SESSION`: if you require session and effectively allows only group pads to be accessed.\n-   `MINIFY`: if you wish to disable minify.\n\n[ep_ldapauth](https://www.npmjs.com/package/ep_ldapauth) options:\n\n-   `LDAP_ENABLED`: LDAP enabled. Format: any non null value will enable `ldapauth`\n-   `LDAP_URL`: LDAP URL. Format: `ldaps://ldap.example.com`\n-   `LDAP_BASE_DN`: LDAP Account Base. Format: `ou=Users,dc=example,dc=com`\n-   `LDAP_ACCOUNT_PATTERN`: LDAP Account Pattern. Format: `(\u0026(objectClass=*)(uid={{username}}))`\n-   `LDAP_DISPLAY_NAME_ATTR`: LDAP Display name attribute. Format: `cn`\n-   `LDAP_SEARCH_DN`: LDAP Search DN. Format: `uid=searchuser,dc=example,dc=com`\n-   `LDAP_SEARCH_PASSWD`: LDAP Search Password. Format: `supersecretpassword`\n-   `LDAP_GROUP_DN`: LDAP Group DN. Format: `ou=Groups,dc=example,dc=com`\n-   `LDAP_GROUP_ATTR`: LDAP Group attribute. Format: `member`\n-   `LDAP_GROUP_ATTR_IS_DN`: LDAP Group attribute is DN. Format: `false` or `true` (default)\n-   `LDAP_GROUP_SCOPE`: LDAP Group scope. Format: `sub`\n-   `LDAP_GROUP_SEARCH`: LDAP Group search pattern. Format: `(\u0026(cn=etherpad-admin)(objectClass=groupOfNames))`\n-   `LDAP_ANON_RO`: LDAP Anonymous read only. Format: `false` (default) or `true`\n\n[ep_piwik](https://www.npmjs.com/package/ep_piwik) options:\n\n-   `PIWIK_URL`: Matomo / Piwik URL\n-   `PIWIK_SITE_ID`: Matomo / Piwik Site ID\n\n[ep_markdown](https://www.npmjs.com/package/ep_markdown) options:\n\n-   `MARKDOWN`: Enable/disable markdown support\n\n### Examples\n\nUse a Postgres database, no admin user enabled:\n\n```shell\ndocker run -d \\\n\t--name etherpad         \\\n\t-p 9001:9001            \\\n\t-e 'DB_TYPE=postgres'   \\\n\t-e 'DB_HOST=db.local'   \\\n\t-e 'DB_PORT=4321'       \\\n\t-e 'DB_NAME=etherpad'   \\\n\t-e 'DB_USER=dbusername' \\\n\t-e 'DB_PASS=mypassword' \\\n\tmonogramm/docker-etherpad\n```\n\nRun enabling the administrative user `admin`:\n\n```shell\ndocker run -d \\\n\t--name etherpad \\\n\t-p 9001:9001 \\\n\t-e 'ADMIN_PASSWORD=supersecret' \\\n\tmonogramm/docker-etherpad\n```\n\nRun a test instance running DirtyDB on a persistent volume:\n\n```shell\ndocker run -d \\\n\t-v etherpad_data:/opt/etherpad-lite/var \\\n\t-p 9001:9001 \\\n\tmonogramm/docker-etherpad\n```\n\n## Questions / Issues\n\nIf you got any questions or problems using the image, please visit our [Github Repository](https://github.com/Monogramm/docker-etherpad) and write an issue.\n\n[uri_license]: http://www.gnu.org/licenses/agpl.html\n\n[uri_license_image]: https://img.shields.io/badge/License-AGPL%20v3-blue.svg\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmonogramm%2Fdocker-etherpad","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmonogramm%2Fdocker-etherpad","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmonogramm%2Fdocker-etherpad/lists"}