HedgeDoc
otsumami.hedgedoc
A Docker Compose file for HedgeDoc alone, generated from the catalog and checked by the safety inspector. No account needed.
Real-time collaborative Markdown editor where several people edit one note simultaneously in the browser, with live preview, slide mode, diagrams and per-note access control.
HedgeDoc renders a split view with Markdown source on one side and formatted output on the other, synchronising edits between connected browsers so a meeting note or specification can be written by several people at once. Notes support diagram syntaxes, mathematical notation, embedded media and a presentation mode that turns headings into slides. Permissions run per note, from freely editable by anyone with the link through to owner-only, with optional authentication through local accounts or an external identity provider. A first deployment configures the database and the public domain, then creates one note and opens it from a second browser.
You know it worked when
- The interface loads and a new note can be created.
- Text typed in one browser appears in a second browser viewing the same note.
- The rendered preview updates as the Markdown source changes.
- A note set to owner-only access is refused to an anonymous visitor.
- Notes survive a container restart with the database persisted.
Known sharp edges
- The domain and protocol settings must match how users actually reach the instance, or the collaborative websocket connection fails while the page itself loads normally.
- New notes default to permissive access, so an instance reachable from outside allows anyone with a link to read and edit unless the defaults are tightened.
- Notes and uploaded images live in the configured database and upload directory, both of which must persist independently of the container.
- The pinned 1.x line is in maintenance while a rewritten 2.0 is developed separately, so feature work has largely stopped on the version deployed here.