Self-Hosting Cadenza Documentation

The full Cadenza documentation is available online. It is regularly updated by Disy. The Cadenza documentation includes:

  • Learning modules

  • User documentation

  • Administrator documentation

  • Developer documentation

The documentation container image is available in our external Docker registry under the name registry-ext.disy.net/cadenza/cadenza-docs. See Container Images for an overview of all our images and Documentation Image Versioning for the image tagging scheme.

The container image includes a webserver that listens on port 80.

Running with Docker or Podman

By default, the container serves the documentation via HTTP. You can run the documentation image directly with Docker:

docker run -p 8080:80 registry-ext.disy.net/cadenza/cadenza-docs:10.5-release

The documentation is then available at http://localhost:8080.

The image can also be run with Podman. Refer to the Podman documentation for the equivalent commands.

When running without a compose file, you have to take care of exposing the documentation in a suitable way with a reverse proxy for managing hostname, port and TLS. The configuration of a reverse proxy is not part of our documentation but can be found in the documentation of the suitable products.

Running with HTTPS and your own certificates

If you want to expose the documentation container directly via HTTPS, you can provide your own Caddy configuration file and mount your TLS certificate and private key into the container at runtime.

Create a Caddy configuration file, for example Caddyfile:

:443 {
    tls /certs/tls.crt /certs/tls.key

    root * /usr/share/caddy
    file_server
}

Then start the container and mount the Caddy configuration and certificate files:

docker run -p 8443:443 \
  -v /path/to/Caddyfile:/etc/caddy/Caddyfile:ro \
  -v /path/to/certs:/certs:ro \
  registry-ext.disy.net/cadenza/cadenza-docs:10.5-release

In this example, the mounted certificate directory must contain the following files:

  • tls.crt - the TLS certificate in PEM format

  • tls.key - the private key in PEM format

The documentation is then available at https://localhost:8443.

Running on Kubernetes

Another way to install the documentation image is on a Kubernetes cluster using our Generic Webapp Helm chart which takes care of creating all necessary Kubernetes objects needed to run a simple web application.

Customizing the Help Menu

To customize the Cadenza "Help" menu to link to your own hosted versions, see the Customizing Help Menu documentation.