gmt2001/phantombot-nightly

PhantomBot Nightly Build Docker镜像文档

镜像概述

PhantomBot Nightly Build是PhantomBot的夜间构建版本Docker镜像，专为部署机器人设计。该镜像支持通过Docker Compose实现快速部署，提供数据持久化存储、Web管理面板访问及自动重启等核心功能，适用于需要使用PhantomBot最新功能的机器人部署场景。

核心功能与特性

• Docker Compose支持：提供完整的docker-compose.yml配置示例，简化部署流程
• 数据持久化：通过Docker卷实现数据持久化存储，确保配置和运行数据不丢失
• Web管理面板：默认暴露25000端口用于Web面板访问，支持面板管理和配置
• 灵活端口映射：支持容器内端口与主机端口映射，便于多实例部署
• 自动重启策略：支持"always"或"unless-stopped"重启策略，确保服务持续运行
• 环境变量配置：通过环境变量设置关键参数（如***用户、频道、面板 credentials等）
• 面板重启支持：集成重启脚本，支持通过Web面板一键重启机器人

使用场景与适用范围

• 需要部署***机器人并使用最新功能的用户
• 希望通过Docker简化部署和管理流程的开发者或管理员
• 需在单台服务器上部署多个PhantomBot实例的场景
• 对服务稳定性有要求，需要自动重启机制的生产环境

使用方法与配置说明

Docker Compose配置示例

以下是完整的docker-compose.yml配置文件：

yaml
# Compose规范版本，请勿修改
version: '3.2'
services:
  # 服务名称，Docker Compose内部使用，可修改但无实际影响
  phantombot:
    # 容器名称，将显示在Docker命令输出、Docker Desktop、Portainer等工具中
    # 若运行多个机器人实例，应修改此名称以区分不同实例
    container_name: phantombot
    # 镜像名称，创建容器时自动拉取最新版本
    image: gmt2001/phantombot-nightly
    # 端口映射配置，使Web面板可被主机及互联网访问（需防火墙允许）
    ports:
      - target: 25000      # 容器内机器人Web服务器监听端口，请勿修改
        published: 25000   # 主机上发布的端口，多实例部署时应修改此值
        protocol: tcp      # HTTP使用的TCP协议，请勿修改
    # 重启策略：推荐使用"always"或"unless-stopped"，以支持面板重启按钮
    # "unless-stopped"：容器自动重启；若通过Docker命令停止，需手动启动
    # "always"：容器始终自动重启；即使通过Docker命令停止，Docker服务或服务器重启后仍会自动启动
    restart: always
    volumes:
      # 数据持久化卷挂载配置，请勿修改
      - PhantomBot_data:/opt/PhantomBot_data
    environment:
      # ------ 在此设置botlogin.txt中的任何变量，前缀为PHANTOMBOT_
      # ------ 注意：首次运行后，botlogin.txt中的配置将优先生效
      # ------ 以下4个变量为首次运行必填项，需设置有效值
      # Twitch机器人用户名（必填）
      PHANTOMBOT_USER: ""
      # Twitch主播频道（必填）
      PHANTOMBOT_CHANNEL: ""
      # Web面板用户名（必填）
      PHANTOMBOT_PANELUSER: ""
      # Web面板密码（必填）
      PHANTOMBOT_PANELPASSWORD: ""
      # 启用面板中的重启按钮
      PHANTOMBOT_RESTARTCMD: "/opt/PhantomBot/restartbot-docker.sh"

volumes:
  # 建议保持默认配置（冒号后无内容）
  # 让Docker管理数据卷及权限，确保功能正常
  # 若需挂载到主机目录，可在冒号后添加主机路径
  PhantomBot_data:

关键配置说明

1. 端口映射

• target: 25000：容器内Web服务器监听端口，请勿修改
• published: 25000：主机上暴露的访问端口，多实例部署时需修改此值以避免冲突
• protocol: tcp：HTTP协议，请勿修改

2. 重启策略

• restart: always：始终自动重启，即使手动停止后Docker服务重启也会恢复
• restart: unless-stopped：自动重启，但手动停止后需手动启动

3. 数据卷

• PhantomBot_data:/opt/PhantomBot_data：Docker管理的数据卷，用于持久化存储机器人配置和运行数据
• 默认配置下Docker会自动管理卷及权限，如需挂载主机目录，可修改为PhantomBot_data:/path/on/host（需确保主机目录权限正确）

4. 环境变量

注意：首次运行后，botlogin.txt文件中的配置将优先于环境变量

部署步骤

1. 创建docker-compose.yml文件，复制上述配置并填写必填环境变量
2. 在终端中进入配置文件所在目录，执行以下命令启动服务：

   bash
   docker-compose up -d
   

3. 通过http://主机IP:25000访问Web管理面板
4. 使用配置的PHANTOMBOT_PANELUSER和PHANTOMBOT_PANELPASSWORD登录面板进行后续配置

多实例部署注意事项

• 修改container_name为唯一名称（如phantombot_instance1）
• 调整published端口值（如25001、25002等）避免冲突
• 确保数据卷名称唯一（如PhantomBot_data_instance1）