diff --git a/docs/content/dev/getting-started.md b/docs/content/dev/getting-started.md index b7154b05f..76b0609fa 100644 --- a/docs/content/dev/getting-started.md +++ b/docs/content/dev/getting-started.md @@ -2,7 +2,7 @@ ## Preparing for running the code -**Notice:** *There's [specialised instructions for docker](../setup/docker.md) or [heroku](../setup/heroku.md), if you prefer running code this way!* +**Notice:** *There's [specialised instructions for docker](../setup/docker.md) if you prefer running code this way!* 1. Clone the repository with `git clone https://github.com/hedgedoc/hedgedoc.git hedgedoc-server` (cloning is the preferred way, but you can also download and unzip a release) diff --git a/docs/content/setup/arch-linux.md b/docs/content/setup/arch-linux.md deleted file mode 100644 index 1ffcabf21..000000000 --- a/docs/content/setup/arch-linux.md +++ /dev/null @@ -1,5 +0,0 @@ -# Arch Linux - -HedgeDoc is available in the Arch Linux _community_ repository. - -[Link to the package](https://archlinux.org/packages/community/any/hedgedoc/) diff --git a/docs/content/setup/cloudron.md b/docs/content/setup/cloudron.md deleted file mode 100644 index 3085e6bdd..000000000 --- a/docs/content/setup/cloudron.md +++ /dev/null @@ -1,10 +0,0 @@ -# Cloudron - -HedgeDoc is available as a 1-click install on [Cloudron](https://cloudron.io). Cloudron makes it easy to run apps like HedgeDoc on your server and keep them up-to-date and secure. - -[![Install](https://cloudron.io/img/button.svg)](https://cloudron.io/button.html?app=io.hackmd.cloudronapp) - -The source code for the package can be found [here](https://git.cloudron.io/cloudron/codimd-app). - -There is a [demo instance](https://my.demo.cloudron.io) (username: cloudron password: cloudron) where -you can experiment with running HedgeDoc. diff --git a/docs/content/setup/community.md b/docs/content/setup/community.md new file mode 100644 index 000000000..33aba8278 --- /dev/null +++ b/docs/content/setup/community.md @@ -0,0 +1,72 @@ +# 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. + +## Container Deployments + +### LinuxServer.io Docker image + +[![Discord](https://img.shields.io/discord/354974912613449730.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=Discord&logo=discord)](https://discord.gg/YWrKVTn "realtime support / chat with the community and the team.") +[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-hedgedoc.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-hedgedoc/releases) + +[LinuxServer.io](https://linuxserver.io) have created an Ubuntu-based multi-arch container image for x86-64, arm64 and armhf. + +- It supports all the environment variables detailed in the [configuration documentation](../configuration.md) 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](https://github.com/linuxserver/docker-hedgedoc/#application-setup) HedgeDoc using their [SWAG docker image](https://github.com/linuxserver/docker-swag) + +In order to contribute check the LinuxServer.io [GitHub repository](https://github.com/linuxserver/docker-hedgedoc/) for HedgeDoc. +And to find all tags and versions of the image, check the [Docker Hub repository](https://hub.docker.com/r/linuxserver/hedgedoc). + + +### Helm Chart + +You can deploy HedgeDoc on your Kubernetes cluster using `helm`. + +[HedgeDoc Helm Chart by nicholaswilde on Artifact Hub](https://artifacthub.io/packages/helm/nicholaswilde/hedgedoc) +[Website](https://nicholaswilde.github.io/helm-charts/) +[Source Code](https://github.com/nicholaswilde/helm-charts/tree/main/charts/hedgedoc) + +## One-click Installer + +### Heroku + +You can quickly setup a sample Heroku HedgeDoc application by clicking the button +below. + +[![Deploy on Heroku](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/hedgedoc/hedgedoc/tree/master) + +### YunoHost + +HedgeDoc is available as a 1-click install on [YunoHost](https://yunohost.org/). YunoHost is a Debian GNU/Linux based distribution packaged with free software that automates the installation of a personal web server. + +[![Install HedgeDoc with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=hedgedoc) + +The source code for the package can be found [here](https://github.com/YunoHost-Apps/hedgedoc_ynh). + +### Cloudron + +HedgeDoc is available as a 1-click install on [Cloudron](https://cloudron.io). Cloudron makes it easy to run apps like HedgeDoc on your server and keep them up-to-date and secure. + +[![Install](https://cloudron.io/img/button.svg)](https://cloudron.io/button.html?app=io.hackmd.cloudronapp) + +The source code for the package can be found [here](https://git.cloudron.io/cloudron/codimd-app). + +There is a [demo instance](https://my.demo.cloudron.io) (username: cloudron password: cloudron) where +you can experiment with running HedgeDoc. + +### PikaPods + +[PikaPods](https://www.pikapods.com/) 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](https://quay.io/repository/hedgedoc/hedgedoc). + +[![Run on PikaPods](https://www.pikapods.com/static/run-button.svg)](https://www.pikapods.com/pods?run=hedgedoc) + +## Distribution Packages + +### Arch Linux + +HedgeDoc is available in the Arch Linux _community_ repository. + +[Link to the package](https://archlinux.org/packages/community/any/hedgedoc/) diff --git a/docs/content/setup/docker-linuxserver.md b/docs/content/setup/docker-linuxserver.md deleted file mode 100644 index 33302f55f..000000000 --- a/docs/content/setup/docker-linuxserver.md +++ /dev/null @@ -1,20 +0,0 @@ -# LinuxServer.io HedgeDoc Image - -[![Discord](https://img.shields.io/discord/354974912613449730.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=Discord&logo=discord)](https://discord.gg/YWrKVTn "realtime support / chat with the community and the team.") -[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-hedgedoc.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-hedgedoc/releases) -[![GitHub Package Repository](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub%20Package&logo=github)](https://github.com/linuxserver/docker-hedgedoc/packages) -[![GitLab Container Registry](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab)](https://gitlab.com/linuxserver.io/docker-hedgedoc/container_registry) -[![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/hedgedoc.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge)](https://microbadger.com/images/linuxserver/hedgedoc "Get your own version badge on microbadger.com") -[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/hedgedoc.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/r/linuxserver/hedgedoc) -[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/hedgedoc.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker)](https://hub.docker.com/r/linuxserver/hedgedoc) -[![Jenkins Build](https://img.shields.io/jenkins/build?labelColor=555555&logoColor=ffffff&style=for-the-badge&jobUrl=https%3A%2F%2Fci.linuxserver.io%2Fjob%2FDocker-Pipeline-Builders%2Fjob%2Fdocker-hedgedoc%2Fjob%2Fmain%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-hedgedoc/job/main/) -[![LSIO CI](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=CI&query=CI&url=https%3A%2F%2Fci-tests.linuxserver.io%2Flinuxserver%2Fhedgedoc%2Flatest%2Fci-status.yml)](https://ci-tests.linuxserver.io/linuxserver/hedgedoc/latest/index.html) - -[LinuxServer.io](https://linuxserver.io) have created an Ubuntu-based multi-arch container image for x86-64, arm64 and armhf. - -- It supports all the environment variables detailed in the [configuration documentation](../configuration.md) 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](https://github.com/linuxserver/docker-hedgedoc/#application-setup) HedgeDoc using their [SWAG docker image](https://github.com/linuxserver/docker-swag) - -In order to contribute check the LinuxServer.io [GitHub repository](https://github.com/linuxserver/docker-hedgedoc/) for HedgeDoc. -And to find all tags and versions of the image, check the [Docker Hub repository](https://hub.docker.com/r/linuxserver/hedgedoc). diff --git a/docs/content/setup/heroku.md b/docs/content/setup/heroku.md deleted file mode 100644 index e6280051a..000000000 --- a/docs/content/setup/heroku.md +++ /dev/null @@ -1,6 +0,0 @@ -# Heroku Deployment - -You can quickly setup a sample Heroku HedgeDoc application by clicking the button -below. - -[![Deploy on Heroku](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/hedgedoc/hedgedoc/tree/master) diff --git a/docs/content/setup/kubernetes-helm.md b/docs/content/setup/kubernetes-helm.md deleted file mode 100644 index 67a27e822..000000000 --- a/docs/content/setup/kubernetes-helm.md +++ /dev/null @@ -1,7 +0,0 @@ -# Helm Chart - -You can deploy HedgeDoc on your Kubernetes cluster using `helm`. - -[HedgeDoc Helm Chart by nicholaswilde on Artifact Hub](https://artifacthub.io/packages/helm/nicholaswilde/hedgedoc) - -[Source Code](https://nicholaswilde.github.io/helm-charts/) diff --git a/docs/content/setup/pikapods.md b/docs/content/setup/pikapods.md deleted file mode 100644 index c4084f764..000000000 --- a/docs/content/setup/pikapods.md +++ /dev/null @@ -1,6 +0,0 @@ -# PikaPods Deployment - -[PikaPods](https://www.pikapods.com/) 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](https://quay.io/repository/hedgedoc/hedgedoc). - -[![Run on PikaPods](https://www.pikapods.com/static/run-button.svg)](https://www.pikapods.com/pods?run=hedgedoc) diff --git a/docs/content/setup/yunohost.md b/docs/content/setup/yunohost.md deleted file mode 100644 index dac4c0b1b..000000000 --- a/docs/content/setup/yunohost.md +++ /dev/null @@ -1,8 +0,0 @@ -YunoHost -=== - -HedgeDoc is available as a 1-click install on [YunoHost](https://yunohost.org/). YunoHost is a Debian GNU/Linux based distribution packaged with free software that automates the installation of a personal web server. - -[![Install HedgeDoc with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=hedgedoc) - -The source code for the package can be found [here](https://github.com/YunoHost-Apps/hedgedoc_ynh). diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 1c92b32c2..c2ad017e7 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -12,14 +12,7 @@ nav: - Official installation methods: - 'Docker Image': setup/docker.md - 'Manual Installation': setup/manual-setup.md - - Heroku: setup/heroku.md - - Community installation methods: - - 'LinuxServer Docker Image': setup/docker-linuxserver.md - - 'Helm Chart': setup/kubernetes-helm.md - - 'YunoHost App': setup/yunohost.md - - 'Cloudron App': setup/cloudron.md - - 'Arch Linux Package': setup/arch-linux.md - - 'PikaPods Hosting': setup/pikapods.md + - 'Community installation methods': setup/community.md - Guides: - 'Reverse Proxy': guides/reverse-proxy.md - Authentication: