infrastructure/roles/codimd/README.md
saibotk e417949279
codimd: Switch to version 1.7 and the official hedgedoc image
This patch is the first version of the CodiMD role that runs the new
hedgedoc image. There will be further work to rework the role to be
called hedgedoc including a renaming of all variables.
2020-12-27 08:38:19 +01:00

1.1 KiB

HedgeDoc

This will setup a HedgeDoc server with their official docker container and traefik.

Requirements

You will need to have docker, docker-compose and traefik installed or declared as dependencies with their respective roles.

This role assumes that you have setup traefik with an endpoint called websecure.

Role Variables

Please look at the defaults/main.yml for all available variables and their description.

Note: Lines that are commented out via # are usually still valid/used variables, but they are not defined by default, so they might enable a feature, when uncommenting/defining them!

Global variables, that are used:

  • proxy_network: Defined by the local traefik installation, this is the shared proxy network used by traefik to reach the containers. (optional)
  • proxy_hiddenservice: Defined by the local traefik installation, this is used to generate the alt-svc header for the alternative Tor domain. (optional)

Dependencies

  • docker
  • docker-compose
  • traefik

License

GPL-3.0-only