版权信息

# 版权所有 (C) 2016-2022 phantombot.github.io/PhantomBot
#
# 本程序为自由软件：您可以根据GNU通用公共许可证（由自由软件基金会发布，版本3或更高版本）的条款重新分发和/或修改它。
#
# 本程序的分发旨在希望它有用，但不提供任何明示或暗示的担保，包括但不限于适销性或特定用途适用性的担保。详情请参阅GNU通用公共许可证。
#
# 您应已收到本程序附带的GNU通用公共许可证。如果没有，请参阅<[***]>。

PhantomBot稳定版镜像说明

PhantomBot稳定版构建镜像，用于部署***等平台的聊天机器人服务。支持通过Docker Compose快速部署，具备数据持久化、自动重启、Web管理面板等特性，适用于需要稳定运行聊天机器人的场景。

Docker Compose部署方案

以下是使用Docker Compose部署PhantomBot稳定版的配置示例：

yaml
# Compose规范版本，请勿修改
version: '3.2'
services:
  # 服务名称，供Docker Compose内部使用，可修改
  phantombot:
    # 容器名称，将显示在Docker命令输出、Docker Desktop等工具中
    # 若运行多个机器人实例，应修改此名称以区分
    container_name: phantombot
    # 拉取的镜像，创建容器时自动选择最新版本
    image: gmt2001/phantombot-stable
    # 端口映射：使面板端口可被主机及互联网（取决于防火墙设置）访问
    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个变量为首次运行必填项
      PHANTOMBOT_USER: ""  # ***机器人用户名（必填）
      PHANTOMBOT_CHANNEL: ""  # ***主播频道（必填）
      PHANTOMBOT_PANELUSER: ""  # Web界面用户名（必填）
      PHANTOMBOT_PANELPASSWORD: ""  # Web界面密码（必填）
      # 启用面板重启按钮
      PHANTOMBOT_RESTARTCMD: "/opt/PhantomBot/restartbot-docker.sh"

volumes:
  # 推荐保留默认配置，由Docker管理卷及权限
  # 如需挂载到宿主机目录，可在冒号后添加路径
  PhantomBot_data:

配置项说明

• 端口映射：容器内固定使用25000端口，宿主机发布端口可根据需求修改（多实例时需调整）。
• 数据持久化：通过PhantomBot_data卷实现容器内数据持久化，确保重启后配置不丢失。
• 环境变量：首次运行需设置PHANTOMBOT_USER（机器人用户名）、PHANTOMBOT_CHANNEL（主播频道）、PHANTOMBOT_PANELUSER（面板用户名）、PHANTOMBOT_PANELPASSWORD（面板密码）等必填项；PHANTOMBOT_RESTARTCMD用于启用面板重启功能。
• 重启策略：建议设置为"unless-stopped"或"always"，以保障服务稳定性。