Self-host HedgeDoc with Levelrail

Real-time collaborative markdown notes you can host yourself.

  • Authorhedgedoc
  • LicenceAGPL-3.0-only
  • Memory512 MiB
  • Archarm64
  • Services2

How to self-host HedgeDoc

  1. Pull the images

    2 images are pulled on your server.

    Show images
    • postgres:16-alpine
    • quay.io/hedgedoc/hedgedoc:1.9.9
  2. Create the app

    2 services start in a single Compose app, with 2 named volume mounts for your data, on port 3000.

  3. Fill in the secrets

    4 secrets are generated and stored encrypted, 3 settings are preset, you do not have to fill in anything.

  4. Open it

    Without a domain the app gets an sslip.io address; add --domain SERVICE=HOST to use your own.

HedgeDoc requirements

Memory
About 512 MiB
Architectures
amd64 image published, arm64 image published
Ports
3000
Domain
Optional, an sslip.io address is used without one
Settings
none to fill in
License
AGPL-3.0-only, network copyleft (agpl) 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 3000 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 HedgeDoc. 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 HedgeDoc docs page.

Deploy HedgeDoc your way

Every format below deploys the same pinned images. Pick the one that fits how you work.

Deploy HedgeDoc from the CLI

levelrail-cli templates deploy hedgedoc --name my-hedgedoc

Deploy HedgeDoc with the API

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

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

HedgeDoc configuration

HedgeDoc services

ServiceImagePortsVolumes
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

HedgeDoc environment variables

VariableServiceValue
POSTGRES_DB db Preset by the template
POSTGRES_PASSWORD db Generated at deploy
POSTGRES_USER db Generated at deploy
CMD_DB_URL hedgedoc Generated at deploy
CMD_DOMAIN hedgedoc Preset by the template
CMD_SESSION_SECRET hedgedoc Generated at deploy
CMD_URL_ADDPORT hedgedoc Preset by the template

Ports and volumes

Ports
3000
Volumes
2 named mounts: hedgedoc_db_data -> /var/lib/postgresql/data, hedgedoc_uploads -> /hedgedoc/public/uploads

HedgeDoc FAQ

How much memory does HedgeDoc need?

The catalog lists about 512 MiB of memory for HedgeDoc across its 2 services.

Does HedgeDoc run on arm64?

For HedgeDoc, an arm64 image is published; amd64 is image published.

What licence is HedgeDoc under?

HedgeDoc is licensed under AGPL-3.0-only, which is network copyleft, so source sharing also applies when it is offered as a hosted service.

Does HedgeDoc need configuration before it starts?

No. The template fills in its own defaults and generates secrets at deploy time.

Which database does HedgeDoc bundle?

The template includes Postgres, running as its own service.

Which ports does HedgeDoc use?

HedgeDoc listens on port 3000 inside the stack.

Where does HedgeDoc keep its data?

In named volumes: hedgedoc_db_data mounted at /var/lib/postgresql/data and hedgedoc_uploads mounted at /hedgedoc/public/uploads.

Can I deploy HedgeDoc 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 hedgedoc for this app, so check that entry as well. Dokku deploys container images with its own commands, so the pinned image postgres:16-alpine, quay.io/hedgedoc/hedgedoc:1.9.9 is what you deploy there.

levelrail-cli templates deploy hedgedoc --name my-hedgedoc