On this page

Xodiac — first 10 minutes

From zero to a paging alert. Assumes the platform is deployed (composer install, npm run build in frontend/, php spark migrate, web server pointed at public/).

1 · Sign up (30 s)

Open /app → create a workspace (tenant). You land on the dashboard with an owner account. Enable 2FA in Settings when convenient.

2 · Enrol an agent (2 min)

Devices → Enrol token → create a token; the UI hands you a ready install_cmd. On the monitored host:

curl -fsSL https://<platform>/scripts/install-agent.sh | bash -s -- \
  --server https://<platform> --token <enrol-token>

The agent generates an Ed25519 key, enrols (TOFU), and starts long-polling signed config. It appears in Devices as online within one poll interval. Windows: install-agent.ps1 via irm https://<platform>/scripts/install-agent.ps1 (SYSTEM service, conf.d ACL-locked). Full flag reference: xodiac-agent/INSTALL.md.

3 · First check (1 min)

Checks → New check:

  • Ping https://example.com every 60 s (platform runner), or
  • agent http check against a local endpoint.

State flips to up/down on the next scheduled run (platform checks run via the xodiac:work/poll scheduler commands — cron them per deploy/README.md; agent checks run on the agent's interval).

4 · First alert (2 min)

Alerts → Channels → New: pick slack/discord/telegram/ ntfy/gotify and paste the webhook URL/token. Then Alert rules → New: scope = your check, condition down, channel = yours.

Break the check target → incident opens → notification fires. Resolve it → incident auto-resolves.

5 · Public status page (1 min)

Settings: set a status-page slug (or custom domain). Public page at /status/<slug> shows aggregate uptime — no login required. Ingest endpoints (POST /ingest/<token>) let external systems push custom service state.

Where next

  • Plugins — enable per-agent collectors (SNMP, docker, backups…) in conf.d/ + device plugin params.
  • Maintenance windows — schedule silences so planned work doesn't page.
  • Anomaly rules — condition.kind: anomaly on any metric/check value (z-score vs rolling baseline).
  • SSO — Settings → Single sign-on (business plan).
  • Backup/restore — docs/BACKUP-RESTORE.md (mysqldump + .env + writable/, tenant export/import, load-test procedure).
  • Full reference: FEATURES.md · security model: SECURITY.md · roadmap: ROADMAP.md.
← Xodiac docs index