felddy/foundryvtt

foundryvtt-docker

一个容器化的Foundry Virtual Tabletop服务器，让您能够在几分钟内启动并运行一个功能完整的虚拟桌面角色扮演游戏平台。这个Docker镜像设计安全、可靠、紧凑且易于使用，只需提供下载Foundry Virtual Tabletop发行版所需的凭据或URL即可。

前提条件

• 功能正常的Docker安装
• 一个FoundryVTT.com账户及已购买的软件许可证

运行方法

使用Docker和凭据运行

您可以使用以下命令启动Foundry Virtual Tabletop服务器。容器需要您的foundryvtt.com凭据来安装和授权服务器。

console
docker run \
  --env FOUNDRY_USERNAME='<您的用户名>' \
  --env FOUNDRY_PASSWORD='<您的密码>' \
  --publish 30000:30000/tcp \
  --volume <您的数据目录>:/data \
  felddy/foundryvtt:13

[!提示] 如果您使用bash或类似的shell，考虑在Docker命令前添加一个空格，以防止您的凭据被记录到shell历史列表中。参见：HISTCONTROL

使用Docker和临时URL运行

或者，您可以从Foundry网站的用户个人资料页面获取临时下载URL。

1. 导航到已购买软件许可证页面。
2. 将"操作系统"菜单项更改为"Node.js"。
3. 点击"🔗 Timed URL"按钮获取临时URL。
4. 使用以下命令启动Foundry Virtual Tabletop服务器：

console
docker run \
  --env FOUNDRY_RELEASE_URL='<临时URL>' \
  --publish 30000:30000/tcp \
  --volume <您的数据目录>:/data \
  felddy/foundryvtt:13

配置管理

配置选项通过环境变量指定。强烈建议使用docker compose或类似的容器编排工具来管理服务器配置。如下例所示的compose.yml文件是一种可靠的方式来启动和维护容器，同时记录其配置。

每次容器启动时，都会使用环境变量的值生成Foundry Virtual Tabletop所需的配置文件。这意味着在服务器配置GUI中所做的更改不会在容器重启之间保留。如果您想禁用这些配置文件的重新生成，请将CONTAINER_PRESERVE_CONFIG设置为true。

1. 创建一个类似于以下内容的compose.yml文件。提供您的凭据作为环境变量的值：

   yaml
   ---
   services:
     foundry:
       image: felddy/foundryvtt:13
       hostname: my_foundry_host
       volumes:
         - type: bind
           source: <您的数据目录>
           target: /data
       environment:
         - FOUNDRY_PASSWORD=<您的密码>
         - FOUNDRY_USERNAME=<您的用户名>
         - FOUNDRY_ADMIN_KEY=atropos
       ports:
         - target: 30000
           published: 30000
           protocol: tcp
   

2. 启动容器并后台运行：

   console
   docker compose up --detach
   

3. 通过以下地址访问Web应用程序： http://localhost:30000。

如果一切顺利，您将看到许可协议提示，然后需要输入通过FOUNDRY_ADMIN_KEY变量设置的"管理员访问密钥"。

使用密钥

此容器还支持通过Docker密钥传递敏感值。使用密钥传递凭据等敏感值比使用环境变量更安全。您的密钥json文件可以有任何名称。本示例使用secrets.json。无论您选择什么名称，都必须像下面的示例中那样将其目标设置为容器内的config.json。有关所有支持的密钥的表格，请参见下面的密钥部分。

1. 要使用密钥，请创建一个包含您要设置的值的secrets.json文件：

   json
   {
     "foundry_admin_key": "atropos",
     "foundry_password": "您的密码",
     "foundry_username": "您的用户名"
   }
   

2. 然后将密钥添加到您的compose.yml文件：

   yaml
   ---
   secrets:
     config_json:
       file: secrets.json
   
   services:
     foundry:
       image: felddy/foundryvtt:13
       hostname: my_foundry_host
       volumes:
         - type: bind
           source: <您的数据目录>
           target: /data
       environment:
       ports:
         - target: 30000
           published: 30000
           protocol: tcp
       secrets:
         - source: config_json
           target: config.json
   

更新容器

默认情况下，此容器中的Foundry"更新软件"选项卡是禁用的。要升级到新版本的Foundry，请拉取更新的镜像版本。

使用Docker Compose更新

1. 从Docker Hub拉取新镜像：

   console
   docker compose pull
   

2. 重新创建运行中的容器：

   console
   docker compose up --detach
   

使用Docker更新

1. 停止运行中的容器：

   console
   docker stop <容器ID>
   

2. 拉取新镜像：

   console
   docker pull felddy/foundryvtt:13
   

3. 按照上面的运行说明重新运行容器。

镜像标签

此容器的镜像使用语义化版本进行标记，与它们支持的Foundry Virtual Tabletop版本和构建保持一致。

[!提示] 建议用户使用主版本标签：:13。使用主版本标签将确保您获得与保存的数据兼容的最新软件版本，并防止意外升级到新的主版本。

有关所有支持的标签列表，请参见Docker Hub上的https://hub.docker.com/r/felddy/foundryvtt/tags%E3%80%82

卷

端口

此容器公开以下端口：

环境变量

必需变量组合

必须设置以下三种环境变量组合之一，以便容器定位和安装Foundry Virtual Tabletop发行版。尽管可以一起指定所有变量，但它们按以下优先级顺序进行评估：

1. FOUNDRY_RELEASE_URL，或
2. FOUNDRY_USERNAME和FOUNDRY_PASSWORD，或
3. CONTAINER_CACHE

凭据变量

注意： FOUNDRY_USERNAME和FOUNDRY_PASSWORD也可以通过使用密钥而不是环境变量来设置。

预签名URL变量

可选变量

Node.js变量

提供给容器的任何Node.js变量（NODE_*）都将传递给运行FoundryVTT的底层Node.js服务器。下面列出了一些特别有用的变量。