Skip to content

Reference ​

Lookup pages generated from the code, so they cannot drift from it: CI regenerates them (go run ./cmd/docgen -check) and fails when a committed page differs. To change one, change its source and run make docs-gen.

PageSourceContents
Configuration keysinternal/configEvery YAML key with its environment variable, type, default and description
Metricsregistered Prometheus collectorsName, type, labels and help of every metric served on /metrics
CLI commandsoa helpEvery oa command with its usage
REST APIinternal/api/openapi.jsonEvery endpoint per tag: parameters, request bodies, responses and schemas

How-to pages that explain behaviour, with prose and examples: configuration, monitoring, CLI and REST API.

Free software under the AGPL-3.0-or-later.