> Docs · Docker Hub · Releases
> Source: https://orochibraru.com/baba/canary/docs/readme · Site index: https://orochibraru.com/llms.txt

# Baba

![License](https://img.shields.io/badge/license-MIT-blue.svg)
![Latest Release](https://img.shields.io/github/v/release/orochibraru/baba)
![Docker Pulls](https://img.shields.io/docker/pulls/orochibraru/baba)

[Docs](https://github.com/orochibraru/baba/blob/main/docs/README.md) · [Docker Hub](https://hub.docker.com/r/orochibraru/baba)
· [Releases](https://github.com/orochibraru/baba/releases)

> Named after the lookout pirate in the French comic book _Astérix_, always
> watching for trouble on the horizon.

> [!CAUTION]
>
> While the app's version is more than 1.x it's still in beta and may contain
> bugs. It won't impact your system but I can't guarantee it's reliable yet
> until I have long term data to prove it.

Baba is a lightweight homelab monitor that sends Discord or Telegram alerts when
something goes wrong — and tells you when it's fixed.

## What it does

- Watches **CPU usage**, **system load**, **memory**, **disk**, **CPU/GPU
  temperature**, and **GPU utilization**
- Alerts via **Discord** and/or **Telegram** (multiple notifiers supported)
- **Deduplicates**: opens an incident only on the Nth consecutive breach — no
  per-cycle spam
- **Recovery alerts**: notifies you when a metric returns to normal
- **Reminders**: re-alerts at a configurable interval while an incident stays
  open
- Stores full **incident history** in a local JSON file
- One static binary (about 7 MB, 3 MB gzipped), no runtime or dependencies

## Run it

### Install script (Linux / macOS)

```bash
curl -fsSL https://github.com/orochibraru/baba/releases/latest/download/install.sh | sh
baba setup      # wizard: notifiers and thresholds
baba validate   # send a test alert
baba install    # background service (launchd on macOS, systemd on Linux)
```

Details in [Getting started](https://orochibraru.com/baba/canary/docs/getting-started).

### Docker Compose

```bash
curl -o config.json https://raw.githubusercontent.com/orochibraru/baba/main/config.example.json
curl -o compose.yaml https://raw.githubusercontent.com/orochibraru/baba/main/compose.example.yaml
# edit config.json: at least one notifier
docker compose up -d
```

Flags, env-only setup and disks in a container: [Docker](https://orochibraru.com/baba/canary/docs/docker).

## Documentation

- [Getting started](https://orochibraru.com/baba/canary/docs/getting-started) and [Docker](https://orochibraru.com/baba/canary/docs/docker)
- [Configuration file](https://orochibraru.com/baba/canary/docs/config) and [environment variables](https://orochibraru.com/baba/canary/docs/env)
- [Checks](https://orochibraru.com/baba/canary/docs/checks): what's measured, and how, on Linux and macOS
- [Notifiers](https://orochibraru.com/baba/canary/docs/notifiers): Discord and Telegram
- [Background service](https://orochibraru.com/baba/canary/docs/service), [incidents](https://orochibraru.com/baba/canary/docs/incidents),
  [CLI reference](https://orochibraru.com/baba/canary/docs/commands), [updates](https://orochibraru.com/baba/canary/docs/updates)
- [Troubleshooting](https://orochibraru.com/baba/canary/docs/troubleshooting)
- [Architecture](https://orochibraru.com/baba/canary/docs/architecture)

## Contributing

See [CONTRIBUTING.md](https://orochibraru.com/baba/canary/docs/contributing).

## License

MIT, see [LICENSE](https://github.com/orochibraru/baba/blob/main/LICENSE).