diff --git a/README.md b/README.md index 21a2fc4..f179989 100644 --- a/README.md +++ b/README.md @@ -27,10 +27,20 @@ Passe die Werte in der `.env`-Datei an deine Umgebung an (Passwörter, Masterser ### 2. Server starten +Das fertige Docker Image kann direkt verwendet werden – kein eigener Build nötig: + ```bash -docker compose up -d --build +docker compose up -d ``` +Das Image wird automatisch aus der Container-Registry geladen: + +``` +git.techniverse.net/scriptos/trackmania-server:latest +``` + +> **Tipp:** Alle verfügbaren Tags findest du in der [Container-Registry](https://git.techniverse.net/scriptos/-/packages/container/trackmania-server/). Wenn du das Image lieber selbst bauen möchtest, findest du die Anleitung unter [Schnellstart – Selbst bauen](docs/schnellstart.md#docker-image-selbst-bauen). + ### 3. Verwaltungsoberflächen öffnen - **AdminServ:** `http:///` diff --git a/docs/konfiguration.md b/docs/konfiguration.md index 13ae80b..0781602 100644 --- a/docs/konfiguration.md +++ b/docs/konfiguration.md @@ -88,7 +88,7 @@ docker run -d \ -v ./data/gamedata:/opt/tmserver/GameData \ -v ./data/controlpanel:/var/www/html \ -v ./data/xaseco:/opt/tmserver/xaseco \ - --name tmserver tmserver:latest + --name tmserver git.techniverse.net/scriptos/trackmania-server:latest ``` > **Achtung:** Bei `FORCE_CONFIG_UPDATE=true` wird die `dedicated_cfg.txt` komplett aus dem Template neu erzeugt und alle Platzhalter mit den aktuellen Umgebungsvariablen ersetzt. **Manuelle Änderungen an der Config gehen dabei verloren!** Andere Dateien im GameData-Volume (Tracks, Skins, Scores, etc.) bleiben erhalten. Nach dem Update sollte `FORCE_CONFIG_UPDATE` wieder auf `false` gesetzt werden. diff --git a/docs/ports.md b/docs/ports.md index d9e334b..d301658 100644 --- a/docs/ports.md +++ b/docs/ports.md @@ -20,7 +20,7 @@ docker run -d \ -p 3450:3450/tcp \ -v ./data/gamedata:/opt/tmserver/GameData \ -v ./data/xaseco:/opt/tmserver/xaseco \ - --name tmserver tmserver:latest + --name tmserver git.techniverse.net/scriptos/trackmania-server:latest ``` > **Hinweis:** Port 5000 (XML-RPC) wird intern von AdminServ verwendet und muss in der Regel nicht nach außen freigegeben werden. diff --git a/docs/schnellstart.md b/docs/schnellstart.md index dfbfdcd..d7bf828 100644 --- a/docs/schnellstart.md +++ b/docs/schnellstart.md @@ -18,7 +18,29 @@ Bearbeite die `.env`-Datei und setze mindestens die gewünschten Passwörter. F > **Wichtig:** Die `.env`-Datei enthält sensible Daten (Passwörter, Keys) und wird über die `.gitignore` vom Einchecken ausgeschlossen. -## 2. Docker Image bauen +## 2. Server starten + +### Fertiges Docker Image verwenden (empfohlen) + +Es steht ein fertiges Docker Image in der Container-Registry bereit – kein eigener Build nötig: + +``` +git.techniverse.net/scriptos/trackmania-server:latest +``` + +> **Tipp:** Alle verfügbaren Tags findest du in der [Container-Registry](https://git.techniverse.net/scriptos/-/packages/container/trackmania-server/). + +#### Mit Docker Compose + +```bash +docker compose up -d +``` + +Die Konfiguration erfolgt über die `.env`-Datei, die automatisch eingelesen wird. Das Image wird automatisch aus der Registry geladen. + +### Docker Image selbst bauen + +Alternativ kannst du das Image auch selbst bauen: ```bash docker build -t tmserver:latest -t tmserver:1.0.0 . @@ -26,16 +48,12 @@ docker build -t tmserver:latest -t tmserver:1.0.0 . Damit wird das Image mit zwei Tags erstellt: `tmserver:latest` und `tmserver:1.0.0`. -## 3. Server starten - -### Mit Docker Compose (empfohlen) +Anschließend den Server starten: ```bash docker compose up -d --build ``` -Die Konfiguration erfolgt über die `.env`-Datei, die automatisch eingelesen wird. - ### Internet-Modus (docker run) Für den Internet-Modus wird ein Server-Account benötigt. Dieser kann auf der [Trackmania Players-Seite](https://players.trackmaniaforever.com) erstellt werden. @@ -50,7 +68,7 @@ docker run -d \ -v ./data/gamedata:/opt/tmserver/GameData \ -v ./data/controlpanel:/var/www/html \ -v ./data/xaseco:/opt/tmserver/xaseco \ - --name tmserver tmserver:latest + --name tmserver git.techniverse.net/scriptos/trackmania-server:latest ``` ### LAN-Modus (docker run) @@ -68,10 +86,10 @@ docker run -d \ -v ./data/gamedata:/opt/tmserver/GameData \ -v ./data/controlpanel:/var/www/html \ -v ./data/xaseco:/opt/tmserver/xaseco \ - --name tmserver tmserver:latest + --name tmserver git.techniverse.net/scriptos/trackmania-server:latest ``` -## 4. Verwaltungsoberflächen öffnen +## 3. Verwaltungsoberflächen öffnen | Tool | URL | Beschreibung | |------|-----|-------------| diff --git a/docs/server-modi.md b/docs/server-modi.md index 424795a..74f0615 100644 --- a/docs/server-modi.md +++ b/docs/server-modi.md @@ -56,5 +56,5 @@ docker run -d \ -v ./data/gamedata:/opt/tmserver/GameData \ -v ./data/controlpanel:/var/www/html \ -v ./data/xaseco:/opt/tmserver/xaseco \ - --name tmserver tmserver:latest + --name tmserver git.techniverse.net/scriptos/trackmania-server:latest ``` diff --git a/docs/umgebungsvariablen.md b/docs/umgebungsvariablen.md index 71093d6..705139c 100644 --- a/docs/umgebungsvariablen.md +++ b/docs/umgebungsvariablen.md @@ -131,9 +131,11 @@ XAseco ist ein Server-Controller für Rekorde, Karma, Jukebox und mehr. Siehe [X Passe die Werte in der `.env`-Datei an und starte mit: ```bash -docker compose up -d --build +docker compose up -d ``` +> **Tipp:** Das fertige Docker Image wird automatisch aus der [Container-Registry](https://git.techniverse.net/scriptos/-/packages/container/trackmania-server/) geladen. Wenn du das Image selbst bauen möchtest, verwende stattdessen `docker compose up -d --build`. + ### docker run ```bash @@ -146,7 +148,7 @@ docker run -d \ -v ./data/gamedata:/opt/tmserver/GameData \ -v ./data/controlpanel:/var/www/html \ -v ./data/xaseco:/opt/tmserver/xaseco \ - --name tmserver tmserver:latest + --name tmserver git.techniverse.net/scriptos/trackmania-server:latest ``` Einzelne Werte können zusätzlich überschrieben werden: @@ -163,5 +165,5 @@ docker run -d \ -v ./data/gamedata:/opt/tmserver/GameData \ -v ./data/controlpanel:/var/www/html \ -v ./data/xaseco:/opt/tmserver/xaseco \ - --name tmserver tmserver:latest + --name tmserver git.techniverse.net/scriptos/trackmania-server:latest ```