@@ -1,4 +1,4 @@
# GerbilManager — Betriebsanleitung (TrueNAS SCALE Goldeye )
# GerbilManager — Betriebsanleitung (TrueNAS)
> Zielgruppe: Julian (Systemadministration) und Ehefrau (tägliche Nutzung).
> Bookmark für die Ehefrau: **http://\<NAS-IP\>/** (z. B. http://truenas/)
@@ -9,12 +9,13 @@
1. [Übersicht & Architektur ](#1-übersicht--architektur )
2. [Voraussetzungen ](#2-voraussetzungen )
3. [Erstinstallation auf TrueNAS Goldeye ](#3-erstinstallation-auf-truenas-goldeye )
3. [Erstinstallation auf TrueNAS ](#3-erstinstallation-auf-truenas )
4. [App starten / stoppen / aktualisieren ](#4-app-starten--stoppen--aktualisieren )
5. [Backup & Wiederherstellung ](#5-backup--wiederherstellung )
6. [ZFS-Snapshot-Schichtung ](#6-zfs-snapshot-schichtung )
7. [CI/CD via Gitea Actions ](#7-cicd-via-gitea-actions )
8. [Fehlerbehebung ](#8-fehlerbehebung
8. [Offene Fragen (bitte beantworten) ](#8-offene-fragen
9. [Fehlerbehebung ](#9-fehlerbehebung )
---
@@ -22,7 +23,7 @@
```
| HTTP :80 (oder PORT aus .env, z.B. 8080)
| HTTP :80
v
┌──────────────────┐
│ frontend (nginx) │ statisches React-SPA + Reverse-Proxy
@@ -39,10 +40,9 @@ Browser / Handy
│ db (Postgres 17)│ │ backup (Sidecar) │
└──────────────────┘ │ pg_dump + tar + cron │
│ └──────────────────────┘
└─ pgdata-Volume → /mnt/JailStorage/DockerVolumes/gerbilmanager/pgdata
photos-Volume → /mnt/JailStorage/DockerVolumes/gerbilmanager/photos
backups-Volume → /mnt/JailStorage/DockerVolumes/gerbilmanager/backups
keys-Volume → /mnt/JailStorage/DockerVolumes/gerbilmanager/keys
└─ pgdata-Volume (NAS-Dataset)
photos-Volume (NAS-Dataset)
backups-Volume (NAS-Dataset)
```
**Einziger veröffentlichter Port: ** `80` (konfigurierbar via `PORT` in `.env` ).
@@ -54,107 +54,68 @@ Alles andere läuft intern im Docker-Netz.
| Was | Details |
|-----|---------|
| TrueNAS SCALE | **25.10.2.1 „Goldeye" **
| Container Registry | `git.rismer.de/gulum` (externes HTTPS) |
| Docker | bereits auf TrueNAS Goldeye vorhanden |
| Verzeichnisse | 4 Ordner unter `/mnt/JailStorage/DockerVolumes/gerbilmanager/` anlegen (Schritt 3.1 ) |
| TrueNAS SCALE | Electric Eel 24.10+ (native Docker Custom Apps) |
| Gitea | http://truenas:13000 — Repository `Gulum/GerbilManager` |
| Docker | bereits auf TrueNAS vorhanden (Custom Apps nutzen es) |
| Datasets | Drei ZFS-Datasets anlegen (siehe Schritt 3) |
---
## 3. Erstinstallation auf TrueNAS Goldeye
## 3. Erstinstallation auf TrueNAS
### 3.1 Verzeichnisse anlegen und Berechtigungen setz en
### 3.1 ZFS-Datasets anleg en
Öffne eine Shell auf der NAS (TrueNAS → System → Shell oder SSH ):
In TrueNAS → **Datasets ** → **Dataset hinzufügen ** (je einmal wiederholen ):
| Dataset-Name | Empfohlener Pfad | Verwendung |
|---|---|---|
| `gerbil/pgdata` | `/mnt/SSD/gerbil/pgdata` | Postgres-Datenbankdateien |
| `gerbil/photos` | `/mnt/SSD/gerbil/photos` | Hochgeladene Tierfotos |
| `gerbil/backups` | `/mnt/SSD/gerbil/backups` | Tägliche Backups |
> **Tipp:** Passe die Pool-Bezeichnung (`SSD`) an deinen tatsächlichen Pool an.
### 3.2 Repository klonen
``` bash
# Vier Ordner anlegen
mkdir -p /mnt/JailStorage/DockerVolumes/g erbilm anager/pgdata
mkdir -p /mnt/JailStorage/DockerVolumes/gerbilmanager/photos
mkdir -p /mnt/JailStorage/DockerVolumes/gerbilmanager/backups
mkdir -p /mnt/JailStorage/DockerVolumes/gerbilmanager/keys
# Postgres-Container läuft als UID 999 (postgres) / GID 999 intern.
# pgdata muss von UID 999 beschreibbar sein; postgres erzwingt chmod 0700.
chown -R 999:999 /mnt/JailStorage/DockerVolumes/gerbilmanager/pgdata
chmod 700 /mnt/JailStorage/DockerVolumes/gerbilmanager/pgdata
# photos, backups und keys werden von der API bzw. dem Sidecar beschrieben
# (laufen als root im Container) — keine weiteren ACL-Anpassungen nötig.
```
> **TrueNAS Dataset-ACL-Hinweis:** Falls `JailStorage` ein ZFS-Dataset mit NFSv4-ACLs ist,
> und `chown` meldet „Operation not permitted": setze in TrueNAS → Datasets →
> `JailStorage` → Berechtigungen → **ACL-Typ: POSIX** (oder nutze das UI-Formular
> „Eigentümer: 999, Gruppe: 999" für das `pgdata`-Unterverzeichnis).
### 3.2 Registry-Login auf der NAS
``` bash
# Benutzername und Token/Passwort eingeben (Gitea-Account oder Access Token mit read:packages)
```
Der Login wird unter `/root/.docker/config.json` gespeichert und bleibt nach Reboots erhalten.
### 3.3 Repository klonen
``` bash
# SSH in TrueNAS oder lokale Shell
git clone http://truenas:13000/Gulum/G erbilM anager.git /opt/gerbilmanager
cd /opt/gerbilmanager
```
### 3.4 Konfiguration anlegen
### 3.3 Konfiguration anlegen
``` bash
# Jetzt .env bearbeiten:
nano deploy/truenas/.env
```
Mindestens setzen:
- `POSTGRES_PASSWORD` — sicheres Passwort (mind. 20 Zeichen)
- `PGDATA_PATH` , `PHOTOS_PATH` , `BACKUPS_PATH` — tatsächliche Dataset-Pfade
| Variable | Wert |
|----------|------|
| `POSTGRES_PASSWORD` | Sicheres Passwort (mind. 20 Zeichen, keine `"` ) |
| `AI__BaseUrl` | Gemini: `https://generativelanguage.googleapis.com/v1beta/openai` |
| `AI__ApiKey` | Dein Gemini API-Key |
| `AI__Model` | `gemini-2.0-flash` (oder `gemini-flash-latest` ) |
| `PORT` | `80` — falls Port 80 auf der NAS bereits belegt ist: **auf `8080` ändern ** |
Die Pfad-Variablen (`PGDATA_PATH` , `PHOTOS_PATH` , etc.) sind bereits auf die Goldeye-Standardpfade
vorbelegt und müssen nur geändert werden, wenn du einen anderen Pool nutzt.
### 3.5 Images ziehen und App starten
### 3.4 Images bauen und App starten
``` bash
cd /opt/gerbilmanager
docker compose -f deploy/truenas/compose.yaml pull
docker compose -f deploy/truenas/compose.yaml build
docker compose -f deploy/truenas/compose.yaml up -d
```
Erster Start dauert ca. 2–
> **TrueNAS Goldeye Custom App (Alternative):**
> Statt der Shell kann die App auch über TrueNAS → Apps → „Custom App installieren" →
> „Install via YAML" deployt werden: compose-Inhalt einfügen, Volumes als Host-Pfade
> konfigurieren. Die Shell-Methode ist einfacher und gibt mehr Kontrolle.
### 3.6 Verifikation
### 3.5 Prüfen
``` bash
# Alle 4 Container laufen?
# Alle Container laufen?
docker compose -f deploy/truenas/compose.yaml ps
# API-Healthcheck (erwartet: {"status":"Healthy"})
curl -s http://localhost/api/health
# API-Healthcheck
curl http://localhost/api/health
# Tier-Gesamtanzahl prüfen (erwartet > 0 nach Import)
curl -s "http://localhost/api/gerbils?pageSize=1" | grep -o '"totalCount":[0-9]*'
# API-Doku (Scalar) im Browser
http://<NAS-IP>/scalar
# Foto-Upload: in der Webapp ein Tier öffnen → Foto hochladen → Foto erscheint
# Webapp im Browser
http://<NAS-IP>/
```
---
@@ -164,7 +125,6 @@ http://<NAS-IP>/scalar
### Starten
``` bash
cd /opt/gerbilmanager
```
@@ -174,17 +134,26 @@ docker compose -f deploy/truenas/compose.yaml up -d
```
### Aktualisieren (nach CI-P ush auf main)
### Aktualisieren (nach `git p ush` auf main)
``` bash
cd /opt/gerbilmanager
git pull
docker compose -f deploy/truenas/compose.yaml pull
docker compose -f deploy/truenas/compose.yaml build
docker compose -f deploy/truenas/compose.yaml up -d
```
> EF-Migrationen laufen automatisch beim API-Start — kein manueller Schritt nötig.
### Mit Gitea CI (wenn Actions aktiviert)
Push auf `main` triggert automatisch Build → Test → Image-Push.
Danach auf der NAS:
``` bash
docker compose -f deploy/truenas/compose.yaml up -d
```
---
## 5. Backup & Wiederherstellung
@@ -196,12 +165,12 @@ Der `backup`-Sidecar-Container läuft dauerhaft und sichert täglich um **03:00
- Komprimiertes Foto-Archiv als `.tar.gz`
- Rotation: Backups älter als `BACKUP_KEEP_DAYS` (Standard: 7) werden gelöscht
Backups liegen unter: `/mnt/JailStorage/DockerVolumes/gerbilmanager/backups /YYYY-MM-DD_HH-MM/`
Backups liegen unter: `${BACKUPS_PATH} /YYYY-MM-DD_HH-MM/`
```
JailStorage/DockerVolumes/gerbilmanager /backups/
SSD/gerbil /backups/
2026-06-06_03-00/
gerbilmanager_2026-06-06_03-00.sql (Datenbank-Dump, Klartext SQL )
gerbilmanager_2026-06-06_03-00.sql (Datenbank)
photos_2026-06-06_03-00.tar.gz (Fotos)
backup.log (Protokoll)
```
@@ -215,68 +184,52 @@ docker compose -f deploy/truenas/compose.yaml exec backup /bin/sh /scripts/backu
### Backup-Log prüfen
``` bash
JailStorage/DockerVolumes/gerbilmanager /backups/backup.log
SSD/gerbil /backups/backup.log
```
Backup-Validierung: Das Skript prüft ob der Dump `CREATE TABLE` enthält — fehlt dieser
Marker, erscheint eine WARNUNG im Log. Größe 0 KB bedeutet Fehlschlag.
### Wiederherstellung — Runbook
> **WARNUNG:** Alle aktuellen Datenbankdaten und Fotos werden überschrieben!
> **WARNUNG:** Alle aktuellen Daten werden überschrieben!
**Schritt 1: ** API und Frontend stoppen (DB und backup-Sidecar laufen weiter )
**Schritt 1: ** App stoppen (optional, aber empfohlen )
``` bash
```
**Schritt 2: ** Restore ausführen
``` bash
# Neuestes Backup automatisch wählen und bestätig en:
docker compose -f deploy/truenas/compose.yaml exec -T backup \
latest -f
# Neuestes Backup wiederherstell en:
docker compose -f deploy/truenas/compose.yaml exec backup \
# Bestimmtes Backup (Datum aus Verzeichnisname) :
docker compose -f deploy/truenas/compose.yaml exec -T backup \
6 _03-00 -f
# Bestimmtes Backup wiederherstellen :
docker compose -f deploy/truenas/compose.yaml exec backup \
5 _03-00
```
Das Skript:
1. Trennt alle offenen DB-Verbindungen
2. Spielt den SQL-Dump mit `psql -h db -U postgres -d gerbilmanager < dump.sql` ein
3. Entpackt das Foto-Archiv nach `/data/photos`
**Schritt 3: ** API neu starten
``` bash
```
**Schritt 4 — Verifikation (Pflicht nach erstem Restore-Drill) : **
**Schritt 4: ** Prüfen
``` bash
# Tier-Anzahl prüfen
curl -s "http://localhost/api/gerbils?pageSize=1" | grep -o '"totalCount":[0-9]*'
# ColorVariety-Anzahl (Stammdaten, erwartet: >= 60)
curl -s http://localhost/api/color-varieties | python3 -c "import sys,json; print(len(json.load(sys.stdin)))"
# Foto stichprobenartig prüfen
ls /mnt/JailStorage/DockerVolumes/gerbilmanager/photos/ | head -5
curl http://localhost/api/color-varieties | grep -c '"id"'
# Erwarteter Wert: 73
```
### Restore-Nachweis (Round-Trip-Test, lokal 2026-06-06 )
### Restore-Nachweis (Round-Trip-Test)
Protokoll vom getesteten Restore auf lokalem Aspire-Postgres:
Protokoll vom Test auf lokalem Aspire-Postgres (Vorgänger-Instanz, 2026-06-06 07:09) :
```
→ DELETE 12 Zeilen → 61 verbleibend
→ psql < dump.sql eingespielt
→ pg_restore eingespielt
→ 73 ColorVarieties bestätigt
Exit-Code: 0
```
**Erster TrueNAS-Restore-Drill : ** nach Erstinstallation bitte ausführen und Tier-Anzahl
notieren — beweist dass Backup + Restore auf dem NAS korrekt funktionieren.
Die Container-Restore-Skripte nutzen dieselbe `psql < dump.sql` Logik.
**Erster echter Test auf TrueNAS : ** nach Erstinstallation bitte ausführen und das Ergebnis notieren.
---
@@ -287,15 +240,15 @@ Sie schützen vor versehentlichem Datenverlust auf Dataset-Ebene.
### Empfohlene Snapshot-Konfiguration
In TrueNAS → **Datasets ** → `JailStorage/DockerVolumes/gerbilmanager` **Snapshots ** → **Regelmäßige Snapshots ** :
In TrueNAS → **Datasets ** → Dataset auswählen → **Snapshots ** → **Regelmäßige Snapshots ** :
| Unterordner | Häufigkeit | Aufbewahrung |
|------------- |-----------|--------------|
| `... /photos` | Stündlich | 24 Stunden |
| `... /photos` | Täglich | 30 Tage |
| `... /pgdata` | Stündlich | 24 Stunden |
| `... /pgdata` | Täglich | 30 Tage |
| `... /backups` | Täglich | 90 Tage |
| Dataset | Häufigkeit | Aufbewahrung |
|---------|-----------|--------------|
| `gerbil /photos` | Stündlich | 24 Stunden |
| `gerbil /photos` | Täglich | 30 Tage |
| `gerbil /pgdata` | Stündlich | 24 Stunden |
| `gerbil /pgdata` | Täglich | 30 Tage |
| `gerbil /backups` | Täglich | 90 Tage |
> **Hinweis:** `pgdata` enthält Live-Postgres-Dateien. ZFS-Snapshots davon sind crash-konsistent,
> aber **nicht** application-konsistent — für einen sauberen DB-Restore immer den `pg_dump` verwenden,
@@ -304,93 +257,94 @@ In TrueNAS → **Datasets** → `JailStorage/DockerVolumes/gerbilmanager` → **
### Snapshot manuell erstellen (z. B. vor Update)
``` bash
# Pool-/Dataset-Name anpassen falls nötig
zfs snapshot JailStorage/DockerVolumes/gerbilmanager /photos@vor-update-$( date +%Y%m%d)
zfs snapshot JailStorage/DockerVolumes/gerbilmanager /backups@vor-update-$( date +%Y%m%d)
# TrueNAS CLI
zfs snapshot SSD/gerbil /photos@vor-update-$( date +%Y%m%d)
zfs snapshot SSD/gerbil /backups@vor-update-$( date +%Y%m%d)
```
### Aus ZFS-Snapshot wiederherstellen (Fotos)
``` bash
# Snapshots auflisten
zfs list -t snapshot JailStorage/DockerVolumes/gerbilmanager /photos
# Snapshot auflisten
zfs list -t snapshot SSD/gerbil /photos
# Einzelne Datei aus Snapshot kopieren
cp /mnt/JailStorage/DockerVolumes/gerbilmanager /photos/.zfs/snapshot/<NAME>/datei.jpg \
# Datei aus Snapshot kopieren
cp /mnt/SSD/gerbil /photos/.zfs/snapshot/<NAME>/datei.jpg /mnt/SSD/gerbil/photos/
```
---
## 7. CI/CD via Gitea Actions
CI pusht Images nach Erfolg zu `git.rismer.de/gulum/gerbilmanager-api` und
`git.rismer.de/gulum/gerbilmanager-frontend` .
Der Workflow `. gitea/workflows/ci.yml` ist als **Entwurf vorhanden, aber inaktiv ** .
### Registry-Secrets in Gitea
### Aktivierung
Gitea → Repository → Einstellungen → Secrets:
1. **Gitea Actions aktivieren: **
Gitea → Repository `GerbilManager` → Einstellungen → Actions → "Actions aktivieren"
| Secret | Wert |
|--------|------|
| `REGISTRY_USER` | Gitea-Benutzername |
| `REGISTRY_TOKEN` | Gitea Access Token mit `package:write` |
2. **Gitea Actions Runner installieren ** (auf TrueNAS oder einem separaten Gerät):
```bash
# Gitea Runner Container (einfachste Variante für TrueNAS)
docker run -d --name gitea-runner \
-v /var/run/docker.sock:/var/run/docker.sock \
-v /opt/gitea-runner:/data \
-e GITEA_INSTANCE_URL=http://truenas:13000 \
-e GITEA_RUNNER_REGISTRATION_TOKEN=<TOKEN> \
gitea/act_runner:latest
` ``
Token: Gitea → Admin → Actions → Runner → "Runner hinzufügen"
### Update nach CI-Push
3. **Registry-Secrets konfigurieren:**
Gitea → Repository → Einstellungen → Secrets:
- ` REGISTRY_USER` — dein Gitea-Benutzername
- ` REGISTRY_TOKEN` — Gitea Access Token mit ` package:write`-Berechtigung
``` bash
# Auf der NAS nach erfolgreichem CI-Lauf:
cd /opt/gerbilmanager
git pull
docker compose -f deploy/truenas/compose.yaml pull
docker compose -f deploy/truenas/compose.yaml up -d
### Workflow nach Aktivierung
` ``
sh origin main
→ Gitea Actions: dotnet test + npm test + npm run build
→ Bei Erfolg: docker build + push zu truenas:13000/gulum/
→ Auf NAS: docker compose pull + up -d
` ``
---
Fehlerbehebung
Offene Fragen
Bitte beantworte diese Fragen, damit das Setup fertiggestellt werden kann:
| # | Frage | Auswirkung |
|---|-------|-----------|
| 1 | **TrueNAS SCALE Version?** Electric Eel 24.10 hat native Docker Custom Apps. Ältere Versionen nutzen Kubernetes. | Bestimmt ob ` docker compose` direkt läuft |
| 2 | **Gitea Actions verfügbar/aktivierbar?** | CI/CD-Workflow aktiv oder nur manuell deployen |
| 3 | **Eigener Postgres-Container (empfohlen) oder vorhandene NAS-Postgres-App?** | Isolation vs. geteilte Instanz |
| 4 | **Genaue Dataset-Pfade?** Poolname und Pfad-Präfix | ` .env`-Konfiguration |
| 5 | **Port-Wahl?** Standard 80 — frei auf der NAS? | ` PORT`-Wert in ` .env` |
---
## 9. Fehlerbehebung
### App startet nicht
` ``bash
# Logs aller Container
docker compose -f deploy/truenas/compose.yaml logs
# Logs eines bestimmten Containers
docker compose -f deploy/truenas/compose.yaml logs api
docker compose -f deploy/truenas/compose.yaml logs db
` ``
### Port 80 belegt
Falls Port 80 vom TrueNAS-System selbst genutzt wird:
``` bash
# In deploy/truenas/.env:
PORT = 8080
# Dann neu starten:
docker compose -f deploy/truenas/compose.yaml up -d
```
### Postgres startet nicht (Permission denied auf pgdata)
``` bash
# UID 999 muss Eigentümer des pgdata-Verzeichnisses sein:
chown -R 999:999 /mnt/JailStorage/DockerVolumes/gerbilmanager/pgdata
chmod 700 /mnt/JailStorage/DockerVolumes/gerbilmanager/pgdata
docker compose -f deploy/truenas/compose.yaml restart db
```
### Registry-Pull schlägt fehl
``` bash
# Neu einloggen:
docker login git.rismer.de
# Dann pull wiederholen:
docker compose -f deploy/truenas/compose.yaml pull
```
### Datenbank nicht erreichbar
` ``bash
# DB-Container läuft?
docker compose -f deploy/truenas/compose.yaml ps db
# Verbindung testen
docker compose -f deploy/truenas/compose.yaml exec db \
psql -U postgres -d gerbilmanager -c "\dt"
` ``
@@ -398,16 +352,27 @@ docker compose -f deploy/truenas/compose.yaml exec db \
### Backup-Fehler
` ``bash
docker compose -f deploy/truenas/compose.yaml exec backup /bin/sh /scripts/backup.sh
# Backup-Log prüfen
cat /mnt/SSD/gerbil/backups/backup.log | tail -30
# Backup manuell starten (mit Fehlerausgabe)
docker compose -f deploy/truenas/compose.yaml exec backup \
/bin/sh /scripts/backup.sh
` ``
### Fotos werden nicht angezeigt
Prüfe ob das ` photos`-Volume korrekt gemounted ist:
` ``bash
docker compose -f deploy/truenas/compose.yaml exec api ls /data/photos
` ``
### Container-Status zurücksetzen (Neustart)
` ``bash
docker compose -f deploy/truenas/compose.yaml restart api
` ``
### Kompletter Neustart (Daten bleiben erhalten)
` ``bash
