70 lines
3.1 KiB
Markdown
70 lines
3.1 KiB
Markdown
# Documentation Index
|
|
|
|
Stand: 2026-05-31
|
|
|
|
Diese Datei trennt aktive Betriebsdokumentation von historischen Snapshots. 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 gehen nach `docs/archive/YYYY-MM/`.
|
|
|
|
## 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 |
|
|
| `RESTORE_HANDBOOK.md` | praktische Restore-Anleitung |
|
|
| `RESTORE_DRILL_ROUTINE.md` | regelmaessige Restore-Drills |
|
|
| `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 |
|
|
| `HARDWARE_INVENTORY.md` | Host-, Disk-, SMART-, USV- und Power-Baseline |
|
|
| `NETWORK_INVENTORY.md` | Router, DNS, Tailscale, Portfreigaben und Netzthemen |
|
|
| `EXTERNAL_DEPENDENCIES.md` | Provider, Konten und externe Abhaengigkeiten |
|
|
| `CAPACITY_AND_LIFECYCLE.md` | Kapazitaet, Wachstum und Upgrade-Trigger |
|
|
|
|
## Monitoring und Automatisierung
|
|
|
|
| Datei | Zweck |
|
|
|---|---|
|
|
| `ALERT_RULES.md` | Prometheus-/ntfy-Regeln und Handlungslogik |
|
|
| `ALERTING_MAP.md` | ntfy Topics und Sender-Konvention |
|
|
| `RENOVATE.md` | Self-hosted Renovate gegen Gitea |
|
|
| `HOME_ASSISTANT_INFLUXDB_ECOWITT.md` | Home Assistant -> InfluxDB 3 -> Grafana |
|
|
| `H_DRIVE_NEARLINE_PULL.md` | Windows-H:/ Nearline-Pull fuer kritische Restore-Artefakte |
|
|
| `IMMICH_RESTORE_TEST.md` | Immich-Restore-Test-Overview |
|
|
|
|
## Nutzer- und Planungsdoku
|
|
|
|
| Datei | Zweck |
|
|
|---|---|
|
|
| `FAMILY_ONBOARDING.md` | familienverstaendliche Nutzungsdoku |
|
|
| `FAMILY_VIEW_DASHBOARD.md` | Spezifikation fuer das Family-View-Dashboard |
|
|
| `OFFSITE_BACKUP_OPTIONS.md` | dokumentierte Offsite-Entscheidung und Review-Trigger |
|
|
| `AUDIT_2026-05-25_TODO.md` | verbleibende/parkende Aufgaben aus dem Audit-Zyklus |
|
|
| `POST_MIGRATION_BURN_IN_2026-05-31.md` | aktueller Burn-in-Nachlauf nach den Stateful-Migrationen |
|
|
| `AI_CONTEXT.md` | kompakter Kontext fuer KI-Agenten |
|
|
| `MIGRATION_LOG.md` | historischer Verlauf; kein Primaer-Runbook |
|
|
|
|
## Archiv
|
|
|
|
| Pfad | Inhalt |
|
|
|---|---|
|
|
| `archive/2026-05/` | alte Audits, Chat-Handoffs, Codex-Prompts und erledigte Aktionsplaene aus Mai 2026 |
|
|
|
|
Windows-Neuaufsetzen-Dokumente liegen nicht mehr in `docs/`, sondern im fachlich passenden Ordner `../ops/windows-reinstall/docs/`.
|