README.md

Documentation

The guides in this folder, in reading order:

1. Getting started: install baba, configure it, get your first alert.
2. Docker: run it in a container instead.
3. Configuration file: every key in config.json and its default.
4. Environment variables: the BABA_* overrides.
5. Checks: what each check measures, and how, on Linux and macOS.
6. Notifiers: Discord and Telegram.
7. Background service: launchd and systemd, logs.
8. Incidents: when baba alerts, reminds and recovers.
9. CLI reference: every command and flag.
10. Updates: baba update and new-version alerts.
11. Troubleshooting: fixes for the errors you're likely to hit.
12. Architecture: how the code fits together.

This file is the index when someone reads the repo on GitHub; the docs site ignores it. The site's categories, order, titles and icons come from config.json.