ntr001/fivem

ntr001/fivem

该Docker镜像用于运行FiveM服务器——一款GTA5的modded多人游戏应用，同时集成https://github.com/tabarra/txAdmin（浏览器端服务器管理工具）。首次运行时，默认配置会生成在主机挂载的`/txData`或`/config`目录（取决于容器参数选择的运行模式）。若部署时未启用txAdmin，首次运行后需停止容器，在`server.cfg`中配置FiveM以满足用户需求。

概述

Docker Hub上现有其他FiveM镜像基于过时版本，因此本镜像旨在保持最新：关注FiveM官方Linux运行时仓库，更新至最新推荐版本，并实现监控和自动化CI/CD方案，支持自动更新工具（如ouroboros）。由于官方cfx-server-data仓库自2022年起未维护，本镜像使用持续维护的bitpredator fork版本。

核心功能

1. 基于最新推荐版本的FiveM服务器，集成txAdmin管理工具；
2. 支持txAdmin启用/禁用两种运行模式；
3. 灵活的环境变量配置（端口、服务器名称、Steam API密钥等）；
4. 持久化数据权限处理，解决主机与容器间的权限冲突；
5. 支持自动更新，保持镜像版本同步最新。

使用场景

• 搭建GTA5 FiveM多人游戏服务器；
• 需要浏览器端管理界面（txAdmin）的服务器部署；
• 无需txAdmin的轻量服务器部署；
• 配合CouchDB使用（通过提供的docker-compose脚本）。

配置说明

许可证密钥

运行服务器需自由获取的许可证密钥，需通过LICENSE_KEY环境变量声明。获取教程见此处。

部署示例

带txAdmin的FiveM

sh
docker run -d \
  --name FiveM \
  --restart=unless-stopped \
  -e LICENSE_KEY=<你的许可证密钥> \
  -p 30120:30120 \
  -p 30120:30120/udp \
  -p 40120:40120 \
  -v /volumes/fivem:/txData \
  -ti \
  docker.xuanyuan.run/ntr001/fivem

部署后，通过http://主机IP:40120访问txAdmin界面完成后续配置。

环境变量：

• SERVER_PROFILE：可选，服务器配置文件名称，默认default；
• TXADMIN_PORT：可选，txAdmin HTTP端口，默认40120。

不带txAdmin的FiveM

sh
docker run -d \
  --name FiveM \
  --restart=unless-stopped \
  -e TXADMIN_DISABLE=Y \
  -e LICENSE_KEY=<你的许可证密钥> \
  -p 30120:30120 \
  -p 30120:30120/udp \
  -v /volumes/fivem:/config \
  -ti \
  docker.xuanyuan.run/ntr001/fivem

环境变量：

• TXADMIN_DISABLE：必填，非空值禁用txAdmin；
• LICENSE_KEY：必填，服务器许可证密钥；
• RCON_PASSWORD：可选，RCON密码，默认随机生成；
• FIVEM_PORT：可选，FiveM端口（TCP/UDP），默认30120；
• SV_HOSTNAME：可选，服务器名称，默认Default；
• STEAM_WEBAPIKEY：可选，Steam API密钥（用于Steam认证）；
• ONESYNC：可选，值为on|legacy|off，默认on；
• ONESYNC_POPULATION：可选，值为true|false，默认true；
• GAME_BUILD：可选，客户端游戏版本，默认2545。

持久化数据权限处理

环境变量：

• PID：可选，容器内fivem用户的UID；
• PGID：可选，容器内fivem组的GID。

权限处理逻辑：

1. 若提供PID/PGID，入口脚本会创建文件/目录并设置对应权限；
2. 未提供且卷为空时，使用启动容器的用户权限；
3. 未提供且卷已存在时，基于现有目录权限评估PID/PGID，并调整所有持久化数据的权限。

示例（指定PID/PGID）：

sh
docker run -d \
  --name FiveM \
  --restart=unless-stopped \
  -e PID=1000 \
  -e PGID=1000 \
  -e LICENSE_KEY=<你的许可证密钥> \
  -p 30120:30120 \
  -p 30120:30120/udp \
  -v /volumes/fivem:/txData \
  -ti \
  docker.xuanyuan.run/ntr001/fivem

通过id username命令获取主机用户的UID/GID。

致谢

• 基于https://github.com/***项目；
• 感谢Andruida提供的持久化数据权限处理概念；
• 感谢tabarra维护txAdmin；
• 感谢bitpredator维护cfx-server-data fork。