docs: overhaul repository documentation
This commit is contained in:
48
docs/GETTING_STARTED.md
Normal file
48
docs/GETTING_STARTED.md
Normal file
@ -0,0 +1,48 @@
|
||||
ID: DOC_000009 | Version: 0.2.1 | Status: Draft
|
||||
By: Codex (GPT-5)
|
||||
|
||||
# Getting Started
|
||||
|
||||
## Ziel
|
||||
Schneller Einstieg fuer neue Nutzer: Installation, erster Login und erste Aktion.
|
||||
|
||||
## Voraussetzungen
|
||||
- Linux-System mit systemd.
|
||||
- Root-Zugriff (PAM, usermod, shutdown).
|
||||
- Python 3, curl, tar, sha256sum (fuer Update-Client-Skripte).
|
||||
- Optional: notify-send (Benachrichtigungen), paplay/aplay (Sound).
|
||||
|
||||
## Schnellstart
|
||||
```bash
|
||||
# 1) Repo installieren
|
||||
sudo mkdir -p /opt/sk
|
||||
sudo git clone ssh://git@git.wlkns.org:2222/stephan/kiddo /opt/sk
|
||||
# Hinweis: verwende hier die Repo-URL deiner Instanz
|
||||
cd /opt/sk
|
||||
|
||||
# 2) Installation (legt Service-User, env, systemd-Unit an)
|
||||
./scripts/install.sh
|
||||
|
||||
# 3) Service pruefen
|
||||
sudo systemctl status skd.service
|
||||
|
||||
# 4) Login (PAM)
|
||||
curl -s -X POST -H "Content-Type: application/json" \
|
||||
-d '{"username":"root","password":"..."}' \
|
||||
http://localhost/login
|
||||
```
|
||||
|
||||
## Erster API-Test
|
||||
```bash
|
||||
token=$(curl -s -X POST -H "Content-Type: application/json" \
|
||||
-d '{"username":"root","password":"example-password"}' \
|
||||
http://localhost/login | jq -r .token)
|
||||
|
||||
curl -s -H "Authorization: Bearer $token" http://localhost/me
|
||||
```
|
||||
Hinweis: `jq` ist optional; ohne jq das Token manuell aus der JSON-Antwort lesen.
|
||||
|
||||
## Naechste Schritte
|
||||
- Konfiguration anpassen: `docs/CONFIGURATION.md`
|
||||
- API und Web-UI nutzen: `docs/USAGE.md`
|
||||
- Deployment und Updates: `docs/DEPLOYMENT.md`
|
||||
Reference in New Issue
Block a user