docs: document Makefile usage
This commit is contained in:
@ -62,6 +62,7 @@ By: Codex (GPT-5)
|
||||
| 15.01.2026 | 📝 Req | ID: US_000041 Einbindungsschritte fuer Update- und OIDC-Service dokumentiert. By: Codex (GPT-5) |
|
||||
| 15.01.2026 | 🏗️ Planning | ID: US_000042/TASK_000046-TASK_000048 Consumer-Doku und Audience-Split ergaenzen. By: Codex (GPT-5) |
|
||||
| 15.01.2026 | 📝 Req | ID: US_000042 Consumer-Doku, Audience-Split, External Dependencies und Power-User-Ergaenzungen umgesetzt. By: Codex (GPT-5) |
|
||||
| 15.01.2026 | 📝 Req | ID: Makefile als bevorzugter Einstieg in Doku ergaenzt. By: Codex (GPT-5) |
|
||||
|
||||
---
|
||||
## Legende
|
||||
|
||||
@ -34,7 +34,7 @@ sudo git clone ssh://git@git.wlkns.org:2222/stephan/kiddo /opt/sk
|
||||
cd /opt/sk
|
||||
|
||||
# 2) Installieren (legt User, env und Systemd-Unit an)
|
||||
./scripts/install.sh
|
||||
make install
|
||||
|
||||
# 3) Status pruefen
|
||||
sudo systemctl status skd.service
|
||||
|
||||
@ -13,7 +13,7 @@ By: Codex (GPT-5)
|
||||
|
||||
Beispiel:
|
||||
```bash
|
||||
sudo ./scripts/install.sh
|
||||
make install
|
||||
sudo systemctl status skd.service
|
||||
```
|
||||
|
||||
@ -22,6 +22,15 @@ sudo systemctl status skd.service
|
||||
./scripts/run.sh
|
||||
```
|
||||
|
||||
## Makefile Targets (Ops)
|
||||
```bash
|
||||
make install
|
||||
make up
|
||||
make down
|
||||
make update
|
||||
make uninstall
|
||||
```
|
||||
|
||||
## Remote-Deploy (SSH)
|
||||
`./scripts/deploy.sh` packt das Repo und deployt es auf einen Zielhost.
|
||||
Konfiguration in `deploy_hosts.yml`.
|
||||
|
||||
@ -21,7 +21,7 @@ sudo git clone ssh://git@git.wlkns.org:2222/stephan/kiddo /opt/sk
|
||||
cd /opt/sk
|
||||
|
||||
# 2) Installation (legt Service-User, env, systemd-Unit an)
|
||||
./scripts/install.sh
|
||||
make install
|
||||
|
||||
# 3) Service pruefen
|
||||
sudo systemctl status skd.service
|
||||
@ -42,6 +42,15 @@ curl -s -H "Authorization: Bearer $token" http://localhost/me
|
||||
```
|
||||
Hinweis: `jq` ist optional; ohne jq das Token manuell aus der JSON-Antwort lesen.
|
||||
|
||||
## Makefile-Kurzbefehle
|
||||
```bash
|
||||
make install # Installation (systemd, env, venv)
|
||||
make up # Service starten
|
||||
make down # Service stoppen
|
||||
make update # Code-Update (git reset --hard origin/main)
|
||||
make healthcheck TOKEN=... # Healthcheck mit Bearer-Token
|
||||
```
|
||||
|
||||
## Naechste Schritte
|
||||
- Konfiguration anpassen: `docs/CONFIGURATION.md`
|
||||
- API und Web-UI nutzen: `docs/USAGE.md`
|
||||
|
||||
@ -75,6 +75,11 @@ curl -X POST -H "Authorization: Bearer $token" http://localhost/update/check
|
||||
```
|
||||
Hinweis: Ohne gespeichertes Update-Token liefert der Check einen Fehler.
|
||||
|
||||
## Healthcheck per Makefile
|
||||
```bash
|
||||
make healthcheck TOKEN="$token"
|
||||
```
|
||||
|
||||
## Weitere Dokumente
|
||||
- Konfiguration: `docs/CONFIGURATION.md`
|
||||
- Deployment: `docs/DEPLOYMENT.md`
|
||||
|
||||
@ -21,6 +21,7 @@ Sicheres, remote steuerbares System zum Sperren/Entsperren lokaler Nutzerkonten.
|
||||
| 15.01.2026 | 📝 Req | Doku und ENV-Beispiele an Code-Stand angepasst. |
|
||||
| 15.01.2026 | 📝 Req | Doku-Overhaul mit neuer Struktur und Archivierung. |
|
||||
| 15.01.2026 | 📝 Req | Externe Service-Links in der Doku ergaenzt. |
|
||||
| 15.01.2026 | 📝 Req | Makefile als Einstieg in Doku aufgenommen. |
|
||||
|
||||
## Epic-Backlog (Uebersicht)
|
||||
### EPIC_000001: Legacy CLI Account Control (sk.sh)
|
||||
|
||||
Reference in New Issue
Block a user