diff --git a/.dockerignore b/.dockerignore index 4cae310..727dc16 100644 --- a/.dockerignore +++ b/.dockerignore @@ -1,9 +1,18 @@ # Git .git .gitignore +.gitattributes # IDE .vscode # Docs README.md +docs + +# Umgebungsvariablen (Secrets!) +.env +.env.example + +# Persistente Daten +data diff --git a/.env.example b/.env.example new file mode 100644 index 0000000..2590ccd --- /dev/null +++ b/.env.example @@ -0,0 +1,40 @@ +# ============================================================ +# tmserver-docker – Umgebungsvariablen +# ============================================================ +# Diese Datei wird von docker-compose.yml eingelesen. +# Kopiere diese Vorlage nach .env und passe die Werte an: +# cp .env.example .env +# +# WICHTIG: .env niemals ins Git einchecken! +# ============================================================ + +# --- Authentifizierung --- +SERVER_SA_PASSWORD=SuperAdmin +SERVER_ADM_PASSWORD=Admin +SERVER_USER_PASSWORD=User + +# --- Masterserver-Account (fuer Internet-Modus) --- +SERVER_LOGIN= +SERVER_LOGIN_PASSWORD= +SERVER_VALIDATION_KEY= + +# --- Server-Optionen --- +SERVER_NAME=Trackmania Server +SERVER_DESC=Powered by tmserver-docker +SERVER_HIDE=0 +SERVER_MAX_PLAYERS=32 +SERVER_PASSWORD= +SERVER_MAX_SPECTATORS=32 +SERVER_SPEC_PASSWORD= +SERVER_LADDER_MODE=forced + +# --- Netzwerk --- +SERVER_PORT=2350 +SERVER_P2P_PORT=3450 +SERVER_XMLRPC_PORT=5000 +SERVER_UPLOAD_RATE=512 +SERVER_DOWNLOAD_RATE=8192 + +# --- Server-Modus und Config-Steuerung --- +SERVER_MODE=internet +FORCE_CONFIG_UPDATE=false diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..dfdb8b7 --- /dev/null +++ b/.gitattributes @@ -0,0 +1 @@ +*.sh text eol=lf diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..4796708 --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +# Umgebungsvariablen (enthaelt Passwoerter!) +.env + +# Persistente Server-Daten +data/ diff --git a/Dockerfile b/Dockerfile index 38082b7..e8df303 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,35 +1,64 @@ -FROM debian:stretch-slim +FROM debian:bookworm-slim RUN mkdir /opt/tmserver WORKDIR /opt/tmserver +# Alle benoetigten Pakete in einem Layer installieren und Cache aufraeumen +RUN apt-get update && apt-get install -y --no-install-recommends \ + unzip \ + apache2 \ + php \ + php-zip \ + php-xml \ + && rm -rf /var/lib/apt/lists/* + COPY assets/bin/TrackmaniaServer_2011-02-21.zip /opt/tmserver -RUN apt-get update && apt-get install -y unzip -RUN unzip /opt/tmserver/TrackmaniaServer_2011-02-21.zip -d /opt/tmserver -COPY custom_game_settings.txt /opt/tmserver/GameData/Tracks/MatchSettings/ -COPY RunTrackmaniaServer.sh /opt/tmserver/ +RUN unzip /opt/tmserver/TrackmaniaServer_2011-02-21.zip -d /opt/tmserver \ + && rm -f /opt/tmserver/TrackmaniaServer_2011-02-21.zip + +# Custom-Konfiguration ueber die Standard-Config aus dem ZIP kopieren +COPY assets/config/dedicated_cfg.txt /opt/tmserver/GameData/Config/dedicated_cfg.txt +COPY assets/config/custom_game_settings.txt /opt/tmserver/GameData/Tracks/MatchSettings/ + +# Gesamtes GameData als Default-Template sichern (wird beim ersten Start ins Volume kopiert) +RUN cp -r /opt/tmserver/GameData /opt/tmserver/default-gamedata + +COPY assets/bin/RunTrackmaniaServer.sh /opt/tmserver/ +RUN sed -i 's/\r$//' /opt/tmserver/RunTrackmaniaServer.sh \ + && chmod +x /opt/tmserver/RunTrackmaniaServer.sh -RUN apt-get -y install apache2 php php-zip php-xml COPY assets/bin/AdminServ_v2.1.1.zip /var/www/html -RUN unzip /var/www/html/AdminServ_v2.1.1.zip -d /var/www/html -RUN chmod -R 777 /var/www/html/ -RUN rm -f /var/www/html/index.html +RUN unzip /var/www/html/AdminServ_v2.1.1.zip -d /var/www/html \ + && rm -f /var/www/html/AdminServ_v2.1.1.zip \ + && chmod -R 777 /var/www/html/ \ + && rm -f /var/www/html/index.html -ARG SERVER_NAME='Trackmania Server' -ARG SERVER_DESC='This is a Trackmania Server' -ARG SERVER_SA_PASSWORD='SuperAdmin' -ARG SERVER_ADM_PASSWORD='Admin' -ARG SERVER_MODE='internet' -ARG SERVER_LOGIN='' -ARG SERVER_VALIDATION_KEY='' -ENV SERVER_NAME $SERVER_NAME -ENV SERVER_DESC $SERVER_DESC -ENV SERVER_SA_PASSWORD $SERVER_SA_PASSWORD -ENV SERVER_ADM_PASSWORD $SERVER_ADM_PASSWORD -ENV SERVER_MODE $SERVER_MODE -ENV SERVER_LOGIN $SERVER_LOGIN -ENV SERVER_VALIDATION_KEY $SERVER_VALIDATION_KEY +# --- Umgebungsvariablen --- +# Sensible Werte (Passwoerter, Keys) werden NICHT im Image hinterlegt, +# sondern muessen zur Laufzeit uebergeben werden (z.B. via .env-Datei). + +# Server-Optionen (nicht-sensible Standardwerte) +ENV SERVER_NAME="Trackmania Server" +ENV SERVER_DESC="Powered by tmserver-docker" +ENV SERVER_HIDE=0 +ENV SERVER_MAX_PLAYERS=32 +ENV SERVER_MAX_SPECTATORS=32 +ENV SERVER_LADDER_MODE=forced + +# Netzwerk +ENV SERVER_PORT=2350 +ENV SERVER_P2P_PORT=3450 +ENV SERVER_XMLRPC_PORT=5000 +ENV SERVER_UPLOAD_RATE=512 +ENV SERVER_DOWNLOAD_RATE=8192 + +# Server-Modus und Config-Steuerung +ENV SERVER_MODE=internet +ENV FORCE_CONFIG_UPDATE=false + +# Volume fuer persistente GameData (Config, Tracks, Skins, Scores, etc.) +VOLUME /opt/tmserver/GameData EXPOSE 5000/tcp EXPOSE 2350/tcp diff --git a/README.md b/README.md index 9a8d498..a67803d 100644 --- a/README.md +++ b/README.md @@ -4,37 +4,47 @@ Trackmania Nations Forever Docker Server > **Hinweis:** Dieses Projekt ist ein Fork von [lduriez/tmserver-docker](https://github.com/lduriez/tmserver-docker?tab=readme-ov-file). -Das Docker-Image ist auf Docker Hub verfügbar: [lduriez/tmserver](https://hub.docker.com/r/lduriez/tmserver) - Der Server unterstützt sowohl den **Internet-Dedicated-Modus** (Standard) als auch den **LAN-Dedicated-Modus**. ## Schnellstart -### Internet-Modus (Standard) - -Voraussetzung: Ein Server-Account auf [players.trackmaniaforever.com](https://players.trackmaniaforever.com). +### 1. Umgebungsvariablen einrichten ```bash -docker run -d \ - -p 2350:2350/tcp \ - -p 2350:2350/udp \ - -p 3450:3450/tcp \ - -p 80:80/tcp \ - -e SERVER_LOGIN=dein_login \ - -e SERVER_VALIDATION_KEY=dein_key \ - --name tm-server lduriez/tmserver +cp .env.example .env ``` -### LAN-Modus +Passe die Werte in der `.env`-Datei an deine Umgebung an (Passwörter, Masterserver-Account, etc.). + +### 2. Server starten ```bash -docker run -d \ - -p 2350:2350/tcp \ - -p 2350:2350/udp \ - -p 3450:3450/tcp \ - -p 80:80/tcp \ - -e SERVER_MODE=lan \ - --name tm-server lduriez/tmserver +docker compose up -d --build +``` + +### 3. AdminServ öffnen + +Die Verwaltungsoberfläche ist unter `http://` erreichbar. + +> **Hinweis:** Für den Internet-Modus müssen `SERVER_LOGIN` und `SERVER_VALIDATION_KEY` in der `.env`-Datei gesetzt sein. Einen Server-Account kannst du auf [players.trackmaniaforever.com](https://players.trackmaniaforever.com) erstellen. Für den LAN-Modus setze `SERVER_MODE=lan`. + +## Projektstruktur + +``` +├── assets/ +│ ├── bin/ # Binaries und Startscript +│ │ ├── AdminServ_v2.1.1.zip # AdminServ Web-UI +│ │ ├── RunTrackmaniaServer.sh # Container-Startscript +│ │ └── TrackmaniaServer_*.zip # Trackmania Server Binary +│ └── config/ +│ ├── custom_game_settings.txt # MatchSettings (Spielmodus, Map-Rotation) +│ └── dedicated_cfg.txt # Server-Config-Template (mit Platzhaltern) +├── docs/ # Dokumentation +├── docker-compose.yml # Docker Compose Konfiguration +├── Dockerfile # Docker Build-Definition +├── .env.example # Vorlage fuer Umgebungsvariablen +├── .env # Lokale Umgebungsvariablen (nicht im Git!) +└── data/GameData/ # Persistente Serverdaten (zur Laufzeit) ``` ## Dokumentation @@ -42,6 +52,7 @@ docker run -d \ Die vollständige Dokumentation befindet sich im Ordner [`docs/`](docs/README.md): - [Schnellstart](docs/schnellstart.md) – Erste Schritte und minimale Konfiguration +- [Konfiguration](docs/konfiguration.md) – Persistente Serverkonfiguration (dedicated_cfg.txt) - [Umgebungsvariablen](docs/umgebungsvariablen.md) – Alle verfügbaren Umgebungsvariablen - [Server-Modi](docs/server-modi.md) – LAN- und Internet-Dedicated-Modus - [AdminServ](docs/adminserv.md) – Einrichtung der Server-Verwaltungsoberfläche diff --git a/RunTrackmaniaServer.sh b/RunTrackmaniaServer.sh deleted file mode 100755 index 065fdbc..0000000 --- a/RunTrackmaniaServer.sh +++ /dev/null @@ -1,37 +0,0 @@ -#!/bin/sh - -echo "Starting apache server" -service apache2 start - -CONFIG="/opt/tmserver/GameData/Config/dedicated_cfg.txt" - -echo "Setting ENV/ARG variables" -sed -i "s/SuperAdmin/${SERVER_SA_PASSWORD}/" "$CONFIG" -sed -i "s/Admin/${SERVER_ADM_PASSWORD}/" "$CONFIG" -sed -i "s/${SERVER_NAME}${SERVER_DESC}False/True/" "$CONFIG" - -# Bestimme Server-Modus (Standard: internet) -SERVER_MODE="${SERVER_MODE:-internet}" - -if [ "$SERVER_MODE" = "internet" ]; then - echo "Configuring Internet-Dedicated mode" - if [ -z "$SERVER_LOGIN" ] || [ -z "$SERVER_VALIDATION_KEY" ]; then - echo "ERROR: SERVER_LOGIN and SERVER_VALIDATION_KEY are required for Internet-Dedicated mode." - echo "Set SERVER_MODE=lan to start in LAN mode, or provide the required variables." - exit 1 - fi - sed -i "s||${SERVER_LOGIN}|" "$CONFIG" - sed -i "s||${SERVER_VALIDATION_KEY}|" "$CONFIG" - LAUNCH_MODE="/internet" -else - echo "Configuring LAN-Dedicated mode" - LAUNCH_MODE="/lan" -fi - -echo "Server config dedicated_cfg.txt is" -cat "$CONFIG" - -echo "Launching Server in ${SERVER_MODE} mode" -exec ./TrackmaniaServer /dedicated_cfg=dedicated_cfg.txt /game_settings=MatchSettings/custom_game_settings.txt /nodaemon ${LAUNCH_MODE} diff --git a/assets/bin/RunTrackmaniaServer.sh b/assets/bin/RunTrackmaniaServer.sh new file mode 100644 index 0000000..7420e53 --- /dev/null +++ b/assets/bin/RunTrackmaniaServer.sh @@ -0,0 +1,95 @@ +#!/bin/sh + +echo "Starting apache server" +service apache2 start + +CONFIG="/opt/tmserver/GameData/Config/dedicated_cfg.txt" +GAMEDATA_DIR="/opt/tmserver/GameData" +DEFAULT_GAMEDATA="/opt/tmserver/default-gamedata" + +# ============================================================ +# Persistente GameData: First-Run-Logik +# ============================================================ +# Beim ersten Start (leeres Volume) wird das gesamte GameData- +# Verzeichnis aus dem Default-Template ins Volume kopiert und +# die Umgebungsvariablen auf die Config angewendet. +# Bei weiteren Starts wird die vorhandene Konfiguration beibehalten, +# damit manuelle Aenderungen nicht ueberschrieben werden. +# Mit FORCE_CONFIG_UPDATE=true kann ein erneutes Anwenden erzwungen werden. +# ============================================================ + +FORCE_CONFIG_UPDATE="${FORCE_CONFIG_UPDATE:-false}" + +if [ ! -f "$CONFIG" ]; then + echo "==> Erster Start erkannt: Kopiere Default-GameData ins Volume..." + cp -r "$DEFAULT_GAMEDATA"/* "$GAMEDATA_DIR/" + APPLY_ENV=true +elif [ "$FORCE_CONFIG_UPDATE" = "true" ]; then + echo "==> FORCE_CONFIG_UPDATE ist aktiv: Umgebungsvariablen werden erneut angewendet..." + echo " ACHTUNG: Manuelle Aenderungen an den betroffenen Feldern werden ueberschrieben!" + # Template neu kopieren, damit alle Platzhalter vorhanden sind + cp "$DEFAULT_GAMEDATA/Config/dedicated_cfg.txt" "$CONFIG" + APPLY_ENV=true +else + echo "==> Vorhandene Konfiguration gefunden. Umgebungsvariablen werden NICHT angewendet." + echo " Zum erneuten Anwenden: FORCE_CONFIG_UPDATE=true setzen." + APPLY_ENV=false +fi + +# ============================================================ +# Platzhalter in dedicated_cfg.txt durch Umgebungsvariablen ersetzen +# ============================================================ +if [ "$APPLY_ENV" = "true" ]; then + echo "Ersetze Platzhalter in dedicated_cfg.txt mit Umgebungsvariablen..." + + # Authentifizierung + sed -i "s|%%SERVER_SA_PASSWORD%%|${SERVER_SA_PASSWORD}|g" "$CONFIG" + sed -i "s|%%SERVER_ADM_PASSWORD%%|${SERVER_ADM_PASSWORD}|g" "$CONFIG" + sed -i "s|%%SERVER_USER_PASSWORD%%|${SERVER_USER_PASSWORD}|g" "$CONFIG" + + # Masterserver-Account + sed -i "s|%%SERVER_LOGIN%%|${SERVER_LOGIN}|g" "$CONFIG" + sed -i "s|%%SERVER_LOGIN_PASSWORD%%|${SERVER_LOGIN_PASSWORD}|g" "$CONFIG" + sed -i "s|%%SERVER_VALIDATION_KEY%%|${SERVER_VALIDATION_KEY}|g" "$CONFIG" + + # Server-Optionen + sed -i "s|%%SERVER_NAME%%|${SERVER_NAME}|g" "$CONFIG" + sed -i "s|%%SERVER_DESC%%|${SERVER_DESC}|g" "$CONFIG" + sed -i "s|%%SERVER_HIDE%%|${SERVER_HIDE}|g" "$CONFIG" + sed -i "s|%%SERVER_MAX_PLAYERS%%|${SERVER_MAX_PLAYERS}|g" "$CONFIG" + sed -i "s|%%SERVER_PASSWORD%%|${SERVER_PASSWORD}|g" "$CONFIG" + sed -i "s|%%SERVER_MAX_SPECTATORS%%|${SERVER_MAX_SPECTATORS}|g" "$CONFIG" + sed -i "s|%%SERVER_SPEC_PASSWORD%%|${SERVER_SPEC_PASSWORD}|g" "$CONFIG" + sed -i "s|%%SERVER_LADDER_MODE%%|${SERVER_LADDER_MODE}|g" "$CONFIG" + + # Netzwerk + sed -i "s|%%SERVER_PORT%%|${SERVER_PORT}|g" "$CONFIG" + sed -i "s|%%SERVER_P2P_PORT%%|${SERVER_P2P_PORT}|g" "$CONFIG" + sed -i "s|%%SERVER_XMLRPC_PORT%%|${SERVER_XMLRPC_PORT}|g" "$CONFIG" + sed -i "s|%%SERVER_UPLOAD_RATE%%|${SERVER_UPLOAD_RATE}|g" "$CONFIG" + sed -i "s|%%SERVER_DOWNLOAD_RATE%%|${SERVER_DOWNLOAD_RATE}|g" "$CONFIG" + + echo "Platzhalter erfolgreich ersetzt." +fi + +# Bestimme Server-Modus (Standard: internet) +SERVER_MODE="${SERVER_MODE:-internet}" + +if [ "$SERVER_MODE" = "internet" ]; then + echo "Configuring Internet-Dedicated mode" + if [ -z "$SERVER_LOGIN" ] || [ -z "$SERVER_VALIDATION_KEY" ]; then + echo "ERROR: SERVER_LOGIN and SERVER_VALIDATION_KEY are required for Internet-Dedicated mode." + echo "Set SERVER_MODE=lan to start in LAN mode, or provide the required variables." + exit 1 + fi + LAUNCH_MODE="/internet" +else + echo "Configuring LAN-Dedicated mode" + LAUNCH_MODE="/lan" +fi + +echo "Server config dedicated_cfg.txt is" +cat "$CONFIG" + +echo "Launching Server in ${SERVER_MODE} mode" +exec ./TrackmaniaServer /dedicated_cfg=dedicated_cfg.txt /game_settings=MatchSettings/custom_game_settings.txt /nodaemon ${LAUNCH_MODE} diff --git a/custom_game_settings.txt b/assets/config/custom_game_settings.txt similarity index 100% rename from custom_game_settings.txt rename to assets/config/custom_game_settings.txt diff --git a/assets/config/dedicated_cfg.txt b/assets/config/dedicated_cfg.txt new file mode 100644 index 0000000..a56276c --- /dev/null +++ b/assets/config/dedicated_cfg.txt @@ -0,0 +1,92 @@ + + + + + + SuperAdmin + %%SERVER_SA_PASSWORD%% + + + Admin + %%SERVER_ADM_PASSWORD%% + + + User + %%SERVER_USER_PASSWORD%% + + + + + %%SERVER_LOGIN%% + %%SERVER_LOGIN_PASSWORD%% + %%SERVER_VALIDATION_KEY%% + + + + %%SERVER_NAME%% + %%SERVER_DESC%% + %%SERVER_HIDE%% + + %%SERVER_MAX_PLAYERS%% + %%SERVER_PASSWORD%% + + %%SERVER_MAX_SPECTATORS%% + %%SERVER_SPEC_PASSWORD%% + + %%SERVER_LADDER_MODE%% + 0 + 50000 + + True + True + + 60000 + 0.5 + + + + + + False + True + True + + + 0 + + False + + + + %%SERVER_UPLOAD_RATE%% + %%SERVER_DOWNLOAD_RATE%% + + + %%SERVER_PORT%% + %%SERVER_P2P_PORT%% + 0 + + + + 600 + + %%SERVER_XMLRPC_PORT%% + True + + + + + + stadium + + False + + + + + + False + + + + diff --git a/docker-compose.yml b/docker-compose.yml index 6ff195d..52bdc7f 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -2,27 +2,18 @@ services: tmserver: build: context: . - args: - SERVER_NAME: "Trackmania Server" - SERVER_DESC: "This is a Trackmania Server" - SERVER_SA_PASSWORD: "SuperAdmin" - SERVER_ADM_PASSWORD: "Admin" container_name: tmserver restart: unless-stopped ports: - - "2350:2350/tcp" - - "2350:2350/udp" - - "3450:3450/tcp" - - "5000:5000/tcp" + - "${SERVER_PORT:-2350}:2350/tcp" + - "${SERVER_PORT:-2350}:2350/udp" + - "${SERVER_P2P_PORT:-3450}:3450/tcp" + - "${SERVER_XMLRPC_PORT:-5000}:5000/tcp" - "80:80/tcp" - environment: - - SERVER_NAME=Trackmania Server - - SERVER_DESC=This is a Trackmania Server - - SERVER_SA_PASSWORD=SuperAdmin - - SERVER_ADM_PASSWORD=Admin - - SERVER_MODE=internet - - SERVER_LOGIN= - - SERVER_VALIDATION_KEY= + env_file: + - .env + volumes: + - ./data/GameData:/opt/tmserver/GameData networks: tmserver_net: ipv4_address: 172.20.60.10 diff --git a/docs/README.md b/docs/README.md index 8679908..7d89c8d 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,9 +2,12 @@ Übersicht aller verfügbaren Dokumentationen für den Trackmania Nations Forever Docker Server. +> **Wichtig:** Vor dem ersten Start muss eine `.env`-Datei aus der Vorlage erstellt werden: `cp .env.example .env` + | Dokument | Beschreibung | |----------|-------------| | [Schnellstart](schnellstart.md) | Erste Schritte und minimale Konfiguration | +| [Konfiguration](konfiguration.md) | Persistente Serverkonfiguration (dedicated_cfg.txt) | | [Umgebungsvariablen](umgebungsvariablen.md) | Alle verfügbaren Umgebungsvariablen | | [Server-Modi](server-modi.md) | LAN- und Internet-Dedicated-Modus | | [AdminServ](adminserv.md) | Einrichtung der Server-Verwaltungsoberfläche | diff --git a/docs/adminserv.md b/docs/adminserv.md index da5ac06..fd4cc8c 100644 --- a/docs/adminserv.md +++ b/docs/adminserv.md @@ -26,4 +26,4 @@ Die Server-Verwaltungsoberfläche basiert auf [AdminServ](https://github.com/Chr Die Admin-Stufen können unter `http:///config` geändert werden. -> **Hinweis:** Es wird empfohlen, die Standard-Passwörter über die [Umgebungsvariablen](umgebungsvariablen.md) `SERVER_SA_PASSWORD` und `SERVER_ADM_PASSWORD` zu ändern. +> **Hinweis:** Es wird empfohlen, die Standard-Passwörter über die `.env`-Datei (`SERVER_SA_PASSWORD`, `SERVER_ADM_PASSWORD`) zu ändern. Siehe [Umgebungsvariablen](umgebungsvariablen.md). diff --git a/docs/konfiguration.md b/docs/konfiguration.md new file mode 100644 index 0000000..2940270 --- /dev/null +++ b/docs/konfiguration.md @@ -0,0 +1,125 @@ +# Konfiguration (dedicated_cfg.txt) + +Die Server-Konfiguration wird in der Datei `dedicated_cfg.txt` im Verzeichnis `GameData/Config/` gespeichert. Diese Datei enthält alle wichtigen Parameter für den Serverbetrieb. + +Die Template-Konfiguration befindet sich im Repository unter `assets/config/dedicated_cfg.txt`. Sie enthält `%%PLATZHALTER%%` anstelle von echten Werten – keine Passwörter oder Zugangsdaten im Repo! Die Platzhalter werden beim ersten Container-Start durch die [Umgebungsvariablen](umgebungsvariablen.md) ersetzt. + +## Persistente Speicherung + +Das gesamte **GameData-Verzeichnis** wird über ein Bind-Mount (`./data/GameData`) persistent auf dem Host gespeichert. Das bedeutet: + +- Alle Daten (Konfiguration, Tracks, Skins, Scores, Cache, etc.) bleiben erhalten +- Manuelle Änderungen gehen nicht verloren, auch wenn der Container neu erstellt wird +- Dateien können direkt auf dem Host bearbeitet werden + +### Volume-Pfad + +| Host-Pfad | Container-Pfad | Beschreibung | +|-----------|----------------|-------------| +| `./data/GameData` | `/opt/tmserver/GameData` | Gesamtes GameData-Verzeichnis | + +### Enthaltene Unterordner + +| Ordner | Beschreibung | +|--------|-------------| +| `Config/` | Server-Konfiguration (`dedicated_cfg.txt`, Blacklist, Guestlist) | +| `Tracks/` | Strecken und MatchSettings | +| `Skins/` | Spieler- und Fahrzeug-Skins | +| `Scores/` | Gespeicherte Punktestände | +| `Cache/` | Server-Cache | +| `Profiles/` | Spielerprofile | +| `Replays/` | Gespeicherte Replays | + +## Reihenfolge beim Docker-Build + +1. ZIP-Archiv wird entpackt → Standard-`dedicated_cfg.txt` aus dem ZIP landet in `GameData/Config/` +2. Template aus `assets/config/dedicated_cfg.txt` (mit `%%PLATZHALTERN%%`) wird darüber kopiert +3. Gesamtes `GameData/`-Verzeichnis wird als Default-Template gesichert + +## First-Run-Verhalten + +Beim **ersten Start** des Containers (leeres Volume) passiert Folgendes: + +1. Das gesamte Default-GameData-Template wird aus dem Image ins Volume kopiert +2. Alle `%%PLATZHALTER%%` in der `dedicated_cfg.txt` werden durch die [Umgebungsvariablen](umgebungsvariablen.md) ersetzt +3. Der Server startet mit der so erzeugten Konfiguration + +Bei **weiteren Starts** wird die vorhandene Konfiguration **nicht überschrieben**. Umgebungsvariablen haben dann keine Wirkung mehr auf die `dedicated_cfg.txt`. + +## Konfiguration manuell bearbeiten + +Nach dem ersten Start kann die Konfiguration direkt auf dem Host bearbeitet werden: + +```bash +# Konfiguration direkt auf dem Host bearbeiten +nano ./data/GameData/Config/dedicated_cfg.txt + +# Alternativ: im Container anzeigen +docker exec tmserver cat /opt/tmserver/GameData/Config/dedicated_cfg.txt + +# Server neustarten, damit die Änderungen wirksam werden +docker restart tmserver +``` + +> **Hinweis:** Da `GameData/` als Bind-Mount eingebunden ist, sind Dateien direkt unter `./data/GameData/` auf dem Host verfügbar – ohne `docker cp` oder `docker exec`. + +## Konfiguration zurücksetzen (FORCE_CONFIG_UPDATE) + +Falls die Umgebungsvariablen erneut auf die Konfiguration angewendet werden sollen (z.B. nach einer Passwortänderung), kann die Variable `FORCE_CONFIG_UPDATE` verwendet werden. + +In der `.env`-Datei: + +```bash +FORCE_CONFIG_UPDATE=true +``` + +Oder per `docker run`: + +```bash +docker run -d \ + --env-file .env \ + -e FORCE_CONFIG_UPDATE=true \ + -p 2350:2350/tcp \ + -p 2350:2350/udp \ + -p 3450:3450/tcp \ + -p 80:80/tcp \ + -v ./data/GameData:/opt/tmserver/GameData \ + --name tmserver tmserver: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. + +## Wichtige Dateien im Config-Ordner + +Der Ordner `GameData/Config/` enthält: + +| Datei | Beschreibung | +|-------|-------------| +| `dedicated_cfg.txt` | Haupt-Konfigurationsdatei des Servers | +| `blacklist.txt` | Liste gesperrter Spieler | +| `guestlist.txt` | Liste erlaubter Spieler | +| `Default.SystemConfig.Gbx` | System-Konfiguration | + +## Wichtige Parameter in der dedicated_cfg.txt + +Alle diese Parameter können über [Umgebungsvariablen](umgebungsvariablen.md) gesetzt werden: + +| Parameter | Umgebungsvariable | Standard | +|-----------|------------------|----------| +| `` (SuperAdmin-PW) | `SERVER_SA_PASSWORD` | `SuperAdmin` | +| `` (Admin-PW) | `SERVER_ADM_PASSWORD` | `Admin` | +| `` (User-PW) | `SERVER_USER_PASSWORD` | `User` | +| `` | `SERVER_LOGIN` | *(leer)* | +| `` | `SERVER_VALIDATION_KEY` | *(leer)* | +| `` (Servername) | `SERVER_NAME` | `Trackmania Server` | +| `` | `SERVER_DESC` | `Powered by tmserver-docker` | +| `` | `SERVER_HIDE` | `0` | +| `` | `SERVER_MAX_PLAYERS` | `32` | +| `` | `SERVER_PASSWORD` | *(leer)* | +| `` | `SERVER_MAX_SPECTATORS` | `32` | +| `` | `SERVER_LADDER_MODE` | `forced` | +| `` | `SERVER_PORT` | `2350` | +| `` | `SERVER_P2P_PORT` | `3450` | +| `` | `SERVER_XMLRPC_PORT` | `5000` | +| `` | `SERVER_UPLOAD_RATE` | `512` | +| `` | `SERVER_DOWNLOAD_RATE` | `8192` | diff --git a/docs/ports.md b/docs/ports.md index d1a6b6a..3c3001a 100644 --- a/docs/ports.md +++ b/docs/ports.md @@ -14,10 +14,12 @@ Für den reinen Spielbetrieb ohne Verwaltungsoberfläche reichen die Ports 2350 ```bash docker run -d \ + --env-file .env \ -p 2350:2350/tcp \ -p 2350:2350/udp \ -p 3450:3450/tcp \ - --name tm-server lduriez/tmserver + -v ./data/GameData:/opt/tmserver/GameData \ + --name tmserver tmserver: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 bec15ca..1b39711 100644 --- a/docs/schnellstart.md +++ b/docs/schnellstart.md @@ -2,55 +2,75 @@ ## Voraussetzungen -- Docker muss installiert sein +- Docker und Docker Compose müssen installiert sein -## Docker Image bauen +## 1. Umgebungsvariablen einrichten -Bevor der Server gestartet werden kann, muss das Docker Image gebaut werden. Führe dazu im Projektverzeichnis folgenden Befehl aus: +Kopiere die Vorlage und passe die Werte an: + +```bash +cp .env.example .env +``` + +Bearbeite die `.env`-Datei und setze mindestens die gewünschten Passwörter. Für den Internet-Modus müssen zusätzlich `SERVER_LOGIN` und `SERVER_VALIDATION_KEY` gesetzt werden. + +> **Wichtig:** Die `.env`-Datei enthält sensible Daten (Passwörter, Keys) und wird über die `.gitignore` vom Einchecken ausgeschlossen. + +## 2. Docker Image bauen ```bash 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`. Das Tag `latest` verweist immer auf die aktuelle Version, während `1.0.0` eine feste Versionskennung darstellt. +Damit wird das Image mit zwei Tags erstellt: `tmserver:latest` und `tmserver:1.0.0`. -> **Hinweis:** In den folgenden `docker run`-Beispielen muss der Image-Name entsprechend durch `tmserver:latest` oder `tmserver:1.0.0` ersetzt werden. +## 3. Server starten -## Internet-Dedicated-Modus (Standard) +### Mit Docker Compose (empfohlen) + +```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. ```bash docker run -d \ + --env-file .env \ -p 2350:2350/tcp \ -p 2350:2350/udp \ -p 3450:3450/tcp \ -p 80:80/tcp \ - -e SERVER_LOGIN=dein_login \ - -e SERVER_VALIDATION_KEY=dein_key \ - --name tm-server lduriez/tmserver + -v ./data/GameData:/opt/tmserver/GameData \ + --name tmserver tmserver:latest ``` -## LAN-Modus +### LAN-Modus (docker run) -Für den LAN-Modus werden keine Masterserver-Zugangsdaten benötigt: +Setze in der `.env`-Datei `SERVER_MODE=lan` oder übergib es direkt: ```bash docker run -d \ + --env-file .env \ + -e SERVER_MODE=lan \ -p 2350:2350/tcp \ -p 2350:2350/udp \ -p 3450:3450/tcp \ -p 80:80/tcp \ - -e SERVER_MODE=lan \ - --name tm-server lduriez/tmserver + -v ./data/GameData:/opt/tmserver/GameData \ + --name tmserver tmserver:latest ``` -## Docker Compose +## 4. AdminServ öffnen -Alternativ kann der Server mit Docker Compose gestartet werden: +Die Verwaltungsoberfläche ist unter `http://` erreichbar. Weitere Details unter [AdminServ](adminserv.md). -```bash -docker compose up -d -``` +## Persistente Konfiguration -Passe dazu die Werte in der `docker-compose.yml` an. Weitere Details unter [Umgebungsvariablen](umgebungsvariablen.md). +Die gesamten Server-Daten (`GameData/`) werden über einen Bind-Mount (`./data/GameData`) persistent auf dem Host gespeichert. Beim ersten Start wird das gesamte GameData-Verzeichnis automatisch aus dem Image erzeugt und die Umgebungsvariablen aus der `.env`-Datei angewendet. Bei weiteren Starts bleibt alles erhalten. + +Weitere Details unter [Konfiguration](konfiguration.md). diff --git a/docs/server-modi.md b/docs/server-modi.md index 420c6af..af3eb2d 100644 --- a/docs/server-modi.md +++ b/docs/server-modi.md @@ -13,11 +13,13 @@ Im Internet-Modus ist der Server über das Trackmania-Masterserver-Netzwerk erre ### Konfiguration -```yaml -environment: - - SERVER_MODE=internet - - SERVER_LOGIN=dein_login - - SERVER_VALIDATION_KEY=dein_key +In der `.env`-Datei: + +```bash +SERVER_MODE=internet +SERVER_LOGIN=dein_login +SERVER_LOGIN_PASSWORD=dein_passwort +SERVER_VALIDATION_KEY=dein_key ``` Wenn `SERVER_LOGIN` oder `SERVER_VALIDATION_KEY` nicht gesetzt sind, bricht der Server mit einer Fehlermeldung ab. @@ -35,19 +37,22 @@ Im LAN-Modus ist der Server nur im lokalen Netzwerk erreichbar. Es werden keine ### Konfiguration -```yaml -environment: - - SERVER_MODE=lan +In der `.env`-Datei: + +```bash +SERVER_MODE=lan ``` Oder per Docker-Run: ```bash docker run -d \ + --env-file .env \ -e SERVER_MODE=lan \ -p 2350:2350/tcp \ -p 2350:2350/udp \ -p 3450:3450/tcp \ -p 80:80/tcp \ - --name tm-server lduriez/tmserver + -v ./data/GameData:/opt/tmserver/GameData \ + --name tmserver tmserver:latest ``` diff --git a/docs/umgebungsvariablen.md b/docs/umgebungsvariablen.md index d2d32e4..c39b3ac 100644 --- a/docs/umgebungsvariablen.md +++ b/docs/umgebungsvariablen.md @@ -1,40 +1,105 @@ # Umgebungsvariablen -Alle Umgebungsvariablen können beim Start des Containers über `-e` oder in der `docker-compose.yml` gesetzt werden. +Alle Umgebungsvariablen werden über die `.env`-Datei konfiguriert, die von `docker-compose.yml` automatisch eingelesen wird. Alternativ können sie beim `docker run` über `--env-file .env` oder einzeln mit `-e` gesetzt werden. -## Allgemeine Einstellungen +Die Variablen werden beim **ersten Start** (leeres GameData-Volume) in die `dedicated_cfg.txt` eingetragen. Bei weiteren Starts bleiben manuelle Änderungen erhalten. Siehe [Konfiguration](konfiguration.md) für Details. + +> **Sicherheitshinweis:** Sensible Werte (Passwörter, Keys) sind **nicht** im Docker-Image hinterlegt. Sie werden ausschließlich zur Laufzeit über die `.env`-Datei übergeben. Die `.env`-Datei ist über `.gitignore` und `.dockerignore` geschützt und wird weder ins Git noch in den Docker-Build-Context aufgenommen. + +## Einrichtung + +```bash +# Vorlage kopieren +cp .env.example .env + +# Werte anpassen +nano .env +``` + +## Authentifizierung | Variable | Beschreibung | Standard | |----------|-------------|----------| -| `SERVER_NAME` | Name des Servers | `Trackmania Server` | -| `SERVER_DESC` | Beschreibung des Servers | `This is a Trackmania Server` | -| `SERVER_SA_PASSWORD` | SuperAdmin-Verwaltungspasswort | `SuperAdmin` | -| `SERVER_ADM_PASSWORD` | Admin-Verwaltungspasswort | `Admin` | +| `SERVER_SA_PASSWORD` | SuperAdmin-Passwort | `SuperAdmin` | +| `SERVER_ADM_PASSWORD` | Admin-Passwort | `Admin` | +| `SERVER_USER_PASSWORD` | User-Passwort | `User` | -## Server-Modus +## Masterserver-Account + +| Variable | Beschreibung | Standard | +|----------|-------------|----------| +| `SERVER_LOGIN` | Masterserver-Login (nur Internet-Modus) | *(leer)* | +| `SERVER_LOGIN_PASSWORD` | Masterserver-Passwort | *(leer)* | +| `SERVER_VALIDATION_KEY` | Masterserver-Validierungsschlüssel | *(leer)* | + +> **Wichtig:** Im Internet-Modus müssen `SERVER_LOGIN` und `SERVER_VALIDATION_KEY` gesetzt sein, andernfalls startet der Server nicht. + +## Server-Optionen + +| Variable | Beschreibung | Standard | +|----------|-------------|----------| +| `SERVER_NAME` | Servername (im Spiel sichtbar) | `Trackmania Server` | +| `SERVER_DESC` | Serverbeschreibung | `Powered by tmserver-docker` | +| `SERVER_HIDE` | Server verstecken (`0` = sichtbar, `1` = versteckt, `2` = vor Nations versteckt) | `0` | +| `SERVER_MAX_PLAYERS` | Maximale Spieleranzahl | `32` | +| `SERVER_PASSWORD` | Passwort zum Beitreten (leer = offen) | *(leer)* | +| `SERVER_MAX_SPECTATORS` | Maximale Zuschaueranzahl | `32` | +| `SERVER_SPEC_PASSWORD` | Zuschauer-Passwort (leer = offen) | *(leer)* | +| `SERVER_LADDER_MODE` | Ladder-Modus (`inactive` oder `forced`) | `forced` | + +## Netzwerk + +| Variable | Beschreibung | Standard | +|----------|-------------|----------| +| `SERVER_PORT` | Gameserver-Port | `2350` | +| `SERVER_P2P_PORT` | P2P-Port | `3450` | +| `SERVER_XMLRPC_PORT` | XML-RPC-Port (intern für AdminServ) | `5000` | +| `SERVER_UPLOAD_RATE` | Upload-Rate in Kbps | `512` | +| `SERVER_DOWNLOAD_RATE` | Download-Rate in Kbps | `8192` | + +## Server-Modus & Steuerung | Variable | Beschreibung | Standard | |----------|-------------|----------| | `SERVER_MODE` | Server-Modus (`internet` oder `lan`) | `internet` | -| `SERVER_LOGIN` | Masterserver-Login (nur Internet-Modus) | *(leer)* | -| `SERVER_VALIDATION_KEY` | Masterserver-Validierungsschlüssel (nur Internet-Modus) | *(leer)* | +| `FORCE_CONFIG_UPDATE` | Erzwingt erneutes Anwenden aller Umgebungsvariablen auf die Config | `false` | -> **Wichtig:** Im Internet-Modus müssen `SERVER_LOGIN` und `SERVER_VALIDATION_KEY` gesetzt sein, andernfalls startet der Server nicht. +> **Hinweis:** Bei `FORCE_CONFIG_UPDATE=true` wird die `dedicated_cfg.txt` aus dem Template neu erzeugt und alle Platzhalter mit den aktuellen Umgebungsvariablen ersetzt. Manuelle Änderungen gehen dabei verloren! Nach dem Update sollte `FORCE_CONFIG_UPDATE` wieder auf `false` gesetzt werden. ## Beispiel +### Docker Compose (empfohlen) + +Passe die Werte in der `.env`-Datei an und starte mit: + +```bash +docker compose up -d --build +``` + +### docker run + ```bash docker run -d \ - -e SERVER_NAME="Mein Server" \ - -e SERVER_DESC="Ein toller Server" \ - -e SERVER_SA_PASSWORD="GeheimSA" \ - -e SERVER_ADM_PASSWORD="GeheimAdmin" \ - -e SERVER_MODE=internet \ - -e SERVER_LOGIN=mein_login \ - -e SERVER_VALIDATION_KEY=mein_key \ + --env-file .env \ -p 2350:2350/tcp \ -p 2350:2350/udp \ -p 3450:3450/tcp \ -p 80:80/tcp \ - --name tm-server lduriez/tmserver + -v ./data/GameData:/opt/tmserver/GameData \ + --name tmserver tmserver:latest +``` + +Einzelne Werte können zusätzlich überschrieben werden: + +```bash +docker run -d \ + --env-file .env \ + -e SERVER_NAME="Mein Server" \ + -e SERVER_MAX_PLAYERS=64 \ + -p 2350:2350/tcp \ + -p 2350:2350/udp \ + -p 3450:3450/tcp \ + -p 80:80/tcp \ + -v ./data/GameData:/opt/tmserver/GameData \ + --name tmserver tmserver:latest ```