Self-host HedgeDoc on a VPS
Real-time collaborative markdown notes you can host yourself.
levelrail-cli templates deploy hedgedoc --name my-hedgedocSpecification
- Status
- Listed
- Category
- Productivity
- Services
- db, hedgedoc
- Ports
- 3000
- Volumes
- 2
- Memory
- about 512 MiB
- arm64
- image published
- amd64
- image published
- Settings to fill in
- none
About HedgeDoc
Real-time collaborative markdown notes you can host yourself. Runs 2 containers (db, hedgedoc), with hedgedoc listening on port 3000; data is kept in named volumes.
What it deploys
HedgeDoc runs as 2 services in a single Compose app, listening on port 3000, with 2 named volume mounts.
| Service | Image | Tag | Ports | Volumes |
|---|---|---|---|---|
| db | postgres | 16-alpine | none | hedgedoc_db_data -> /var/lib/postgresql/data |
| hedgedoc | quay.io/hedgedoc/hedgedoc | 1.9.9 | 3000 | hedgedoc_uploads -> /hedgedoc/public/uploads |
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 3000 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. 4 secrets are generated at deploy and stored encrypted. Values are never shown here.
| Service | Variable | Value |
|---|---|---|
| db | POSTGRES_DB | Preset by the template |
| db | POSTGRES_PASSWORD | Generated at deploy |
| db | POSTGRES_USER | Generated at deploy |
| hedgedoc | CMD_DB_URL | Generated at deploy |
| hedgedoc | CMD_DOMAIN | Preset by the template |
| hedgedoc | CMD_SESSION_SECRET | Generated at deploy |
| hedgedoc | CMD_URL_ADDPORT | Preset by the template |
Install HedgeDoc 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 hedgedoc -
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 hedgedoc --name my-hedgedoc
Without a domain the app gets an sslip.io address. You can also deploy it from the dashboard: Apps, New app, Browse templates, then HedgeDoc.
Docs and upstream
More in Productivity
- HeyFormA form builder for surveys, quizzes and lead capture, with conversational forms and a MongoDB backend.
- GrocyA self-hosted ERP for your household: groceries, chores, and a shopping list that stays in sync.
- GristA modern relational spreadsheet that combines spreadsheet flexibility with database structure.
- HomeboxA home inventory and organization system for tracking what you own and where it is.
- Gramps WebAn online genealogy system for researching and sharing family trees.
- IssoA lightweight self-hosted comment server for static sites with a small JavaScript embed. Comments live in a SQLite file on a volume.