docs: document Makefile usage
This commit is contained in:
@ -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`
|
||||
|
||||
Reference in New Issue
Block a user