HedgeDoc

[![#HedgeDoc on matrix.org][matrix.org-image]][matrix.org-url] [![version][github-version-badge]][github-release-page] [![POEditor][poeditor-image]][poeditor-url] [![Mastodon][social-mastodon-image]][social-mastodon]

HedgeDoc lets you create real-time collaborative markdown notes. You can test-drive it by visiting our [HedgeDoc demo server][hedgedoc-demo].

It is inspired by Hackpad, Etherpad and similar collaborative editors. This project originated with the team at HackMD and now forked into its own organisation. [A longer writeup can be read in the history][history].

[][hedgedoc-demo-features]

Community and Contributions

We welcome contributions! There's a lot to do: If you would like to report bugs, the [issue tracker][github-issue-tracker] is the right place. If you can help translating, find us on [POEditor][poeditor-url]. To get started developing, take a look at the [developer documentation][developer-documentation]. In any case: come talk to us, we'll be delighted to help you with the first steps.

To stay up to date with our work or get support it's recommended to join our [Matrix channel][matrix.org-url], stop by our [community forums][hedgedoc-community] or subscribe to the [release feed][github-release-feed]. We also engage in regular [community calls][hedgedoc-community-calls] (RSS) which you are very welcome to join.

Installation / Upgrading

You can run HedgeDoc in a number of ways, and we created setup instructions for all of these:

• [Docker][setup-docker]
• [Cloudron][setup-cloudron]
• [LinuxServer.io (multi-arch docker)][setup-docker-linuxserver]
• [Heroku][setup-heroku]
• [Manual setup][setup-manual]

Configuration

Theres two main ways to [configure][configuration] your HedgeDoc instance: config file or environment variables. You can choose what works best for you.

HedgeDoc can integrate with

• facebook, twitter, github, gitlab, mattermost, dropbox, google, ldap, saml and [oauth2][configuration-oauth] for login
• imgur, s3, minio, azure for image/attachment storage (files can also be local!)
• dropbox for export and import

More info about that can be found in the configuration docs above.

Browser support

To use HedgeDoc, your browser should match or exceed these versions:

• Chrome >= 47, Chrome for Android >= 47
• Safari >= 10.1, iOS Safari >= 10.3
• ![Fir