Self-host Etherpad with Levelrail
A real-time collaborative editor for documents, with plugins and a clean export story.
- Authorether
- LicenceApache-2.0
- Memory256 MiB
- Archarm64
- Services1
How to self-host Etherpad
-
Pull the images
One image is pulled on your server.
Show images
etherpad/etherpad:2.2.4
-
Create the app
One service starts in a single Compose app, with 1 named volume mount for your data, on port 9001.
-
Fill in the secrets
1 secret is generated and stored encrypted, 1 setting is preset, you do not have to fill in anything.
-
Open it
Without a domain the app gets an sslip.io address; add --domain SERVICE=HOST to use your own.
Etherpad requirements
- Memory
- About 256 MiB
- Architectures
- amd64 image published, arm64 image published
- Ports
- 9001
- Domain
- Optional, an sslip.io address is used without one
- Settings
- none to fill in
- License
- Apache-2.0, permissive license
- Listed. It is in the catalog but not verified. Back up the data volume before changing an image tag.
- Host ports. It publishes port 9001 on the host, so open them in the VPS firewall only if you want that.
Install Levelrail first
On a server with Levelrail running, run the command above, or open the dashboard: Apps, New app, Browse templates, then Etherpad. New to Levelrail? Install it on a fresh VPS first.
docker pull ghcr.io/glincker/levelrail:latest Then levelrail-cli login --device. See Getting started and the Etherpad docs page.
Deploy Etherpad your way
Every format below deploys the same pinned images. Pick the one that fits how you work.
Deploy Etherpad from the CLI
levelrail-cli templates deploy etherpad --name my-etherpad Deploy Etherpad with the API
curl -X POST -H "Authorization: Bearer $TOKEN" \
https://levelrail.example.com/api/v1/service-templates/etherpad/deploy Etherpad configuration
Etherpad services
| Service | Image | Ports | Volumes |
|---|---|---|---|
| etherpad | etherpad/etherpad:2.2.4 | 9001 | etherpad_data -> /opt/etherpad-lite/var |
Etherpad environment variables
| Variable | Service | Value |
|---|---|---|
| ADMIN_PASSWORD | etherpad | Generated at deploy |
| DEFAULT_PAD_TEXT | etherpad | Preset by the template |
Ports and volumes
- Ports
- 9001
- Volumes
- 1 named mount: etherpad_data -> /opt/etherpad-lite/var
Etherpad FAQ
How much memory does Etherpad need?
The catalog lists about 256 MiB of memory for Etherpad.
Does Etherpad run on arm64?
For Etherpad, an arm64 image is published; amd64 is image published.
What licence is Etherpad under?
Etherpad is licensed under Apache-2.0, which is permissive, with few conditions on reuse.
Does Etherpad need configuration before it starts?
No. The template fills in its own defaults and generates secrets at deploy time.
Which ports does Etherpad use?
Etherpad listens on port 9001 inside the stack.
Where does Etherpad keep its data?
In a named volume: etherpad_data mounted at /opt/etherpad-lite/var.
Can I deploy Etherpad on Dokploy or Dokku?
The services and pinned images on this page can be run on any Docker host. The public Dokploy templates list has an entry with the id etherpad for this app, so check that entry as well. Dokku deploys container images with its own commands, so the pinned image etherpad/etherpad:2.2.4 is what you deploy there.