Operator scenarios (index)¶
Quick map from what you want to do → the right wiki page. Use this after Install and First login.
First week¶
| Scenario | Doc |
|---|---|
| Compose install + secrets | Install |
| Register first admin (no default user), then invite others | First login · Users |
| Trusted HTTPS for PWA/push | HTTPS & TLS |
| Light / dark theme | Appearance |
| About PiHerder / GitHub / new version notice | Avatar menu → About (/about) |
| Add a Pi, deploy SSH key, features | Add a server |
| Dashboard tiles & fleet services | Dashboard & Services |
Backups & patching¶
| Scenario | Doc |
|---|---|
| Configure rsync sources + schedule | Backups |
| Restore path (dry-run then apply) | Backups |
| Check OS / images only | Updates |
| Apply OS or container patch | Updates |
| Bulk check/patch/backup many hosts | Updates — Bulk |
| Reboot without hanging the UI | Updates — Reboot |
| See job progress / cancel | Jobs |
| Who did what (incl. client IP) | Audit |
Docker on hosts¶
| Scenario | Doc |
|---|---|
| Browse projects / containers / logs | Docker overview |
| Fast open via inventory cache | Inventory |
| Edit compose, validate, deploy version | Compose edit |
| Stack Check updates vs Deploy | Updates — Docker |
| Prune dangling images / exited containers | Docker overview |
Service templates¶
| Scenario | Doc |
|---|---|
| Deploy OOTB NPM / Kuma / Pi-hole / Grafana | Deploy |
| Redeploy, volumes, wait modal | Deploy — Redeploy |
Check drift / import host .env / apply last known config | Deploy — ops |
| Pull existing stack into a template | From host |
| View secrets (step-up 2FA) | Secrets |
Catalog: integrations & network¶
| Scenario | Doc |
|---|---|
| Catalog tabs (Integrations / Certificates / Templates / Network) | Integrations overview |
| Connect Kuma + bind services | Uptime Kuma |
| Grafana deep links + preferred names | Grafana |
| Multi Pi-hole, DNS fan-out, gravity | Pi-hole |
| Host A records, service paths, Hosts/Path maps (incl. mobile Hide map / Full screen / rotate) | Network maps |
| Switch light/dark; ops-hero layout; portrait↔landscape | Appearance |
| NPM proxy hosts (read-only) + pull cert | NPM |
| Cert vault, maps, deploy, renew | Certificates |
Account, users, security¶
| Scenario | Doc |
|---|---|
| Viewer / operator / admin | Roles |
| Create users, roles | Users |
| TOTP, backup codes, force 2FA | 2FA |
| Install PWA + Web Push | PWA & push |
Operations & DR¶
| Scenario | Doc |
|---|---|
.env keys | Env reference |
| Volume mounts | Volumes |
| Settings tabs (backup, security, status, timezone, API) | Settings |
| Stack Status healthy? | Status |
| Herder self-backup / restore (admin only) | Self-backup · Roles |
| Upgrade compose / image | Upgrades |
| More backup parallelism | Multi-worker |
| Prometheus / webhook | Metrics |
| Token REST for n8n/HA | API tokens |
When things go wrong¶
| Scenario | Doc |
|---|---|
| SSH / rsync / docker group | SSH troubleshooting |
| Backup stuck | Backup troubleshooting |
| Push not arriving | Push troubleshooting |
| Template / compose editor | Templates troubleshooting |
| Symptom table | Troubleshooting index |