Community Installation Methods¶
The HedgeDoc community has created and tested many options for deploying HedgeDoc on other platforms or operating systems. You can check them out below. Feel free to create a PR to add your tested community installation method.
These are not officially supported by the HegeDoc maintainers. If you encounter issues or have questions, please first reach out to downstream packagers.
Container Deployments¶
LinuxServer.io Docker Image¶
LinuxServer.io have created an Alpine-based multi-arch container image for x86-64, arm64 and armhf.
- It supports all the environment variables detailed in the configuration documentation to modify it according to your needs.
- It gets rebuilt on new releases from HedgeDoc and also weekly if necessary to update any other package changes in the underlying container, making it easy to keep your HedgeDoc instance up to date.
- It also details how to easily utilize Docker networking to reverse proxy HedgeDoc using their SWAG docker image
In order to contribute check the LinuxServer.io GitHub repository for HedgeDoc. And to find all tags and versions of the image, check the Docker Hub repository.
Helm Chart¶
You can deploy HedgeDoc on your Kubernetes cluster using helm.
HedgeDoc Helm Chart by nicholaswilde on Artifact Hub
Website
Source Code
One-click Installer¶
Heroku¶
You can quickly setup a sample Heroku HedgeDoc application by clicking the button below.
YunoHost¶
HedgeDoc is available as a 1-click install on YunoHost. YunoHost is a Debian GNU/Linux based distribution packaged with free software that automates the installation of a personal web server.
The source code for the package can be found here.
Cloudron¶
HedgeDoc is available as a 1-click install on Cloudron. Cloudron makes it easy to run apps like HedgeDoc on your server and keep them up-to-date and secure.
The source code for the package can be found here.
There is a demo instance (username: cloudron password: cloudron) where you can experiment with running HedgeDoc.
PikaPods¶
PikaPods offers simple hosting for open source apps. Run HedgeDoc within seconds using the button below. This will run the official Docker image from quay.io.
Distribution Packages¶
Arch Linux¶
HedgeDoc is available in the Arch Linux community repository.
FreeBSD¶
HedgeDoc is available in the FreeBSD ports repository. After installation, customise your config.json file, referring to the official HedgeDoc documentation.