Home Assistant Add-on: HedgeDoc
The best platform to write and share markdown.
About
HedgeDoc (formerly known as CodiMD) is an open-source collaborative markdown editor. With HedgeDoc you can easily collaborate on notes, graphs and even presentations in real-time. All you need to do is to share your note-link to your co-workers, and they’re ready to go.
How do I use it?
The main prerequisite is to have a database available for HedgeDoc to store its data in. The add-on does not contain a database, it looks for an existing one.
The easiest way to satisfy this dependency is to install the MariaDB add-on. If that is installed you don’t need to configure anything else, this add-on will make a new database and store its application data in there.
If you don’t have this add-on installed or would prefer HedgeDoc use a different database that works as well. The documentation describes how to set that up.
Other then that the addon is essentially install and go. You need to put in a value for session_secret in the config but generally that’s it. Although there are more advanced options for tweaking HedgeDoc if you need them, see the docs for more details.
Where’s ‘show in sidebar’?
This addon cannot support ingress at this time. It has its own authentication mechanisms and currently does not support proxy-based authentication, an ingress requirement. This means you have to open it as a normal web application in its own tab or use iframe panel integration to make a navigation option.
Note that this also means the first thing you’ll have to do when you open HedgeDoc is go through user registration. HedgeDoc only supports email-based registration by default. There are many other options if you want that can be set up by providing the right environmental variables. You can also disable email based signup entirely in favor of one of those other methods or after signing up everyone you want to have access by setting access.allow_email_registration to false.
Support
If you need help you can:
- Comment here
- Open an issue in the repository
- Ask for help in the #add-ons channel of the HA discord (I’m CentralCommand#0913 there).