2.2 KiB
2.2 KiB
Administrator-Handbuch – [PROJEKT_NAME]
Zielgruppe: Administratoren – Menschen, die das System betreiben, deployen und konfigurieren. Voraussetzung: Grundkenntnisse in Linux, Docker und dem eingesetzten Stack.
Systemvoraussetzungen
| Komponente | Mindestanforderung | Empfohlen |
|---|---|---|
| OS | … | … |
| RAM | … | … |
| Disk | … | … |
| Dependencies | … | … |
Deployment
Für Repos mit einem Namen beginnend mit rd13_ gilt als Standard-Topologie:
- Der Runner muss in Docker laufen.
- Alle Services werden über Caddy als Reverse Proxy ausgeliefert.
- Die Proxy-Schicht wird zentral im Repo
rd13_system_proxygepflegt.
Erstes Aufsetzen
# Beispiel
git clone <repo> /opt/service
cd /opt/service
cp .env.example .env
# .env ausfüllen!
docker compose up -d
Updates einspielen
git pull
docker compose pull
docker compose up -d --force-recreate
Konfiguration
Umgebungsvariablen (.env)
| Variable | Pflicht | Default | Beschreibung |
|---|---|---|---|
EXAMPLE_VAR |
✓ | – | Beschreibung |
Persistente Daten (/data/)
Alle persistenten Daten liegen unter /data/<service>/ im Repo-Root:
| Pfad | Inhalt | Backup-Priorität |
|---|---|---|
data/<service>/ |
… | hoch/mittel/niedrig |
Backup-Hinweise:
/data/komplett sichern vor jedem Update- Empfehlung: tägliches Backup via Cron / Restic / rsync
Monitoring & Logs
# Logs ansehen
docker compose logs -f <service>
# Status prüfen
docker compose ps
Sicherheit
- Offene Ports: …
- TLS: …
- Zugriffskontrolle: …
Troubleshooting
| Symptom | Ursache | Lösung |
|---|---|---|
| … | … | … |
Disaster Recovery
- Dienst stoppen:
docker compose down - Backup einspielen: …
- Dienst neu starten:
docker compose up -d