Getting started¶
This section gets you from zero to a running PiHerder with a first admin account.
Path¶
- Requirements — what you need on the host and the fleet
- Install (Docker Compose) — clone,
.env,docker compose up - First login — register admin, lock registration
- Trusted HTTPS & TLS — required for PWA / mobile Web Push
- Appearance — light / dark theme (optional)
- Operator scenarios — “I want to…” index for the rest of the wiki
Then continue with Add a server and the Dashboard.
Supported install path¶
Docker Compose only
The supported topology is the compose stack in this repository (web, db, redis, celery-worker, caddy).
Kubernetes and bare-metal installs are under consideration only — not documented as supported paths.
Time estimate¶
| Step | Typical |
|---|---|
| Clone + generate secrets | 5 min |
First compose up --build | 5–15 min (image build) |
| Register + open UI | 2 min |
| Trusted certs (if not ready) | depends on your CA / ACME |
| First server + key deploy | 10–20 min |
Related repo docs¶
| Doc | Role |
|---|---|
| README | Project overview |
.env.example | Full env catalog |
| docs/ADMIN.md | Long-form admin reference (mirrored into this wiki) |