sogebot/release

sogebot Docker镜像文档

镜像概述和主要用途

sogebot Docker镜像是一个预配置的容器化解决方案，用于快速部署sogebot——一款功能丰富的聊天机器人与自动化工具。该镜像旨在简化部署流程，确保跨环境一致性，并提供灵活的配置选项，适用于***、***等主流聊天平台的自动化管理需求。

核心功能和特性

• 多平台兼容：支持***、***、***等主流聊天平台的集成
• 插件化架构：内置插件系统，支持功能扩展与自定义开发
• 自动化规则引擎：可配置自定义命令、定时任务及事件响应逻辑
• 数据持久化：支持用户数据、配置文件与日志的持久化存储
• 轻量级设计：基于Alpine Linux构建，资源占用低，启动速度快
• Web管理界面：提供直观的浏览器管理界面，简化配置流程

使用场景和适用范围

• 直播平台管理：主播用于自动回复观众消息、执行聊天 moderation、管理粉丝互动
• 社区运营：通过自定义命令实现投票、抽奖、积分系统等互动功能
• 内容创作者工具：自动化直播通知、日程提醒、观众数据统计
• 开发测试：快速搭建sogebot开发环境，验证自定义插件与配置

详细的使用方法和配置说明

前提条件

• Docker Engine 20.10+ 及 Docker Compose 2.0+
• 目标平台API访问凭证（如*** OAuth令牌、*** Bot令牌）
• 基础Docker命令操作能力

快速启动（docker run）

bash
docker run -d \
  --name sogebot \
  -p 2000:2000 \
  -e BOT_NAME="your_bot_name" \
  -e PLATFORM="twitch" \
  -e OAUTH_TOKEN="your_twitch_oauth_token" \
  -e CHANNEL="your_channel_name" \
  -v sogebot_data:/app/data \
  sogebot/sogebot:latest

参数说明

• -d：后台运行容器
• --name sogebot：指定容器名称
• -p 2000:2000：映射Web管理界面端口
• -e：设置环境变量（详见环境变量配置表）
• -v sogebot_data:/app/data：挂载数据持久化卷

Docker Compose配置

yaml
version: '3.8'

services:
  sogebot:
    image: sogebot/sogebot:latest
    container_name: sogebot
    restart: unless-stopped
    ports:
      - "2000:2000"
    environment:
      - BOT_NAME="my_sogebot"
      - PLATFORM="discord"
      - DISCORD_TOKEN="your_discord_token"
      - LOG_LEVEL="info"
      - DB_TYPE="sqlite"
      - TZ="Asia/Shanghai"
    volumes:
      - ./sogebot_data:/app/data
      - ./plugins:/app/plugins
    networks:
      - sogebot_network

networks:
  sogebot_network:
    driver: bridge

启动命令：docker-compose up -d

环境变量配置

数据持久化

核心数据目录/app/data包含：

• 配置文件（config.json）
• 数据库文件（SQLite默认路径）
• 日志文件（logs/）
• 插件配置（plugins/）

推荐使用命名卷或本地目录挂载确保数据持久化。

Web管理界面

访问http://<主机IP>:2000登录管理界面：

• 初始凭据：admin/admin（首次登录需修改）
• 功能：插件管理、命令配置、日志查看、系统设置

插件管理

1. 主机创建./plugins目录，放入自定义插件文件
2. 启动容器时挂载：-v ./plugins:/app/plugins
3. 重启容器自动加载插件

常见问题排查

• 启动失败：检查环境变量配置，查看日志：docker logs sogebot
• 端口冲突：修改端口映射（如-p 2001:2000）
• 数据丢失：确保正确挂载/app/data卷，避免使用docker rm -v删除容器
• 插件不加载：检查插件文件权限，确保挂载路径正确