HedgeDoc

Upstream source: Current installation guide. PostgreSQL holds notes and accounts; the Service volume preserves uploaded assets. Both must be backed up.

Towbar manifests

id: hedgedoc-postgres
name: HedgeDoc PostgreSQL
type: postgres
container:
  network: application
  networkAlias: hedgedoc-postgres
  resources:
    cpus: 1
    memory: 1g
secrets:
  runtime:
    - POSTGRES_USER
    - POSTGRES_DB
    - POSTGRES_PASSWORD
environments:
  production:
    server: 192.0.2.10

id: hedgedoc
name: HedgeDoc
buildServer: null
deployment:
  type: image
  image: quay.io/hedgedoc/hedgedoc:1.12.0
container:
  port: 3000
  network: application
  volumes:
    - name: uploads
      mountPath: /hedgedoc/public/uploads
      initialData: image
environments:
  production:
    server: 192.0.2.10
rollout:
  type: recreate
  maintenanceMode: true
  reason: Persistent application data uses a single writer
secrets:
  runtime:
    - CMD_DB_URL
    - CMD_DOMAIN
    - CMD_PROTOCOL_USESSL
domains:
  primary: hedgedoc.example.com
tls:
  mode: direct

Configure

Prepare the example server, connect the repository, and map production to the branch containing these manifests. Replace the example server IP and domain. Commit the manifests, then sync the repository and inspect the resolved configuration.
Save the initialization values in the table below for the postgres Datastore under Datastore → Settings → Secrets. Deploy it first and wait for readiness. These values create the database and user only on an empty volume.
Set the Service’s declared runtime values under Service → Settings → Secrets using the table below. Replace descriptions and placeholders with actual values; do not commit passwords or keys.
Keep the Service’s named volumes attached across deployments. Towbar’s Datastore backup policy does not back up Service volumes, so include them in your own recovery plan.
Deploy the Service, then perform the checks below before enabling auto-deploy.

Datastore values

Save these in each Datastore’s Settings → Secrets before deploying it. Use the suggested names or choose your own, then use the same names and passwords in the Service connection values below.

Datastore	Key	Suggested value
HedgeDoc postgres	`POSTGRES_DB`	hedgedoc
HedgeDoc postgres	`POSTGRES_USER`	hedgedoc
HedgeDoc postgres	`POSTGRES_PASSWORD`	Run `openssl rand -hex 32`; save its output and reuse it in the Service connection value.

Runtime values

Save these values on the Service after the repository sync. The manifest declares required keys, not their values.

Key	Value to save
`CMD_DB_URL`	`postgres://hedgedoc:PASSWORD@hedgedoc-postgres:5432/hedgedoc` (replace `PASSWORD` with `POSTGRES_PASSWORD`)
`CMD_DOMAIN`	hedgedoc.example.com
`CMD_PROTOCOL_USESSL`	true

Verify

Create a note and upload an image, then verify both survive a redeploy. For field constraints, see Service manifest and Datastore manifest.

Start here

Open-source software

Service recipes

Datastore recipes

Complete stacks

Towbar manifests

Configure

Datastore values

Runtime values

Verify

​Towbar manifests

​Configure

​Datastore values

​Runtime values

​Verify

Towbar manifests

Configure

Datastore values

Runtime values

Verify