docs: add consumer audience split and external deps
This commit is contained in:
40
README.md
40
README.md
@ -6,10 +6,16 @@ By: Codex (GPT-5)
|
||||
## Kurzbeschreibung
|
||||
Safe Kiddo Daemon ist ein lokaler Systemdienst, der Benutzerkonten auf Linux-Systemen sperrt/entsperrt, Sitzungen beendet und optional einen Shutdown ausloest. Der Dienst bietet eine REST-API und eine Web-UI fuer die Fernsteuerung. Ein Legacy-CLI-Script (`sk.sh`) bleibt als Fallback erhalten.
|
||||
|
||||
## Zielgruppe
|
||||
- Einsteiger: moechten den Dienst schnell installieren und erste Aktionen ausfuehren.
|
||||
- Admins/Operatoren: konfigurieren Auth, OIDC und Update-Mechanik.
|
||||
- Entwickler: verstehen Architektur, Module und Erweiterungspunkte.
|
||||
## Fuer wen ist das Projekt?
|
||||
1. Endnutzer (Consumers): Nutzen die Web-Oberflaeche ohne technische Details.
|
||||
2. Technische Einsteiger: Installieren und starten den Dienst.
|
||||
3. Power-User: Konfigurieren, automatisieren und betreiben den Dienst.
|
||||
4. Entwickler/Professionals: Verstehen Architektur, Interna und Erweiterungspunkte.
|
||||
|
||||
## Was es NICHT ist
|
||||
- Kein Cloud-Service und keine zentrale Benutzerverwaltung.
|
||||
- Kein Ersatz fuer Mobile-Device-Management (MDM).
|
||||
- Kein plattformuebergreifendes Kontrollen-System; Fokus ist Linux und lokale Accounts.
|
||||
|
||||
## Hauptfunktionen
|
||||
- Sperren/Entsperren lokaler Nutzerkonten inkl. Session-Management und optionalem Shutdown.
|
||||
@ -19,9 +25,6 @@ Safe Kiddo Daemon ist ein lokaler Systemdienst, der Benutzerkonten auf Linux-Sys
|
||||
- Update-Client-Integration (Enrollment, Manifest, Apply, Rollback, Logs).
|
||||
- Dry-Run-Modus zum sicheren Testen.
|
||||
|
||||
## Badges
|
||||
Derzeit keine offiziellen Badges, da im Repository keine CI, Coverage, Release oder Docker-Pipeline definiert ist.
|
||||
|
||||
## Quickstart (5 Minuten)
|
||||
```bash
|
||||
# 1) Repo holen
|
||||
@ -43,15 +46,20 @@ curl -s -X POST -H "Content-Type: application/json" \
|
||||
```
|
||||
Danach die Web-UI unter `http://localhost/` oeffnen und anmelden.
|
||||
|
||||
## Dokumentation
|
||||
- Einstieg und erster Lauf: `docs/GETTING_STARTED.md`
|
||||
- Nutzung (API, Web-UI, CLI): `docs/USAGE.md`
|
||||
- Konfiguration (ENV-Variablen): `docs/CONFIGURATION.md`
|
||||
- Architektur und Module: `docs/ARCHITECTURE.md`
|
||||
- Entwicklung: `docs/DEVELOPMENT.md`
|
||||
- Deployment & Betrieb: `docs/DEPLOYMENT.md`
|
||||
- FAQ: `docs/FAQ.md`
|
||||
- Troubleshooting: `docs/TROUBLESHOOTING.md`
|
||||
## Dokumentation nach Zielgruppe
|
||||
- Endnutzer (Consumers): `docs/FOR_USERS.md`
|
||||
- Technische Einsteiger: `docs/GETTING_STARTED.md`
|
||||
- Power-User: `docs/USAGE.md` und `docs/CONFIGURATION.md`
|
||||
- Entwickler/Professionals: `docs/ARCHITECTURE.md`, `docs/DEVELOPMENT.md`, `docs/DEPLOYMENT.md`
|
||||
- Gemeinsame Referenz: `docs/FAQ.md`, `docs/TROUBLESHOOTING.md`
|
||||
|
||||
## Externe Services
|
||||
- Update-Service (intern): https://git.wlkns.org/stephan/update-webservice
|
||||
- OIDC-Service (intern): https://git.wlkns.org/stephan/oicd
|
||||
Einbindung und Konfiguration: `docs/DEPLOYMENT.md` und `docs/CONFIGURATION.md`.
|
||||
|
||||
## Badges
|
||||
Derzeit keine offiziellen Badges, da im Repository keine CI, Coverage, Release oder Docker-Pipeline definiert ist.
|
||||
|
||||
## Hinweise
|
||||
- Abweichung von der Zielstruktur: Die OpenAPI-Spezifikation des Update-Services bleibt unter `docs/architecture/openapi.yaml` und `docs/architecture/openapi/` erhalten.
|
||||
|
||||
Reference in New Issue
Block a user