Files
cairnobs/README.md
T
jcoffey-dev 52e527d727
ci / check (pull_request) Successful in 5m36s
ci / postgres (pull_request) Successful in 10m53s
Launch: public image on GHCR, GitHub's copy of each release
.github/workflows/release.yml runs on GitHub when a v* tag arrives through
the mirror: it waits for Gitea's Release, checks SHA256SUMS's signature and
every file against it, copies the Release to GitHub and builds the server
image from those same binaries as ghcr.io/coffey-labs/cairnobs:<version>
(and :latest for a final release). Gitea doesn't read .github/workflows,
and every job waits on BUILD_ON=github like the other mirrored repos.

The docs, the kustomize base and the join.image example now name that
image; the image's labels point at the source and the docs. The
"Private until launch" lines are gone.
2026-11-15 13:42:59 -07:00

1.5 KiB

Cairn OBS (obs-beacon)

The new Cairn OBS: a self-hosted monitor for networks, hosts and services, with maps, metrics, alerts and reports. obs-beacon-agent runs on each host and reports to obs-beacond, which judges the reports, runs the alerts and serves the web interface. Licensed AGPLv3; the third-party code inside the binaries and its licenses are in THIRD_PARTY_NOTICES.md.

The documentation for people installing it is at https://docs.cairnobs.org/. To report a security problem, see SECURITY.md. The notes below are for working on the code.

Layout

cmd/obs-beacond      the server
cmd/obs-beacon-agent the agent, and its read-only root helper
internal/collect     host readings from /proc and statfs
internal/docker      Docker client and the helper's read-only gate
internal/report      the wire format between them
internal/server      API, judgement, sessions, embedded UI
web/                 the Svelte 5 interface
config/              example configs
deploy/systemd/      unit files for the hosts