Operator guide
The operator guide is the home for running Ferrex safely. It prioritizes configuration, user data, recovery paths, and observable service behavior over implementation internals.
Core operator pages
Section titled “Core operator pages”| Page | Use it for |
|---|---|
| Configuration | .env, Compose overlays, Nix shells, scanner policy, logging, TLS, and safe defaults. |
| Authentication security model | Password sessions, device PIN sessions, remember-device trust, lockout, revoke, and no-wipe recovery. |
| Unraid deployment notes | Compose-first Unraid setup, appdata paths, PUID/PGID, and the performance overlay. |
| Demo mode | Disposable synthetic media libraries, demo credentials, reset endpoints, and demo caveats. |
| FAQ | Short answers for platform support, HDR, MPV hand-off, SQLx errors, logging, demo mode, and UI tests. |
Recovery-first rule
Section titled “Recovery-first rule”Any operator-facing change should document how to retry, reset, or recover without deleting more data than intended. Android and Android TV recovery guidance in the QA reference is especially strict: data-wipe-class problems should be treated as release blockers until a no-wipe exit exists.