Zum Inhalt

Aktualisierungsplan Dokumentation

Ziel

Die neue Dokumentation soll den aktuellen Systemzustand nach Entfernung von Authentik und nach Bereinigung der Sicherheitsbefunde vollständig abbilden.

Aufgaben

DOC-001: Konzeptseiten ausarbeiten

Ziel: Serverstruktur, Subdomain Registry, Docker-Stack-Konventionen sowie Secrets und Backups als eigenständige Konzeptseiten dokumentieren.

Betroffene Dateien:

  • docs/konzepte/serverstruktur.md
  • docs/konzepte/subdomain-registry.md
  • docs/konzepte/docker-stacks.md
  • docs/konzepte/secrets-und-backups.md

DOC-002: Agenten dokumentieren

Ziel: Hermes und OpenClaw als Infrastruktur-Agenten dokumentieren.

Betroffene Dateien:

  • docs/agents/hermes.md
  • docs/agents/openclaw.md

DOC-003: Mail-Dienste dokumentieren

Ziel: Stalwart und Bulwark vollständig dokumentieren, inklusive Mail-Sonderrouten in Caddy.

Betroffene Dateien:

  • docs/dienste/mail/stalwart.md
  • docs/dienste/mail/bulwark.md

DOC-004: KI-Dienste dokumentieren

Ziel: Open WebUI, LiteLLM und Langfuse vollständig dokumentieren. Langfuse-Abhängigkeiten PostgreSQL, Redis, ClickHouse und MinIO gehören auf die Langfuse-Seite.

Betroffene Dateien:

  • docs/dienste/ki/openwebui.md
  • docs/dienste/ki/litellm.md
  • docs/dienste/ki/langfuse.md

DOC-005: Infrastruktur-Dienste dokumentieren

Ziel: CaddyManager, Homepage, Portainer, Dozzle, Uptime Kuma, File Browser und Cockpit dokumentieren.

Betroffene Dateien:

  • docs/dienste/infrastruktur/*.md

DOC-006: Authentifizierungsübersicht nach Authentik erstellen

Ziel: Dokumentieren, welcher Dienst welche eigene Authentifizierung verwendet und welche Dienste nur per Tailnet geschützt sind.

Betroffene Bereiche:

  • docs/index.md
  • passende Dienstseiten
  • ggf. neue Konzeptseite im Bereich Sicherheit/Auth

DOC-007: MkDocs-Build validieren

Ziel: Sicherstellen, dass die neue Struktur mit MkDocs gebaut werden kann und die Navigation funktioniert.

Betroffene Dateien:

  • mkdocs.yml
  • alle neuen Markdown-Dateien