{
  "schema_version": 1,
  "generated_at": "2026-10-23T00:00:00.000Z",
  "canonical_url": "https://openlogs.fyi/tools/hedgedoc",
  "slug": "hedgedoc",
  "name": "HedgeDoc",
  "tagline": "Collaborative Markdown editor where several people edit one note together.",
  "replaces": {
    "summary": "Paid collaborative document editing services, such as Google Docs.",
    "products": [
      {
        "slug": "google-docs",
        "name": "Google Docs",
        "vendor": "Google",
        "url": "https://openlogs.fyi/alternatives/google-docs"
      }
    ]
  },
  "stack": [
    {
      "kind": "language",
      "name": "TypeScript"
    },
    {
      "kind": "database",
      "name": "PostgreSQL"
    }
  ],
  "deployment_methods": [
    "docker_compose"
  ],
  "requirements": {
    "min_ram_mb": null,
    "min_cpu_cores": null,
    "source_url": null
  },
  "license": {
    "spdx": "AGPL-3.0",
    "class": "osi",
    "source_url": "https://github.com/hedgedoc/hedgedoc/blob/f98ea9c4079dea39a54ed6d20e9521a3039dbff7/LICENSE"
  },
  "business_model": {
    "value": "unknown",
    "notes": "The README at the pinned commit does not state a business model, so it stays unknown.",
    "source_url": "https://github.com/hedgedoc/hedgedoc/blob/f98ea9c4079dea39a54ed6d20e9521a3039dbff7/README.md",
    "checked_at": "2026-10-22"
  },
  "difficulty": {
    "value": "hard",
    "reason": "4 services (1 database or broker: postgres), 5 volume mounts, 5 env values to set, no elevated host access. Heuristic score 7 of 11: hard. A source checkout is needed, so the rating is at least medium."
  },
  "repository": {
    "owner": "hedgedoc",
    "name": "hedgedoc",
    "url": "https://github.com/hedgedoc/hedgedoc"
  },
  "compose_check": {
    "status": "config_ok",
    "validated_at": "2026-10-22",
    "summary": "config_ok on 2026-10-22"
  },
  "recipe": {
    "version": 1,
    "source_path": "docs/content/files/setup-docker/docker-compose.yml",
    "source_repo": "hedgedoc/hedgedoc",
    "source_commit_sha": "f98ea9c4079dea39a54ed6d20e9521a3039dbff7",
    "source_kind": "app_repo",
    "source_url": "https://github.com/hedgedoc/hedgedoc/blob/f98ea9c4079dea39a54ed6d20e9521a3039dbff7/docs/content/files/setup-docker/docker-compose.yml"
  },
  "install_steps": [
    {
      "order": 1,
      "kind": "prerequisite",
      "language": "text",
      "label": "Docker with the Compose plugin and git",
      "body": "A host with Docker, the Docker Compose plugin and git. This entry needs a checkout of the project repository.",
      "source_url": "https://github.com/hedgedoc/hedgedoc/blob/f98ea9c4079dea39a54ed6d20e9521a3039dbff7/docs/content/tutorials/setup.md",
      "validation_status": "unvalidated"
    },
    {
      "order": 2,
      "kind": "shell",
      "language": "bash",
      "label": "Get the source at commit f98ea9c",
      "body": "git init hedgedoc\ncd hedgedoc\ngit remote add origin https://github.com/hedgedoc/hedgedoc.git\ngit sparse-checkout init --cone\ngit sparse-checkout set docs/content/files/setup-docker\ngit fetch --depth 1 --filter=blob:none origin f98ea9c4079dea39a54ed6d20e9521a3039dbff7\ngit checkout FETCH_HEAD",
      "source_url": "https://github.com/hedgedoc/hedgedoc/blob/f98ea9c4079dea39a54ed6d20e9521a3039dbff7/docs/content/tutorials/setup.md",
      "validation_status": "unvalidated"
    },
    {
      "order": 3,
      "kind": "shell",
      "language": "bash",
      "label": "Go to the folder the docs use",
      "body": "cd docs/content/files/setup-docker",
      "source_url": "https://github.com/hedgedoc/hedgedoc/blob/f98ea9c4079dea39a54ed6d20e9521a3039dbff7/docs/content/tutorials/setup.md",
      "validation_status": "unvalidated"
    },
    {
      "order": 4,
      "kind": "compose",
      "language": "yaml",
      "label": "The compose file in the checkout: docs/content/files/setup-docker/docker-compose.yml (shown here for reading)",
      "body": "services:\n  backend:\n    image: ghcr.io/hedgedoc/hedgedoc/backend:2.0.0-alpha.3\n    volumes:\n      - $PWD/.env:/usr/src/app/backend/.env\n      - hedgedoc_uploads:/usr/src/app/backend/uploads\n\n  frontend:\n    image: ghcr.io/hedgedoc/hedgedoc/frontend:2.0.0-alpha.3\n    environment:\n      HD_BASE_URL: \"${HD_BASE_URL}\"\n      HD_INTERNAL_API_URL: http://backend:3000\n      HOSTNAME: \"0.0.0.0\"\n\n  db:\n    image: postgres:16\n    environment:\n      POSTGRES_USER: \"${HD_DATABASE_USERNAME}\"\n      POSTGRES_PASSWORD: \"${HD_DATABASE_PASSWORD}\"\n      POSTGRES_DB: \"${HD_DATABASE_NAME}\"\n    volumes:\n      - hedgedoc_postgres:/var/lib/postgresql/data\n\n  proxy:\n    image: caddy:latest\n    restart: unless-stopped\n    environment:\n      HD_BASE_URL: \"${HD_BASE_URL}\"\n    ports:\n      - \"80:80\"\n      - \"443:443\"\n      - \"443:443/udp\"\n    volumes:\n      - $PWD/Caddyfile:/etc/caddy/Caddyfile\n      - caddy_data:/data\n\nvolumes:\n  caddy_data:\n  hedgedoc_uploads:\n  hedgedoc_postgres:",
      "source_url": "https://github.com/hedgedoc/hedgedoc/blob/f98ea9c4079dea39a54ed6d20e9521a3039dbff7/docs/content/files/setup-docker/docker-compose.yml",
      "validation_status": "config_ok"
    },
    {
      "order": 5,
      "kind": "shell",
      "language": "bash",
      "label": "Copy config.env to .env",
      "body": "cp config.env .env",
      "source_url": "https://github.com/hedgedoc/hedgedoc/blob/f98ea9c4079dea39a54ed6d20e9521a3039dbff7/docs/content/tutorials/setup.md",
      "validation_status": "unvalidated"
    },
    {
      "order": 6,
      "kind": "note",
      "language": "text",
      "label": "What the compose file check ran with",
      "body": "The compose file check ran in a checkout of hedgedoc/hedgedoc at f98ea9c4079dea39a54ed6d20e9521a3039dbff7 (a sparse checkout: the top-level files and the folder docs/content/files/setup-docker), in the folder docs/content/files/setup-docker, after config.env was copied to .env. The setup tutorial tells the reader to download config.env as .env, the Caddyfile and docker-compose.yml from the docs site, edit .env and run docker compose up -d. The same files are in docs/content/files/setup-docker of the repository.",
      "source_url": "https://github.com/hedgedoc/hedgedoc/blob/f98ea9c4079dea39a54ed6d20e9521a3039dbff7/docs/content/tutorials/setup.md",
      "validation_status": "unvalidated"
    },
    {
      "order": 7,
      "kind": "shell",
      "language": "bash",
      "label": "Start it",
      "body": "docker compose up -d",
      "source_url": "https://github.com/hedgedoc/hedgedoc/blob/f98ea9c4079dea39a54ed6d20e9521a3039dbff7/docs/content/tutorials/setup.md",
      "validation_status": "unvalidated"
    },
    {
      "order": 8,
      "kind": "verify",
      "language": "text",
      "label": "Open the app",
      "body": "Open https://hedgedoc.localhost. The docs name this address. The compose file publishes host port 443 for the proxy service. The docs say this address is enough for a local test; the base URL is set in .env.",
      "source_url": "https://github.com/hedgedoc/hedgedoc/blob/f98ea9c4079dea39a54ed6d20e9521a3039dbff7/docs/content/tutorials/setup.md",
      "validation_status": "unvalidated"
    }
  ],
  "notes": [
    {
      "kind": "gotcha",
      "title": "Some images use the latest tag or no tag",
      "body": "Images without a pinned version: proxy: caddy:latest. A later pull can get a different version.",
      "source_url": "https://github.com/hedgedoc/hedgedoc/blob/f98ea9c4079dea39a54ed6d20e9521a3039dbff7/docs/content/files/setup-docker/docker-compose.yml",
      "checked_at": "2026-10-22"
    },
    {
      "kind": "gotcha",
      "title": "The compose file publishes host ports",
      "body": "Host ports: 80 (proxy), 443 (proxy), 443/udp (proxy). A port without a host address listens on all host network interfaces.",
      "source_url": "https://github.com/hedgedoc/hedgedoc/blob/f98ea9c4079dea39a54ed6d20e9521a3039dbff7/docs/content/files/setup-docker/docker-compose.yml",
      "checked_at": "2026-10-22"
    },
    {
      "kind": "gotcha",
      "title": "The compose file mounts host folders",
      "body": "Host paths mounted into containers: $PWD/.env at /usr/src/app/backend/.env (backend), $PWD/Caddyfile at /etc/caddy/Caddyfile (proxy).",
      "source_url": "https://github.com/hedgedoc/hedgedoc/blob/f98ea9c4079dea39a54ed6d20e9521a3039dbff7/docs/content/files/setup-docker/docker-compose.yml",
      "checked_at": "2026-10-22"
    }
  ],
  "signals": {
    "captured_at": "2026-10-22",
    "stars": 7490,
    "forks": 609,
    "open_issues": 275,
    "last_push": "2026-10-22",
    "days_since_push": 0,
    "latest_release": "1.12.0",
    "latest_release_date": "2026-08-21",
    "days_since_release": 62
  },
  "links": {
    "html": "https://openlogs.fyi/tools/hedgedoc",
    "markdown": "https://openlogs.fyi/tools/hedgedoc.md",
    "json": "https://openlogs.fyi/tools/hedgedoc.json"
  },
  "updated_at": "2026-10-22"
}