Documentation site

Serve this documentation next to Polaris so the help links work.

The documentation is a static site (Hugo) served by static-web-server in a small, unprivileged container. Each Asterion release has a documentation image with the same version number: ghcr.io/poettinet/asterion-docs:<version>.

# docker-compose.yml of the documentation (comes with the docs repository)
services:
  docs:
    image: ghcr.io/poettinet/asterion-docs:${ASTERION_DOCS_VERSION:-latest}
    restart: unless-stopped
    read_only: true
    cap_drop: [ALL]
    security_opt: ["no-new-privileges:true"]
    ports:
      - "${ASTERION_DOCS_PORT:-8070}:8080"

ASTERION_DOCS_VERSION=0.4.1 docker compose up -d

Put it behind your TLS proxy (e.g. https://asteriondoc.meinlan.at) and set the same address in the Polaris .env:

POLARIS_DOCS_URL=https://asteriondoc.meinlan.at

Polaris then shows a ? next to page titles that leads to the matching page here, and a Documentation link in the footer and the user menu. An empty POLARIS_DOCS_URL removes the links.

The site sets no cookies, loads nothing from other hosts, and the server writes no access log. The container answers /health for health checks.