# HedgeDoc

HedgeDoc is a self-hosted, real-time collaborative Markdown editor for creating and sharing notes, documents, and wikis with multiple contributors simultaneously across desktop, tablet, and mobile browsers. It is open source and self-hosted, installable on Kubernetes (Helm), ZimaOS, Docker Hub and Unraid.

Canonical page: https://ourlocalhost.com/app/1017/hedgedoc

## Description

HedgeDoc is a self-hosted, real-time collaborative Markdown editor for creating and sharing notes, documents, and wikis with multiple contributors simultaneously across desktop, tablet, and mobile browsers.

## Platform availability

Available on 3 of 9 platforms: Unraid, ZimaOS, Helm.

## Health score

74/100 (Good), based on 4 of 4 factors.
- Maintained: 100 (last commit 22 days ago)
- Popular: 34 (50 GitHub stars)
- Easy to install: 55 (3 install platforms, install notes, Docker image)
- Light to run: 95 (512 MB minimum RAM, runs on ARM)

## Links

- Kubernetes (Helm): https://artifacthub.io/packages/helm/nicholaswilde/hedgedoc
- ZimaOS: https://github.com/bigbeartechworld/big-bear-casaos/tree/master/Apps/hedgedoc
- Docker Hub: https://hub.docker.com/r/linuxserver/hedgedoc
- GitHub: https://github.com/linuxserver/docker-hedgedoc
- Official website: https://hedgedoc.org/
- Unraid: https://ca.unraid.net/apps/hedgedoc-062dejr1qoxoxf?q=hedgedoc

## Common questions

### What files must be present before starting HedgeDoc with the official Docker Compose setup?

Download the .env, Caddyfile, and docker-compose.yml files into the same folder before starting HedgeDoc. If these files are missing or out of sync, Docker may fail or start the app with the wrong settings.

### Which .env values should be changed before running HedgeDoc?

Set HD_BASE_URL to the address you will use and replace HD_SESSION_SECRET with a long random password-like string. A wrong base URL can break login and shared links, while an unchanged secret can let people impersonate other users.

### What reverse proxy support does HedgeDoc need for live collaboration?

Use the included Caddyfile or configure your own reverse proxy so it can pass real-time connections through to HedgeDoc. Without this, the site may load but live editing and update notifications can fail.

### Does the LinuxServer.io HedgeDoc container support user mapping?

Yes, the LinuxServer.io container provides easy user mappings using PUID and PGID.

## Alternatives

- Caret Markdown Editor
- Dillinger: Dillinger is a cloud-enabled, mobile-ready Markdown editor with offline storage, built for fast, distraction-free note writing.
- Etherpad: Etherpad is an open-source, web-based collaborative real-time editor that enables multiple users to simultaneously edit a document from dif…
- HackMD: HackMD is a browser-based, real-time collaborative markdown editor.
- HelixNotes: HelixNotes is a local markdown note-taking app built with Rust, Tauri 2.0, and SvelteKit.
- MarkText: Markdown editor for Mac, Windows, and Linux with real-time preview and distraction-free interface.
- MarkdownPad: MarkdownPad is a full-featured Markdown editor for Windows.
- ReText: ReText is a simple text editor for Markdown and reStructuredText documents with syntax highlighting and optional live preview.
- Rentry.co: Rentry.co is a markdown pastebin and publishing service with preview, custom urls and editing.
- StackEdit: StackEdit is a self-hostable, open-source Markdown editor based on PageDown, the same library used by Stack Overflow.
- ghostwriter: Ghostwriter is a distraction-free Markdown text editor for Windows and Linux, designed for focused writing of blog posts, papers, novels, a…

---
Source: Our Local Host (https://ourlocalhost.com/app/1017/hedgedoc), the self-hosted and open-source app directory.