luxusburg/docker-foundry

Foundry专用服务器Docker容器 🏭

!GitHub last commit

此Docker容器简化了自建Foundry专用服务器的过程。🚀 已在Linux（Ubuntu/Debian）系统上测试并确认可用。🐧 欢迎提供改进建议和贡献！🤝

📜 目录

• ✨ 特性
• ✅ 前提条件
• 🚀 快速开始
  • 🐳 使用docker run
  • 🏗️ 使用docker-compose
• ⚙️ 服务器配置
  • 🗂️ 卷
• 💾 备份与恢复
• 🧩 启用与管理Mod
• 🔧 环境变量
  • 🎮 游戏设置
  • 🗳️ 备份设置
  • 👤 用户PUID/PGID
  • 🧪 Beta分支
• 💖 贡献

✨ 特性

• 💨 Foundry专用服务器的简易搭建。
• 🔄 容器启动时自动更新游戏服务器。
• 🔧 通过环境变量进行配置。
• 💾 内置备份与恢复功能。
• 🧩 Mod支持。
• 🧪 支持游戏Beta分支。

✅ 前提条件

• 系统已安装Docker。
• Docker Compose（用于docker-compose方法）。
• 基本Docker概念理解（卷、端口等）。

🚀 快速开始

建议在运行命令前，在主机上创建专用目录存储服务器数据和配置。例如：

bash
mkdir ~/foundry-server
cd ~/foundry-server

以下示例将当前工作目录中的./server（游戏文件）和./data（持久化数据，如存档和备份）映射到容器。

🐳 使用docker run

bash
docker run -d \
    --name foundry-server \
    -p 3724:3724/udp \
    -p 27015:27015/udp \
    -v ./server:/home/foundry/server_files \
    -v ./data:/home/foundry/persistent_data \
    -e TZ="Europe/Paris" \
    -e SERVER_NAME=Foundry Docker by Luxusburg \
    -e SERVER_PWD=change_me \
    -e PAUSE_SERVER_WHEN_EMPTY=false \
    -e MAX_TRANSFER_RATE=8192 \
    luxusburg/docker-foundry:latest

🏗️ 使用docker-compose

创建docker-compose.yml文件：

yaml
# version: '3.8' # 如果Docker Compose版本需要，请取消注释
services:
  foundry:
    container_name: foundry-server
    image: luxusburg/docker-foundry:latest
    network_mode: bridge # 或根据偏好使用'host'，并相应调整端口
    environment:
      - TZ=Europe/Paris
      - WORLD_NAME='worldname'
      - SERVER_PWD=change_me_strong_password
      - SERVER_NAME=Foundry Docker - by Luxusburg
      - SERVER_MAX_PLAYERS=10
      - SERVER_IS_PUBLIC=true
      - PAUSE_SERVER_WHEN_EMPTY=false
      - AUTOSAVE_INTERVAL=300
      - MAX_TRANSFER_RATE=8192
      - CUSTOM_CONFIG=false # 设置为true以使用自定义app.cfg
      # 备份设置
      - BACKUPS=true
      - BACKUP_INTERVAL=0 * * * * # 每小时第0分钟
      - BACKUP_RETENTION=3 # 保留超过X天的备份
      # Mod设置
      # - ENABLE_MODS=true # 取消注释以启用Mod
      # PUID/PGID设置
      # - PUID=1000
      # - PGID=1000
    volumes:
      - ./server:/home/foundry/server_files:rw
      - ./data:/home/foundry/persistent_data:rw
    ports:
      - "3724:3724/udp"
      - "27015:27015/udp" # 仅当SERVER_IS_PUBLIC=true时需要
    restart: unless-stopped

然后运行：

bash
docker compose up -d

⚙️ 服务器配置

🗂️ 卷

• /home/foundry/server_files（例如主机上的./server）：存储游戏文件、app.cfg和Mod数据。
• /home/foundry/persistent_data（例如主机上的./data）：存储世界存档和备份。

[!TIP] 首次运行后，可通过编辑服务器文件卷中的app.cfg文件（例如./server/app.cfg）自定义服务器设置。 或者使用环境变量。若需完全自定义app.cfg，设置CUSTOM_CONFIG=true并确保app.cfg已存在于服务器文件目录中。 有关所有可能的app.cfg设置，请参考官方开发者文档：Foundry Dedicated Server Docs

💾 备份与恢复

默认启用备份功能，备份文件存储在持久化数据卷的backup子文件夹中（例如./data/backup/）。

恢复备份步骤：

1. 停止Foundry服务器容器：

bash
docker stop foundry-server
# 或使用docker-compose
docker compose down

[!IMPORTANT] ❗ 以下命令将覆盖当前世界存档文件！如可能需要当前世界数据，请确保另行备份。

2. 将所需备份归档文件提取到持久化数据目录。替换示例中的your_persistent_data_path（如./data）和备份文件名：

bash
# 示例：
tar -xzvf ./data/backup/foundry-backup-YYYY-MM-DD_HH-MM-SS.tar.gz -C ./data/

此操作将把存档文件夹恢复到./data/中 3. 重启容器

🧩 启用与管理Mod

1. 启用Mod支持

在Docker配置中设置环境变量ENABLE_MODS=true。

3. Mod列表文件（至关重要！）

• 启用Mod时，服务器需要modList.json文件存在于服务器文件卷的Mods文件夹中（例如./server/Mods/modList.json）才能正常启动。
• 此文件通常由Foundry游戏客户端生成，包含已订阅的Mod及其配置。需将此文件从客户端（Windows通常位于C:\Program Files (x86)\Steam\steamapps\common\FOUNDRY\Mods\modList.json）复制到服务器的Mod目录。

Mod更新

当ENABLE_MODS=true时，服务器会在每次启动时尝试检查并下载/更新已订阅的Mod。🔄

文件位置（相对于映射的卷）

• Mod存储： your_server_files_volume/Mods/（例如./server/Mods/）
• Mod配置： your_data_volume/mod_settings/（例如./data/mod_settings/）

🔧 环境变量

容器通过环境变量进行配置。

🎮 游戏设置

🗳️ 备份设置

[!WARNING]
BACKUP_INTERVAL的值不要使用双引号（""）或单引号（''）包裹cron计划表达式。

👤 用户PUID/PGID

这些变量用于设置容器内foundry用户的用户ID和组ID，有助于管理挂载卷上的文件权限。

在Linux上，可使用命令id $(whoami)查看当前用户的ID。

🧪 Beta分支

要使用游戏的Beta分支：

[!WARNING] 不要 在Beta名称或密码周围使用双引号（""）或单引号（''）。

💖 贡献

欢迎提供反馈、错误报告和拉取请求！请在https://github.com/luxusburg/docker-foundry%E4%B8%8A%E6%8F%90%E4%BA%A4issue%E6%88%96PR%E3%80%82