Self-host Etherpad on a VPS
A real-time collaborative editor for documents, with plugins and a clean export story.
levelrail-cli templates deploy etherpad --name my-etherpadSpecification
- Status
- Listed
- Category
- Productivity
- Services
- etherpad
- Ports
- 9001
- Volumes
- 1
- Memory
- about 256 MiB
- arm64
- image published
- amd64
- image published
- Settings to fill in
- none
- License
- Permissive license, Apache-2.0
About Etherpad
A real-time collaborative editor for documents, with plugins and a clean export story. Runs as a single container from the etherpad image, listening on port 9001; data is kept in named volumes.
What it deploys
Etherpad runs as one service in a single Compose app, listening on port 9001, with 1 named volume mount.
| Service | Image | Tag | Ports | Volumes |
|---|---|---|---|---|
| etherpad | etherpad/etherpad | 2.2.4 | 9001 | etherpad_data -> /opt/etherpad-lite/var |
Before you install
- CPU architecture. arm64 listed. Every image lists linux/arm64 in its registry manifest. That is a manifest fact, not proof the app runs on Arm.
- Listed. It is in the catalog. Back up the data volume before changing an image tag.
- Host ports. It publishes port 9001 directly on the host, so open them in the VPS firewall only if you want that.
Settings and environment
You do not have to fill in anything. 1 secret is generated at deploy and stored encrypted. Values are never shown here.
| Service | Variable | Value |
|---|---|---|
| etherpad | ADMIN_PASSWORD | Generated at deploy |
| etherpad | DEFAULT_PAD_TEXT | Preset by the template |
Install Etherpad on a VPS
-
Install Levelrail on a fresh VPS
Run this as root on a Linux server (amd64 or arm64) with ports 80 and 443 reachable. The installer prints a setup link.
curl -fsSL https://levelrail.com/install.sh | sudo sh -
Sign in
Open the setup link, choose a password, then log the CLI in. The CLI install command is
curl -fsSL https://levelrail.com/install-cli.sh | shif the machine does not have it. See Getting started.levelrail-cli login --device -
Read the template
Shows the entry, including its full compose.yaml.
levelrail-cli templates get etherpad -
Deploy it
This deploys the template compose file as an app. The app name defaults to the template id; --name sets another.
levelrail-cli templates deploy etherpad --name my-etherpad
Without a domain the app gets an sslip.io address. You can also deploy it from the dashboard: Apps, New app, Browse templates, then Etherpad.
Docs and upstream
More in Productivity
- ExcalidrawA self-hosted virtual whiteboard for sketching diagrams that feel hand-drawn.
- FiderA feedback platform for collecting and prioritizing user feature requests.
- FirefoxA private Firefox browser running on your server and streamed to a web page.
- Easy!AppointmentsAn open-source appointment scheduler for managing bookings, staff, and services.
- flatnotesA database-less note-taking app that keeps notes as plain Markdown files.
- draw.ioA self-hosted diagramming and whiteboarding editor for flowcharts, architecture diagrams, and more.