docs: Update-Anleitung hinzugefügt, .env.example um fehlende XAseco-Healthcheck-Variablen ergänzt

This commit is contained in:
scriptos
2026-03-26 22:59:26 +01:00
parent 931c62eb6b
commit 32a09ba808
4 changed files with 115 additions and 1 deletions
+6
View File
@@ -118,6 +118,12 @@ XASECO_DB_PASSWORD="4KpL8mWnR3xYvBq"
# Server-Login und -Passwort werden automatisch aus SERVER_LOGIN / SERVER_LOGIN_PASSWORD übernommen. # Server-Login und -Passwort werden automatisch aus SERVER_LOGIN / SERVER_LOGIN_PASSWORD übernommen.
XASECO_DEDIMANIA_NATION=DEU XASECO_DEDIMANIA_NATION=DEU
# XAseco-Healthcheck: Überwacht XAseco und startet es automatisch neu bei Absturz oder Verbindungsverlust.
XASECO_HEALTHCHECK=true
# Prüfintervall des Healthchecks in Sekunden (Standard: 60)
XASECO_HEALTHCHECK_INTERVAL=60
# --- IP-Watcher --- # --- IP-Watcher ---
# Der IP-Watcher überwacht die ausgehende öffentliche IP des Containers und startet tmserver # Der IP-Watcher überwacht die ausgehende öffentliche IP des Containers und startet tmserver
# automatisch neu, wenn sich die IP ändert damit er sich beim Masterserver neu registriert. # automatisch neu, wenn sich die IP ändert damit er sich beim Masterserver neu registriert.
+1
View File
@@ -61,6 +61,7 @@ Die vollständige Dokumentation befindet sich im Ordner [`docs/`](docs/README.md
- [XAseco](docs/xaseco.md) Server-Controller für Rekorde, Karma und Jukebox - [XAseco](docs/xaseco.md) Server-Controller für Rekorde, Karma und Jukebox
- [IP-Watcher](docs/ip-watcher.md) Automatischer Neustart bei IP-Wechsel - [IP-Watcher](docs/ip-watcher.md) Automatischer Neustart bei IP-Wechsel
- [Ports](docs/ports.md) Freigegebene Ports und deren Verwendung - [Ports](docs/ports.md) Freigegebene Ports und deren Verwendung
- [Update](docs/update.md) Bestehende Installation aktualisieren
## Danksagung ## Danksagung
+3 -1
View File
@@ -17,6 +17,7 @@
| [XAseco](xaseco.md) | Server-Controller für Rekorde, Karma und Jukebox | | [XAseco](xaseco.md) | Server-Controller für Rekorde, Karma und Jukebox |
| [IP-Watcher](ip-watcher.md) | Automatischer Neustart bei IP-Wechsel | | [IP-Watcher](ip-watcher.md) | Automatischer Neustart bei IP-Wechsel |
| [Ports](ports.md) | Freigegebene Ports und deren Verwendung | | [Ports](ports.md) | Freigegebene Ports und deren Verwendung |
| [Update](update.md) | Bestehende Installation aktualisieren |
## Projektstruktur ## Projektstruktur
@@ -50,7 +51,8 @@
├── .gitea/ ├── .gitea/
│ └── workflows/ │ └── workflows/
│ └── docker-publish.yml # CI/CD: Docker Image Build & Push bei neuem Release-Tag │ └── docker-publish.yml # CI/CD: Docker Image Build & Push bei neuem Release-Tag
├── docs/ # Dokumentation ├── docs/ # Dokumentation (siehe Tabelle oben)
│ └── update.md # Update-Anleitung
├── docker-compose.yml # Docker Compose Konfiguration ├── docker-compose.yml # Docker Compose Konfiguration
├── Dockerfile # Docker Build-Definition ├── Dockerfile # Docker Build-Definition
├── .dockerignore # Docker-Ignore-Regeln ├── .dockerignore # Docker-Ignore-Regeln
+105
View File
@@ -0,0 +1,105 @@
# Update-Anleitung
Diese Anleitung beschreibt, wie du eine **bestehende Installation** auf den neuesten Stand bringst ohne Daten zu verlieren und ohne alles neu aufsetzen zu müssen.
> **Hinweis:** Alle persistenten Daten (Konfiguration, Tracks, Datenbanken, Logs) liegen im Ordner `./data/` und werden bei einem Update nicht berührt.
---
## 1. Repository aktualisieren
Wechsle in den Projektordner und lade die neuesten Änderungen:
```bash
git pull
```
Damit werden aktualisierte Konfigurationsdateien, Skripte und Dokumentation aus dem Repository übernommen.
---
## 2. Neue Umgebungsvariablen prüfen
Mit neuen Versionen können neue Variablen in der `.env.example` hinzugekommen sein. Deine persönliche `.env`-Datei wird dabei **nicht überschrieben** du musst neue Variablen manuell nachtragen.
Vergleiche `.env.example` mit deiner `.env`, um fehlende Einträge zu finden:
```bash
diff .env.example .env
```
Zeilen, die in `.env.example` vorhanden sind, aber nicht in deiner `.env`, erscheinen mit `<` am Anfang. Diese solltest du in deine `.env` übernehmen und die Werte anpassen.
> **Tipp:** Neue Variablen haben in der Regel sinnvolle Standardwerte, die du oft einfach übernehmen kannst. Achte nur auf sicherheitsrelevante Werte wie Passwörter.
---
## 3. Docker Image aktualisieren
Lade das neueste Image aus der Registry:
```bash
docker compose pull
```
---
## 4. Container neu starten
Starte die Container mit dem neuen Image neu. Docker Compose erkennt automatisch, ob ein Rebuild nötig ist:
```bash
docker compose up -d
```
> **Hinweis:** Wenn sich die `docker-compose.yml` geändert hat (z.B. neue Services oder geänderte Konfiguration), werden betroffene Container automatisch neu erstellt. Deine Daten in `./data/` bleiben dabei vollständig erhalten.
---
## Zusammenfassung
```bash
# Im Projektordner ausführen:
git pull
docker compose pull
docker compose up -d
```
Das war's der Server läuft jetzt auf dem neuesten Stand.
---
## Was passiert mit meinen Daten?
| Ordner | Inhalt | Beim Update |
|--------|--------|-------------|
| `./data/gamedata/` | TM-Server-Daten, Konfiguration, Tracks | Bleibt erhalten |
| `./data/controlpanel/` | AdminServ- und RemoteCP-Daten | Bleibt erhalten |
| `./data/xaseco/` | XAseco-Konfiguration und Logs | Bleibt erhalten |
| `./data/mariadb/` | Datenbankdateien | Bleibt erhalten |
| `.env` | Deine Umgebungsvariablen | Wird nicht überschrieben |
---
## Häufige Situationen
### Neue Umgebungsvariable hat keinen Effekt
Einige Variablen (z.B. `SERVER_SA_PASSWORD`) werden nur beim **ersten Start** in die `dedicated_cfg.txt` geschrieben. Falls du eine neue Variable nachträglich setzen möchtest, kannst du das erzwingen:
```bash
# In der .env setzen:
FORCE_CONFIG_UPDATE=true
```
Dann Container neu starten. Danach unbedingt wieder auf `false` setzen, damit manuelle Änderungen erhalten bleiben. Weitere Details unter [Konfiguration](konfiguration.md).
### Welches Image-Tag wird verwendet?
In der `docker-compose.yml` ist das Image-Tag angegeben (z.B. `1.3.1` oder `latest`). Du kannst auf `latest` umstellen, um immer automatisch das neueste Image zu bekommen:
```yaml
image: git.techniverse.net/scriptos/trackmania-server:latest
```
Alle verfügbaren Tags findest du in der [Container-Registry](https://git.techniverse.net/scriptos/-/packages/container/trackmania-server/).