docs: add project management structure

This commit is contained in:
2025-12-28 09:16:22 +01:00
parent 3991362e67
commit 4eb20e2449
50 changed files with 1905 additions and 0 deletions

View File

@ -0,0 +1,38 @@
ID: EPIC_000001 | Version: 0.1.0 | Status: Final
By: Codex (GPT-5)
# EPIC_000001: Legacy CLI Account Control (sk.sh)
## Beschreibung
Der Legacy-CLI-Workflow ermoeglicht das Sperren und Entsperren lokaler Nutzerkonten per Bash-Skript.
## Ziel / Business Value
Schnelle, direkte Steuerung ohne Web-Service als Notfall- oder SSH-Fallback.
## Mission Statement
Stelle eine robuste, direkte Konto-Steuerung fuer Admins bereit, wenn der Service nicht verfuegbar ist.
## Business Value & Metriken
- Weniger Support-Aufwand durch schnelle lokale Eingriffe.
- Erfolgsmetrik: Konto-Disable/Enable laesst sich per CLI ohne Zusatztools ausfuehren.
## In-Scope
- Sperren/Entsperren von Nutzerkonten.
- Optionaler Countdown, Benachrichtigungen und Sound.
- Shutdown nur bei aktivem Login.
## Out-of-Scope
- Web-UI oder API-Integration.
- Persistente Protokollierung im Backend.
## High-Level Akzeptanzkriterien
- Admin kann einen Nutzer per CLI deaktivieren oder aktivieren.
- Countdown/Benachrichtigung/Shutdown verhalten sich wie dokumentiert.
## Technische Constraints & Risiken
- Root-Rechte erforderlich.
- Abhaengigkeit von notify-send und Sound-Tools.
## Zugeordnete User Stories (Done)
- US_000001: Nutzerkonto deaktivieren mit Countdown
- US_000002: Nutzerkonto wieder aktivieren

View File

@ -0,0 +1,41 @@
ID: EPIC_000002 | Version: 0.1.0 | Status: Final
By: Codex (GPT-5)
# EPIC_000002: Backend API Service
## Beschreibung
Der Backend-Service bietet REST-Endpunkte fuer Health-Checks und Nutzeraktionen zum Sperren/Entsperren.
## Ziel / Business Value
Remote-Steuerung von Nutzerkonten mit klaren API-Antworten fuer Automatisierung.
## Mission Statement
Biete eine sichere, zentrale API zur Verwaltung lokaler Nutzerkonten.
## Business Value & Metriken
- Remote-Verwaltung ohne direkten SSH-Zugriff.
- Erfolgsmetrik: API liefert konsistente Status- und Action-Responses.
## In-Scope
- Health-Endpoint.
- Auflistung verwaltbarer Nutzer.
- Disable/Enable-Endpoints mit Rueckgabe der Schritte.
## Out-of-Scope
- Frontend-Design-Iteration.
- Persistente Datenbank.
## High-Level Akzeptanzkriterien
- Endpunkte sind erreichbar und liefern erwartete Payloads.
- Actions melden Aktion, Schritte und Login-Status.
## Technische Constraints & Risiken
- Abhaengigkeit von lokalen System-Befehlen fuer Aktionen.
- Fehler muessen als HTTP-Fehler sauber abgebildet werden.
## Zugeordnete User Stories (Done)
- US_000003: Health-Status abfragen
- US_000004: Verfuegbare Nutzer auflisten
- US_000005: Nutzer per API deaktivieren
- US_000006: Nutzer per API aktivieren
- US_000021: Konfiguration per ENV steuern

View File

@ -0,0 +1,40 @@
ID: EPIC_000003 | Version: 0.1.0 | Status: Final
By: Codex (GPT-5)
# EPIC_000003: Authentication & Sessions
## Beschreibung
Authentifizierung und Autorisierung fuer Admins via PAM oder OIDC inkl. Session-Handling.
## Ziel / Business Value
Sichere Zugriffskontrolle auf API und UI mit klarer Admin-Identitaet.
## Mission Statement
Stelle einen sicheren Admin-Login bereit, der Token oder Session-Cookies ausstellt.
## Business Value & Metriken
- Reduzierung unautorisierter Zugriffe.
- Erfolgsmetrik: Nur autorisierte Admins koennen Nutzeraktionen ausfuehren.
## In-Scope
- PAM-Login mit Token-Ausgabe.
- OIDC-Login Flow mit State-Validierung.
- Autorisierungs-Guards und /me-Endpoint.
## Out-of-Scope
- Multi-Faktor-Authentifizierung.
- Externe Session Stores.
## High-Level Akzeptanzkriterien
- PAM-Login liefert Token und setzt Session-Cookie.
- OIDC-Flow validiert State und setzt Session-Cookie.
- Nicht autorisierte Nutzer werden blockiert.
## Technische Constraints & Risiken
- Abhaengigkeit von PAM und OIDC-Provider-Verfuegbarkeit.
- Cookie-Sicherheit muss korrekt konfiguriert sein.
## Zugeordnete User Stories (Done)
- US_000007: PAM-Login mit Token
- US_000008: OIDC-Login Flow
- US_000009: Autorisierung und /me-Identitaet

View File

@ -0,0 +1,35 @@
ID: EPIC_000004 | Version: 0.1.0 | Status: Final
By: Codex (GPT-5)
# EPIC_000004: Web UI
## Beschreibung
Eine schlanke Web-Oberflaeche wird als HTML-Template vom Backend ausgeliefert.
## Ziel / Business Value
Remote-Bedienung ueber den Browser ohne separate Client-Installation.
## Mission Statement
Biete eine einfache UI fuer Admins zum Login und zur Nutzersteuerung.
## Business Value & Metriken
- Schnellere Bedienung fuer Nicht-CLI-Nutzer.
- Erfolgsmetrik: UI ist unter / erreichbar.
## In-Scope
- Auslieferung der Index-Seite.
- Einbindung der Login-Optionen im Template.
## Out-of-Scope
- Design-Overhaul oder umfassende Frontend-Architektur.
## High-Level Akzeptanzkriterien
- GET / liefert eine HTML-Seite aus dem Template-Verzeichnis.
## Technische Constraints & Risiken
- Template-Abhaengigkeit von korrekter Backend-Konfiguration.
## Zugeordnete User Stories (Done)
- US_000010: Index-Seite ausliefern
- US_000022: Web-UI Aktionen ausfuehren
- US_000024: Watchtower Theme fuer Web-UI

View File

@ -0,0 +1,43 @@
ID: EPIC_000005 | Version: 0.1.0 | Status: Final
By: Codex (GPT-5)
# EPIC_000005: Automation Scripts
## Beschreibung
Bash-Skripte automatisieren Installation, Start, Update und Deployment des Services.
## Ziel / Business Value
Schnelle und reproduzierbare Betriebsablaeufe auf Zielsystemen.
## Mission Statement
Minimiere manuelle Admin-Schritte durch standardisierte Skripte.
## Business Value & Metriken
- Zeitersparnis bei Setup und Updates.
- Erfolgsmetrik: Install/Update/Deploy laufen ohne manuelle Nacharbeit.
## In-Scope
- Virtualenv-Erstellung und Abhaengigkeiten.
- Service-Start und Installation.
- Update- und Deployment-Workflows.
- OIDC-Client-Registrierungshilfe.
## Out-of-Scope
- CI/CD-Pipelines.
- Monitoring oder Alerting.
## High-Level Akzeptanzkriterien
- Skripte decken lokale und remote Setups ab.
- Fehler brechen mit klarer Ausgabe ab.
## Technische Constraints & Risiken
- Abhaengigkeit von sudo, rsync, ssh, python3.
## Zugeordnete User Stories (Done)
- US_000011: Virtualenv und Abhaengigkeiten erstellen
- US_000012: Service lokal starten
- US_000013: Service installieren
- US_000014: Service aktualisieren
- US_000015: Remote-Deployment durchfuehren
- US_000016: OIDC-Client registrieren
- US_000020: Makefile-Automation bereitstellen

View File

@ -0,0 +1,37 @@
ID: EPIC_000006 | Version: 0.1.0 | Status: Final
By: Codex (GPT-5)
# EPIC_000006: Systemd & Deployment Artifacts
## Beschreibung
Service-Unit und Konfigurationsvorlagen stellen den Betrieb und die manuelle Verteilung sicher.
## Ziel / Business Value
Konsistente Service-Konfiguration und einfache Bereitstellungsvorlagen.
## Mission Statement
Stelle Service-Unit und Konfigurations-Templates fuer reproduzierbare Deployments bereit.
## Business Value & Metriken
- Reduzierte Fehlkonfigurationen durch Standardvorlagen.
- Erfolgsmetrik: Service startet mit Unit-Datei und Env-Template.
## In-Scope
- Systemd-Unit-Datei im Repo.
- Konfigurationsvorlagen fuer env und Deploy-Hosts.
- Manuelle Deployment-Archive.
## Out-of-Scope
- Automatisierte Release-Pipelines.
## High-Level Akzeptanzkriterien
- Unit- und Template-Dateien sind im Repo vorhanden.
- Deployment-Archiv steht fuer manuelle Nutzung bereit.
## Technische Constraints & Risiken
- Pfadannahmen muessen zum Zielsystem passen.
## Zugeordnete User Stories (Done)
- US_000017: Systemd-Unit im Repo
- US_000018: Konfigurations-Templates verfuegbar
- US_000019: Deployment-Archiv vorhanden

View File

@ -0,0 +1,32 @@
ID: EPIC_000007 | Version: 0.1.0 | Status: Final
By: Codex (GPT-5)
# EPIC_000007: Documentation & Runbook
## Beschreibung
Projekt-Dokumentation beschreibt Setup, Betrieb und Sicherheitsrichtlinien fuer Admins.
## Ziel / Business Value
Schnelleres Onboarding und sichere Bedienung durch klare Runbooks.
## Mission Statement
Stelle eine verlaessliche Betriebs- und Sicherheitsdokumentation bereit.
## Business Value & Metriken
- Reduzierter Support durch klare Anleitungen.
- Erfolgsmetrik: Operatoren koennen Installation und Betrieb aus der Doku nachvollziehen.
## In-Scope
- README mit Setup, Running, Updates und Security-Hinweisen.
## Out-of-Scope
- Externe Wiki- oder Ticket-Systeme.
## High-Level Akzeptanzkriterien
- README beschreibt Setup, Betrieb und Security Hardening.
## Technische Constraints & Risiken
- Dokumentation muss mit dem aktuellen Verhalten uebereinstimmen.
## Zugeordnete User Stories (Done)
- US_000023: Runbook und Security-Hinweise dokumentieren