daevien/phantombot

Phantombot Docker镜像

镜像概述和主要用途

本镜像为Phantombot的Docker容器化实现，基于Alpine Linux构建。最初从https://github.com/SleepyMario/phantombot-docker分叉，修复了控制台 spam 问题（通过运行launch-service.sh替代launch.sh），并针对3.2.0版本进行了大量修改，wrapper.sh基于https://github.com/aldovc/phantombot的代码实现。适用于在Docker环境中部署Phantombot，实现直播平台（如***）的互动管理、自动回复、第三方服务集成等功能。

核心功能和特性

• 轻量基础：基于Alpine Linux，资源占用低
• 配置持久化：设置在重启后保持，需挂载配置目录
• 自动备份：每24小时自动备份（默认时间为2:37 AM）
• 多版本支持：包含稳定版和nightly构建（nightly镜像每24小时更新）
• 功能完整：支持Phantombot全部核心功能，可通过环境变量或配置文件自定义参数

使用场景和适用范围

适用于需要在Docker环境中部署Phantombot的用户，特别是主播，用于管理直播互动（如自动回复、命令执行）、音乐播放控制、第三方服务集成（、***、Streamlabs等），以及通过Web面板进行远程管理。

使用方法和配置说明

首次运行（无现有配置）

首次运行需以交互式方式生成初始配置：

bash
docker run -it -v /realpath:/phantombot/config -v /etc/localtime:/etc/localtime:ro --net=host daevien/phantombot

• /realpath：本地目录，用于持久化存储配置文件
• -v /etc/localtime:/etc/localtime:ro：同步容器与主机时区

Docker Compose配置示例（已有配置）

当配置文件已存在时，可使用docker-compose.yml部署：

yaml
version: "3.7"

services:
    phantombot-ghostofsilverhand:
      container_name: ghostofsilverhand
      volumes:
        - '/docker/pb/ghostofsilverhand:/phantombot/config'  # 配置目录挂载
        - '/etc/localtime:/etc/localtime:ro'  # 时区同步
      environment:
        - APIOAUTH=data_goes_here  # Twitch API OAuth密钥
        - BASEPORT=25000  # 起始端口
        - CHANNEL=owner  # 登录的Twitch频道
        - OWNER=owner  # 主播名称
        - MSGLIMIT30=19.0  # 30秒内消息发送限制
        - MUSICENABLE=true  # 是否启用音乐播放器
        - OAUTH=data_goes_here  # Twitch IRC OAuth令牌
        - PANELPASSWORD=password  # 控制面板密码
        - PANELUSER=username  # 控制面板用户名
        - USEHTTPS=false  # 是否启用HTTPS
        - USER=botname  # 机器人名称
        - WEBAUTH=data_goes_here  # Web认证信息
        - WEBAUTHRO=data_goes_here  # Web只读认证信息
        - WEBENABLE=true  # 是否启用Web服务器
        - WHISPERLIMIT60=60.0  # 60秒内私信限制
        - YTAUTH=data_goes_here  # YouTube认证信息
        - YTAUTHRO=data_goes_here  # YouTube只读认证信息
      ports:
        - 25000:25000  # 主端口
        - 25003:25003  # Web面板端口
        - 25004:25004  # 音乐播放器端口
      image: 'daevien/phantombot'

分支选择

镜像提供多个分支，需明确指定：

• nightly：开发版，每24小时自动更新
• stable：最新稳定版（当前为3.0.0）
• 2.4.2：2.x系列最新稳定版

注意：不要使用latest标签，可能获取到非预期版本

通用运行命令

bash
docker run -it \ 
    -v /PATH/TO/BOT:/phantombot/config \  # 配置目录（必填）
    -v /PATH/TO/BACKUP/:/backup \  # 备份目录（可选）
    -v /etc/localtime:/etc/localtime:ro \  # 时区同步
    --net=host \  # 使用主机网络（或自行映射端口）
    daevien/phantombot[:branch]  # 指定分支，如daevien/phantombot:stable

• 需开放防火墙端口25000-25004以确保功能正常

配置参数说明（botlogin.txt参数）

以下为***环境下的核心配置参数，支持HTTPS、数据库、第三方服务等集成。布尔值通过true/false设置，详细说明见官方文档。

基本配置

• baseport：起始端口，默认25000
• owner：主播名称（必填）
• devcommands：调试命令开关，默认启用
• logtimezone：日志时区（如Asia/Shanghai）
• msglimit30：30秒内允许发送到***的消息数
• musicenable：是否启用***播放器Web界面
• panelpassword：控制面板及音乐播放器访问密码
• paneluser：控制面板及音乐播放器访问用户名
• twitch_tcp_nodelay：TCP无延迟（加快消息发送），默认启用
• usemessagequeue：消息队列（控制消息延迟），默认启用
• user：机器人名称（必填）
• web_enable：是否启用Web服务器
• whisperlimit60：60秒内私信限制（当前未使用）

HTTPS配置（配置指南）

• usehttps：启用HTTPS（需同时设置以下参数）
• httpsFileName：keystore.jks文件路径（容器内路径）
• httpsPassword：keystore.jks密码

数据存储配置

• datastore：存储类型（mysqlstore/inistore，默认SqlLite3）
• datastoreconfig：inistore/SQLite3的存储文件路径

MariaDB/MySQL配置（配置指南）

• mysqlhost：数据库主机名
• mysqlname：数据库名称
• mysqlpass：数据库用户密码
• mysqlport：数据库端口（非默认时设置）
• mysqluser：数据库用户名

***认证信息

• oauth：*** IRC OAuth令牌（从这里获取）
• apioauth：*** API OAuth密钥（从这里获取）
• channel：机器人登录的***频道名称

第三方服务集成

• *******：twitterUser、twitter_consumer_key、twitter_consumer_secret、twitter_access_token、twitter_secret_token（配置指南）
• Streamlabs：twitchalertskey（认证密钥）、twitchalertslimit（单次查询最大***数）（配置指南）
• *******：discord_token（***令牌）（配置指南）
• Gamewisp：gamewispauth（授权令牌）、gamewisprefresh（刷新令牌）（配置指南）
• *******：youtubekey（可选，内置默认值）