Must have
Installation requirements
- A compatible amd64 or arm64 host for the official Docker image.
- Docker Compose for the documented container setup.
- A database and persistent uploaded-file storage.
Application hosting
HedgeDoc is a shared Markdown editor for meeting notes, technical documents and presentations. Several people can work on a note at the same time in a browser, with revisions to follow or reverse changes. It fits teams that prefer writing in Markdown and sharing a document link over installing a desktop editor. Diagrams and presentation mode make it useful beyond plain text notes.
Requirements last checked against the project's documentation.
Find the software and services needed to run the application.
See requirementsPlan memory, storage and CPU for the way you will use it.
Open resource plannerCompare plans for the starting size, then review the provider and billing terms.
See plansMust have
Recommended
Use the resource planner to size a server for your workload.
Simultaneous editing and attachment uploads are more useful sizing inputs than the number of registered accounts alone. Keep room for the database and uploads, and monitor growth after the team starts using the service.
Deploy with
The host must provide
Storage
Back up the database, uploaded files and configuration together. Notes and their attachments live in different parts of the deployment, so keeping only a database dump can leave a restored document without its images.
Step by step
Use the HedgeDoc 1.x container instructions and set up persistent database and upload volumes.
Official instructionsSet the correct external domain and HTTPS settings, and use a reverse proxy that forwards WebSocket connections.
Official instructionsSet the login provider and default note permissions before inviting the team.
Official instructionsSecurity
Cost
Want the full monthly bill? Use the hosting cost calculator. Add storage, backups and other costs to your estimate.