Micha
1fcdb68221
- merge RESTORE_HANDBOOK.md into ops/restore-tests/README.md (single operations doc; restore status lives only in RESTORE_MATRIX maturity table) - RESTORE_MATRIX.md: extract embedded runbook drafts (261 -> 141 lines); unraid-flash and tailscale stubs become ops/restore-tests runbooks, adguard/redis checklists superseded by validated scripts - delete six historical pre-first-run *-plan.md files (runbook + script are the source of truth since the validated first runs) - SERVICES_RECOVERY: drop completed task table; DISASTER_RECOVERY: point related docs and section 11 to MASTER_TODO/schedule Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
58 lines
2.6 KiB
Markdown
58 lines
2.6 KiB
Markdown
# Documentation Index
|
|
|
|
Stand: 2026-06-05
|
|
|
|
Diese Datei trennt aktive Betriebsdokumentation von historischer Arbeitsdoku. Neue operative Dokumente duerfen nur in `docs/` liegen, wenn sie heute als Einstieg, Runbook, Inventar oder offene Arbeitsliste gebraucht werden. Erledigte Audits, Chat-Handoffs, Prompt-Dateien und abgeschlossene Plaene bleiben in der Git-Historie, aber nicht als dauerhafte Arbeitskopie.
|
|
|
|
## Pflicht-Einstieg
|
|
|
|
| Datei | Zweck |
|
|
|---|---|
|
|
| `../README.md` | kurzer Repo-Einstieg |
|
|
| `../HOMELAB_ARCHITECTURE_MASTER_V2.md` | Architektur-Quelle fuer Netz, Zugriff und Ausnahmen |
|
|
| `WORKFLOW.md` | verbindlicher GitOps-/No-Drift-Ablauf |
|
|
| `REPO_MAP.md` | technische Landkarte des Repositories |
|
|
| `SERVICE_CATALOG.md` | produktiver Service-Katalog |
|
|
|
|
## Betrieb und Recovery
|
|
|
|
| Datei | Zweck |
|
|
|---|---|
|
|
| `DISASTER_RECOVERY.md` | Wiederanlauf nach Host-/Systemausfall |
|
|
| `RESTORE_MATRIX.md` | Restore-Quellen, Dumps, Secrets und Smoke-Tests je Dienst |
|
|
| `SERVICES_RECOVERY.md` | Gitea-/Komodo-/Services-Bootstrap |
|
|
| `ROLLBACK.md` | Rueckweg bei GitOps-/Deploy-Fehlern |
|
|
| `GITOPS_DRIFT_RUNBOOK.md` | Pflichtmatrix bei Drift zwischen Git, Komodo, Docker und Host |
|
|
|
|
## Inventare und Policies
|
|
|
|
| Datei | Zweck |
|
|
|---|---|
|
|
| `STORAGE_LAYOUT.md` | verbindliche Storage-/Share-/Pfad-Regeln |
|
|
| `SECRETS_MAP.md` | Secret-Namen, Speicherorte und Einbindungsarten ohne Werte |
|
|
| `AUTHELIA_OIDC_PLAN.md` | Plan & Runbook fuer app-uebergreifendes SSO via Authelia OIDC |
|
|
| `HARDWARE_INVENTORY.md` | Host-, Disk-, SMART-, USV- und Power-Baseline |
|
|
| `NETWORK_INVENTORY.md` | Router, DNS, Tailscale, Portfreigaben und Netzthemen |
|
|
| `GUEST_IOT_NETWORK.md` | Sicherer Ablauf fuer FRITZ!Box-Gastnetz / IoT-Isolation |
|
|
| `EXTERNAL_DEPENDENCIES.md` | Provider, Konten und externe Abhaengigkeiten |
|
|
| `EXTERNAL_OPERATOR_RUNBOOK.md` | Hetzner-/Borg-/FRITZ!Box-Betreibercheck |
|
|
| `CAPACITY_AND_LIFECYCLE.md` | Kapazitaet, Wachstum und Upgrade-Trigger |
|
|
|
|
## Monitoring und Automatisierung
|
|
|
|
| Datei | Zweck |
|
|
|---|---|
|
|
| `ALERT_RULES.md` | Prometheus-/ntfy-Regeln und Handlungslogik |
|
|
| `RENOVATE.md` | Self-hosted Renovate gegen Gitea |
|
|
| `H_DRIVE_NEARLINE_PULL.md` | Windows-H:/ Nearline-Pull fuer kritische Restore-Artefakte |
|
|
|
|
## Nutzer- und Planungsdoku
|
|
|
|
| Datei | Zweck |
|
|
|---|---|
|
|
| `FAMILY_ONBOARDING.md` | familienverstaendliche Nutzungsdoku |
|
|
| `MASTER_TODO.md` | zentrale operative Master-To-do-Liste ueber alle Bereiche |
|
|
| `AI_CONTEXT.md` | kompakter Kontext fuer KI-Agenten |
|
|
|
|
Windows-Neuaufsetzen-Dokumente liegen nicht mehr in `docs/`, sondern im fachlich passenden Ordner `../ops/windows-reinstall/docs/`.
|