Files
cairnobs/config/agent.example.yaml
T
jcoffey-dev 77dac1c9c4
ci / check (pull_request) Successful in 5m32s
ci / postgres (pull_request) Successful in 10m31s
Ready to be read: SECURITY.md, the docs site, generic names
SECURITY.md says where to report a problem ([email protected]) and
what's in scope. The README points at docs.cairnobs.org for people
installing Cairn OBS.

The tests, examples and notes named a real fleet: its host names, its
mesh and desk link, a public address, its site and its backups. They're
now node1, node2 and so on, wg-desk, 10.30/10.31, 203.0.113.52 (TEST-NET-3),
Lisbon, wiki-db and photos.

docs/install.md's Windows paragraph said no VMs; the agent now reports
certificate stores, the event log and Hyper-V's VMs, on amd64 and arm64.
2026-11-15 13:24:15 -07:00

34 lines
1.6 KiB
YAML

# obs-beacon-agent's config. Copy to /etc/obs-beacon/agent.yaml (root:obs-beacon, 0640).
server: "https://beacon.example.org:8461" # obs-beacond's agent listener (TLS)
ca_fingerprint: "sha256:<64 hex characters>" # `obs-beacond ca` on the server prints it
token_file: /etc/obs-beacon/agent.token # one line, from `obs-beacond token` (obs-beacon:obs-beacon, 0600); enrolls once
# state_dir: /var/lib/obs-beacon-agent # the agent's certificate and key (default)
# host: node1 # defaults to the short hostname
interval: 15s
helper_socket: /run/obs-beacon/helper.sock # the root helper: containers and the map sample; remove to skip both
# map: false # no map sample here: no socket sample, no WireGuard read (docs/maps.md)
# Who watches Cairn OBS (hosts other than obs-beacond's): when reports have failed
# for `after` AND obs-beacond's public health page doesn't answer, obs-beacond is
# down, so this agent alerts through its own channels (same format as
# obs-beacond's alerts.channels), and says when it's back. If only this host's
# link is broken, the public page answers and nothing is sent here:
# obs-beacond alerts that this host went quiet.
# watch_server:
# after: 3m
# public_url: "https://obs.example.org/healthz"
# channels:
# - id: phone
# type: ntfy
# topic_file: /etc/obs-beacon/ntfy-topic
# min: critical
# - id: ops
# type: discord
# webhook_file: /etc/obs-beacon/discord-ops-webhook
# quiet: # obs-beacond's host's own reboot window
# - name: node3 auto-reboot
# daily: "05:30"
# timezone: Europe/Berlin
# duration: 20m