passivelemon/terraria-docker

terraria-docker 中文技术文档

镜像概述和主要用途

terraria-docker 是一个非官方的 Terraria 专用服务器 Docker 容器，支持原版 Terraria 和通过 tModLoader 加载的模组化服务器。该镜像提供了便捷的部署方式，使玩家能够快速搭建自己的 Terraria 服务器。

[!NOTE] 本项目与 Terraria 或 tModLoader 无任何关联。如有问题，请在此处报告。

核心功能和特性

• 支持原版 Terraria 服务器部署
• 支持通过 tModLoader 运行模组化服务器
• 环境变量配置服务器参数，无需手动编辑配置文件
• 持久化存储世界数据和配置文件
• 支持自定义模组包
• 支持Journey模式的各种世界设置
• 提供健康检查功能

使用场景和适用范围

• 希望快速搭建 Terraria 私人服务器的玩家
• 需要在同一服务器上管理多个世界的场景
• 希望运行带有模组的 Terraria 服务器
• 希望通过容器化方式简化服务器部署和管理的用户
• 个人玩家、小型游戏社区或朋友群体自建服务器

快速开始指南

原版服务器快速设置

1. 创建服务器文件目录。例如：Linux 系统可以使用 /opt/TerrariaServer/，Windows 系统可以使用 C:\TerrariaServer\。

2. 运行容器：（请根据需要修改参数值）

   docker
   docker run -d --name terraria -p 7777:7777/tcp -v /opt/TerrariaServer/:/opt/terraria/config/ -e WORLDNAME=myworld passivelemon/terraria-docker:terraria-latest
   

3. 配置服务器访问权限。

模组化服务器快速设置

1. 创建服务器文件目录。例如：Linux 系统可以使用 /opt/TerrariaServer/，Windows 系统可以使用 C:\TerrariaServer\。

2. 将模组包添加到上述目录的 ModPacks/ 子目录中（详见下方第3步）。

3. 运行容器：（请根据需要修改参数值）

   docker
   docker run -d --name tmodloader1.4 -p 7777:7777/tcp -v /opt/TerrariaServer/:/opt/terraria/config/ -e MODPACK=<模组包名称> -e WORLDNAME=myworld passivelemon/terraria-docker:tmodloader-latest
   

4. 配置服务器访问权限。

详细使用方法

1. 服务器文件设置

根据您的主机系统，选择合适的位置存储服务器文件。确保该位置为空、安全且可访问。例如：Windows 系统可使用 C:\TerrariaServer\，Linux 系统可使用 /opt/TerrariaServer/。

[!NOTE] 为方便说明，我们将此目录称为 <config_dir>。所有尖括号 <> 中的字段都需要您根据实际情况替换。

在 <config_dir> 中，创建一个名为 Worlds 的目录（名称必须完全一致），如果使用 tModLoader，还需创建 ModPacks 目录。此外，serverconfig.txt 文件（如果您想使用自定义配置）也将存储在此位置，详情见步骤4。

2. 服务器环境变量

对于您希望服务器使用的每个变量，通过 -e <变量>=<值> 添加到 docker run 命令或 compose 文件中。如果未设置，将使用默认值。

默认情况下，模组化服务器需要定义模组包才能成功运行。

服务器配置详情可参考 Terraria Wiki。

容器变量

服务器变量

旅途模式变量

所有旅途模式变量具有相同的选项，默认值均为 2。

3. Modpacks设置

如果不使用tModLoader，请跳过此步骤。

理想情况下，不应在服务器的modpack文件夹中包含任何仅客户端的模组。客户端模组仅影响客户端（玩家），不会为游戏添加新功能，包括不同的纹理、着色器、RPC等。即使包含这些模组也不会有什么问题，但这是最佳实践。模组包含在modpack文件夹中，因此无需手动获取。

1. 在客户端的tModLoader中，启用您想要使用的任何模组。
2. 进入模组包部分。
3. "将已启用的模组另存为新模组包"
4. "打开模组包文件夹"
5. 将要在服务器中使用的模组包文件夹复制并粘贴到 <config_dir>/ModPacks/ 中

确保模组包包含 enabled.json 文件以及您想要的模组，否则服务器将无法启动。

4. 世界(Worlds)设置

如果要继续使用现有世界，请按照此步骤操作。否则，只需跳过它。服务器将自动生成一个新的世界。

如果您提供世界文件并正确设置 WORLDNAME 变量，服务器将使用现有世界。如果使用tModLoader，请确保始终使用相同的modpack加载此世界，否则可能会遇到世界损坏。

1. 找到您的世界文件：
   • 原版世界通常位于 C:\Users\<user>\Documents\My Games\Terraria\Worlds\（Windows）或 /home/<user>/.local/share/Terraria/Worlds/（Linux）。
   • 模组化世界通常位于 C:\Users\<user>\Documents\My Games\Terraria\tModLoader\Worlds\（Windows）或 /home/<user>/.local/share/Terraria/tModLoader/Worlds/（Linux）。
2. 将您选择的世界文件复制到 <config_dir>/Worlds/。世界文件扩展名为 .wld，如果使用tModLoader，则为 .twld。

5. 服务器配置

如果要使用自己的服务器配置，请按照此步骤操作。否则，只需跳过它。服务器将根据您提供的环境变量自动生成配置。

容器中terraria服务器文件的根目录是 /opt/terraria/server/，<config_dir> 中的用户项目挂载在 /opt/terraria/config/。

1. 将 SERVERCONFIG 设置为1。
2. 将 serverconfig.txt 放入 <config_dir>。

服务器配置详情可参考 Terraria Wiki。

Docker部署方案

镜像标签

虽然稳定版可能没问题，但建议将服务器固定到特定版本，以避免潜在的存档损坏。

Terraria版本可在 https://github.com/PassiveLemon/terraria-docker/releases/ 查看。 tModLoader版本可在 https://github.com/tModLoader/tModLoader/releases/ 查看（不包含 v 前缀）。

Docker Run命令示例

原版服务器

bash
docker run -d --name terraria -p 7777:7777/tcp -v /opt/terrariaServer/:/opt/terraria/config/ -e WORLDNAME=myworld passivelemon/terraria-docker:terraria-latest

模组化服务器

bash
docker run -d --name tmodloader1.4 -p 7777:7777/tcp -v /opt/terrariaServer/:/opt/terraria/config/ -e MODPACK=my_modpack -e WORLDNAME=myworld passivelemon/terraria-docker:tmodloader-latest

Docker Compose配置示例

基础配置

yaml
services:
  terraria-docker:
    image: passivelemon/terraria-docker:terraria-latest
    container_name: terraria-docker
    ports:
      - 7777:7777
    volumes:
      - /opt/terrariaServer/:/opt/terraria/config/

带环境变量的配置

yaml
services:
  terraria-docker:
    image: passivelemon/terraria-docker:terraria-latest
    container_name: terraria-docker
    ports:
      - 7777:7777
    volumes:
      - /opt/terrariaServer/:/opt/terraria/config/
    environment:
      WORLDNAME: "myworld"
      MAXPLAYERS: 16
      PASSWORD: "mypassword"
      MOTD: "欢迎来到我的Terraria服务器"
      DIFFICULTY: 1

带健康检查的配置

yaml
services:
  terraria-docker:
    image: passivelemon/terraria-docker:terraria-latest
    container_name: terraria-docker
    ports:
      - 7777:7777
    volumes:
      - /opt/terrariaServer/:/opt/terraria/config/
    environment:
      WORLDNAME: "myworld"
      MAXPLAYERS: 16
    healthcheck:
      test: "nc -vz 127.0.0.1 7777 || exit 1" # 如果需要，将7777更改为内部服务器端口
      interval: 30s
      timeout: 5s
      start_period: 10s
      retries: 3

Docker命令参数说明

服务器访问设置

有几种方法可以实现：

• 完全通过LAN玩游戏。如果服务器和玩家在同一网络上，则可以使用服务器主机的本地IP。

• 通过***（如Tailscale、ZeroTier等）玩游戏。然后可以按照与LAN相同的逻辑操作。

• 通过域名或公共IP远程玩游戏。详见下文。

除非计划完全在本地或通过***玩游戏，否则需要进行端口转发，以便网络外部的玩家能够访问服务器。端口转发的一般思路是，当客户端向服务器发送请求（使用特定端口）时，正确设置的端口转发将允许请求通过并到达指定的主机。Terraria默认使用7777，但您可以在配置文件中更改此端口。

如果无法访问网络基础设施，则需要通过LAN或***玩游戏。

1. 通过在浏览器中输入网关IP访问路由器Web界面。可能是 192.168.1.1、172.1.0.1 或其他。这将根据网络设置而有所不同。

2. 找到端口转发部分。路由器管理软件可能会有所不同，但很可能就称为"端口转发"或在"NAT"选项卡下。 例如：对于PFsense，它在NAT下，称为端口转发。输入也可能看起来略有不同。如果不知道自己在做什么，请查阅软件制造商的手册以获取指导。

3. 设置外部或传入端口。这是玩家尝试加入服务器时将输入的端口。

4. 设置内部或传出端口。这是Docker将使用的端口。这是 -p 7777:7777 的第一部分。第二部分是容器端口。这是您放入服务器配置的内容（默认7777）。

5. 设置目标IP。这将是服务器/主机的IP。有很多方法可以找到它。在终端中：Windows使用 ipconfig。大多数Linux发行版使用 ip a 或 ifconfig 或类似命令。查找您的接口（无论是wifi还是有线），并找到您的IPV4地址。它可能看起来像 192.168.1.XXX 或 172.1.0.XXX。同样，可能会有所不同。

   • 如果主机没有静态本地IP地址，它最终可能会更改。如果发生这种情况，端口转发将不再起作用。研究如何在路由器上设置静态IP。

6. 找到您的公共IP地址。您可以访问 [whatismyip]([***]