# Self-host Etherpad

> A real-time collaborative editor for documents, with plugins and a clean export story.

- Page: https://levelrail.com/templates/etherpad/
- JSON: https://levelrail.com/templates/etherpad.json
- Category: Productivity
- Licence: Apache-2.0 (Permissive license)
- Source: https://github.com/ether/etherpad
- Upstream docs: https://docs.etherpad.org

## Requirements
- Memory: about 256 MiB
- amd64: published, arm64: published
- Needs configuration before start: no
- Pinned image tag: 2.2.4

## Services

| Service | Image | Tag | Ports | Volumes |
| --- | --- | --- | --- | --- |
| etherpad | etherpad/etherpad | 2.2.4 | 9001 | etherpad_data -> /opt/etherpad-lite/var |

## Environment

| Service | Variable | Kind |
| --- | --- | --- |
| etherpad | ADMIN_PASSWORD | generated |
| etherpad | DEFAULT_PAD_TEXT | preset |

## Deploy

### CLI

```bash
levelrail-cli templates deploy etherpad --name my-etherpad
```

### API

```bash
curl -X POST -H "Authorization: Bearer $TOKEN" \
  https://levelrail.example.com/api/v1/service-templates/etherpad/deploy
```

Create a token in the dashboard first. This one-click route deploys it as a trial app you can keep or remove.

## Questions

### 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.

Self-host Etherpad, Etherpad docker compose file, deploy Etherpad on a VPS: this page lists the pinned image, ports, volumes and the commands for each.
