Every top-level setting of the server's config file, what it's for, its default, and the page that covers it in full.
2 min read
/etc/obs-beacon/obs-beacond.yaml, owned root:obs-beacon, mode 0640.
The packages put a full example in /usr/share/doc/obs-beacon-server/examples/.
The file is read strictly: a key obs-beacond doesn't know is an error. Quote
addresses that start with a bracket ("[::1]:8150"). Durations are written
like 90s, 15m or 26h (no days: write 168h for a week). Secrets are always in files of their own,
named by a *_file setting.
Listeners
Key
Default
listen
The web interface, the browser API and install.sh. host:port, or unix:/path for a proxy on the same machine
agent_listen
Agents' reports, over TLS with the agent CA. Without it, agents report to listen with tokens
agent_tls.names
Extra names for the agent port's certificate, for curl and other tools
agent_tls.off
false
Plain HTTP with tokens. Only inside a VPN, while agents move over
listen:":443"agent_listen:":8461"tls:acme:hostnames:[obs.example.org]accept_terms:truehttp_listen:":80"database:/var/lib/obs-beacon/beacon.dbstate_key_file:/etc/obs-beacon/state.keysnapshot:/var/lib/obs-beacon/backup/beacon.dbjoin:packages_url:https://git.coffeylabs.org/coffey-labs/cairnobs/releases/download/v0.1.0signin:providers:
- id:ssotype:oidclabel:Sign in with Oktaissuer:"https://example.okta.com"client_id:cairn-obsclient_secret_file:/etc/obs-beacon/sso-client-secretredirect_url:"https://obs.example.org/auth/sso/callback"admin_groups:[obs-admins]operator_groups:[obs-operators]viewer_groups:[obs-viewers]reports:timezone:Europe/Berlindigest: {weekday:monday, at:"08:00"}
Channels, checks, maintenance windows and what should run where are then
set in the web interface.