FiveM Server Git: Was zu commiten ist, .gitignore und Git Pull Deploys

Ein Server, das nur auf einer Festplatte lebt, hat keine Geschichte: Eine schlechte Bearbeitung am Freitag Abend kann nicht rückgängig gemacht werden, und das Verschieben von Maschinen bedeutet das Kopieren von Ordnern von Hand. Wenn man es unter Git stellt, behebt beides. Diese Anleitung zeigt, was zu commiten ist, die .gitignore zu verwenden, wie man Geheimnisse heraushält, und wie man mit git pull bereitgestellt wird.

#Was ins Repository geht

Commite die Dinge, die du schreibst oder konfigurierst:

• Deine Resources (der resources/ Ordner, einschließlich Config und SQL-Dateien).
• Ein server.cfg ohne Geheimnisse.
• Kleine Helfer-Dateien, wie eine README mit der Start-up-Reihenfolge.

Commite nicht generierte oder private Dateien:

• cache/, das FiveM neuaufbaut. Siehe Leere den FiveM Cache.
• Der txAdmin Daten-Ordner (txData), mit seinen Einstellungen, Admin-Konten und Logs.
• Geheimnisse: der Lizenzschlüssel, das Datenbank-Passwort und API-Schlüssel.
• Logs, Crash-Dumps und node_modules.

#Ein anfängliches .gitignore

An der Wurzel des Repository (der Server-Daten-Ordner, der resources/ und server.cfg enthält):

cache/
txData/
*.log
*.dmp
node_modules/
secrets.cfg
.env

Wenn du den ganzen txAdmin-Ordner absichtlich versionierst, entferne txData/ aus der Liste, aber behalte ihn privat und weg aus jedem geteilten Repository. Große binäre Assets (gestreamte Autos, MLOs) machen ein Repository groß; erwäge, ob sie überhaupt in Git sein sollten oder in einem separaten Speicher behalten.

#Halte Schlüssel aus server.cfg

Dies ist der Teil, der am häufigsten schiefgeht. Diese Zeilen sind Geheimnisse:

sv_licenseKey cfxk_xxxxxxxxxxxx
set mysql_connection_string "mysql://user:password@localhost/fivem"
set steam_webApiKey "xxxxxxxx"
rcon_password "xxxxxxxx"

Verschiebe sie in eine separate Datei, secrets.cfg, die in .gitignore ist:

# secrets.cfg  (never committed)
sv_licenseKey cfxk_xxxxxxxxxxxx
set mysql_connection_string "mysql://user:password@localhost/fivem"
set steam_webApiKey "xxxxxxxx"

Und lade es am Anfang des committed server.cfg:

exec secrets.cfg

endpoint_add_tcp "0.0.0.0:30120"
endpoint_add_udp "0.0.0.0:30120"
sv_hostname "My Server"

ensure oxmysql
ensure ox_lib

Commite ein secrets.cfg.example mit leeren Werten, damit die nächste Person weiß, was zu füllen. Siehe server.cfg erklärt für die Einstellungen selbst.

Achtung: Wenn ein Schlüssel jemals committed wurde, ist das Löschen in einem späteren Commit nicht genug. Es ist immer noch in der Geschichte. Generiere einen neuen Schlüssel oder Passwort und behandle den alten als durchgesickert.

#Erstelle das Repository

cd /path/to/server-data
git init
git add .
git status

Lies die git status Liste, bevor du commitest und überprüfe, dass nichts aus der "nicht commiten" Liste gestellt ist. Dann:

git commit -m "Initial server"
git branch -M main
git remote add origin [email protected]:youruser/your-server.git
git push -u origin main

Nutze ein privates Repository. Bezahlte Resources sind dir lizenziert, und das Setzen in ein öffentliches Repository ist Weitergabe, auch wenn der Code verschlüsselt ist. Siehe escrow Mangel Berechtigung für wie verschlüsselte Assets an deinen Account gebunden sind.

#Stelle mit Git Pull bereit

Auf der Maschine, die den Server ausführt, clone einmal und pull danach:

git clone [email protected]:youruser/your-server.git server-data
cd server-data
# create secrets.cfg on this machine (not from git)

Um nach einem Push von deinem Entwicklungs-PC zu aktualisieren:

cd server-data
git pull

Dann lade das Geänderte neu. Für eine einzelne Resource, von der Server-Konsole:

refresh
restart my_resource

Wenn server.cfg oder eine Start-up-Reihenfolge geändert, plane einen vollständigen Neustart (siehe geplante Neustarts). Mache nicht git pull in der Mitte von Spitzenstunden ohne Plan, da viele Ressourcen, die auf einmal neu starten, den Server spitzen können.

Für Authentifizierung auf einem privaten Repository, nutze einen SSH Deploy-Schlüssel mit nur Read-Zugriff oder einen persönlichen Zugriffs-Token. Gib niemals dein eigenes Passwort in Skripte ein.

#Eine einfache Branch-Gewohnheit

Behalte main als das, was Live ist. Mache Änderungen auf einem Branch, teste auf einem lokalen oder Staging-Server, dann merge:

git checkout -b new-police-job
# edit, test
git commit -am "Add police job"
git checkout main
git merge new-police-job
git push

Wenn etwas nach einem Pull bricht, zeigt git log, was sich geändert hat, und git revert <commit> macht es rückgängig, ohne Geschichte zu verlieren. Git ist keine Sicherung der Datenbank: Behalte echte Sicherungen auch, wie in sicher deinen FiveM Server.

#Checkliste