docs
cairnobs.org Demo Source
Esc

Documentation · install it, watch with it, run it

Cairn OBS documentation

How to install Cairn OBS, add your hosts, choose what it watches, send its alerts where your team will see them, and run it from one container up to thousands of VMs and pods.

Cairn OBS is a self-hosted monitor. An agent on each host reports to one server, which judges the readings, draws the maps, sends the alerts and writes the reports. For what it is and who it's for, see cairnobs.org.

How these pages are arranged

  • Get started says what Cairn OBS is and gets a first server running.
  • Install covers each way to run the server, HTTPS, signing in, and adding Linux and Windows hosts.
  • What it watches has a page for each part: hosts, checks, maps, certificates, backups, clusters, hypervisors, storage, Vault, IBM i, Cloudflare, Akamai, mail and databases. Each says what it reads, how to turn it on, and what raises an alert.
  • Alerts and reports is about who gets told what, and when.
  • Run it covers keeping settings in files, backups of Cairn OBS itself, running several copies, and its security model.
  • Reference lists every setting in the config files and every command.

Press Ctrl K (⌘K on a Mac) or / anywhere to search these pages.

Every page, by section

  1. Get started3 pages

  2. Install8 pages

  3. What it watches14 pages

  4. Alerts and reports4 pages

  5. Run it4 pages

  6. Reference6 pages