teyker/yagpdb

Teyloll's YAGPDB 镜像文档

镜像概述

Teyloll's YAGPDB镜像是基于https://github.com/botlabs-gg/yagpdb%E9%A1%B9%E7%9B%AE%E6%9E%84%E5%BB%BA%E7%9A%84Docker%E9%95%9C%E5%83%8F%EF%BC%8C%E7%94%A8%E4%BA%8E%E7%AE%80%E5%8C%96%E5%8A%9F%E8%83%BD%E4%B8%B0%E5%AF%8C%E7%9A%84***%E6%9C%BA%E5%99%A8%E4%BA%BA%E7%9A%84%E9%83%A8%E7%BD%B2%E6%B5%81%E7%A8%8B%E3%80%82YAGPDB%E6%98%AF%E4%B8%80%E6%AC%BE%E6%94%AF%E6%8C%81%E8%81%8A%E5%A4%A9%E4%BA%92%E5%8A%A8%E3%80%81Web%E6%8E%A7%E5%88%B6%E9%9D%A2%E6%9D%BF%E3%80%81%E8%83%8C%E6%99%AF%E4%BB%BB%E5%8A%A1%E5%A4%84%E7%90%86%E5%8F%8A%E5%A4%9A%E8%AE%A2%E9%98%85%E6%BA%90%EF%BC%88Reddit%E3%80%81***%E3%80%81***%E7%AD%89%EF%BC%89%E7%9A%84***%E6%9C%BA%E5%99%A8%E4%BA%BA%EF%BC%8C%E6%9C%AC%E9%95%9C%E5%83%8F%E6%8F%90%E4%BE%9B%E5%A4%9A%E6%9E%B6%E6%9E%84%E6%94%AF%E6%8C%81%EF%BC%88x86_64/ARM64%EF%BC%89%EF%BC%8C%E6%AF%8F%E6%97%A5%E8%87%AA%E5%8A%A8%E6%9B%B4%E6%96%B0%EF%BC%8C%E5%B9%B6%E5%85%BC%E5%AE%B9%E6%A0%B9less%E9%83%A8%E7%BD%B2%E7%8E%AF%E5%A2%83%E3%80%82

核心功能与特性

• 多架构支持：默认标签（latest及版本标签）包含多架构镜像，支持x86_64及ARM64设备（如Raspberry Pi 3及以上）。
• 丰富功能集：集成***机器人核心功能、Web控制面板、背景任务调度及多订阅源处理。
• 灵活部署：支持从官方caskd/yagpdb等预构建镜像平滑迁移，保留原有配置数据。
• 每日更新：镜像每日02:30-03:00 UTC自动构建更新，确保代码与安全补丁时效性。
• 根less兼容：提供master-rootless标签，支持非root用户部署环境。

适用场景

• 自托管***社区机器人，需自定义功能与数据隐私的用户。
• ARM架构设备（如Raspberry Pi 3/4、Zero 2 W）上部署轻量级***机器人。
• 需要从旧版YAGPDB镜像或第三方镜像迁移至维护活跃版本的场景。

部署与使用指南

前置要求

• Docker与Docker Compose环境。
• 开发者账号，已创建机器人应用并启用所有特权网关意图*：
  1. 访问***开发者门户
  2. 在机器人应用的"特权网关意图"中启用"Presence Intent"、"Server Members Intent"及"Message Content Intent"

基础部署步骤

1. 准备配置文件
   需3个核心文件（可从镜像仓库下载示例）：

   • app.env：机器人应用配置（如Token、数据库连接）
   • db.env：Redis数据库配置
   • docker-compose.yml：容器编排配置

2. 启动容器
   将文件置于同一目录，执行以下命令启动：

   bash
   docker-compose up -d
   

从其他预构建镜像迁移

若从caskd/yagpdb或其他镜像迁移，需修改docker-compose.yml：

yaml
services:
  app:
    image: teyker/yagpdb  # 修改镜像名为teyker/yagpdb
    restart: unless-stopped
    command:
      - "/app/yagpdb"  # 添加此行
      - "-all"         # 启用所有核心功能
      - "-pa"          # 使用80/443端口（需配合端口映射）
      - "-exthttps=false"  # 根据反向代理需求调整
      - "-https=true"      # 是否启用HTTPS（默认true）

注意：迁移前需备份Redis数据卷，且确保已启用***特权意图。降级至旧版本可能导致数据丢失，迁移前建议查阅https://github.com/botlabs-gg/yagpdb/blob/master/breaking_changes.md%E3%80%82

ARM设备部署（如Raspberry Pi）

支持的ARM设备

需64位操作系统，支持以下型号：

• Raspberry Pi 2 Model B v1.2
• Raspberry Pi 3/4/400、Zero 2 W
• Compute Module 3及以上（含Lite版本）

部署步骤

直接使用多架构标签（latest或版本标签），无需额外配置，按基础部署步骤操作即可。旧版-arm64后缀标签仍可使用，但建议迁移至latest以获取最新更新。

配置说明

命令行参数

可通过docker-compose.yml的command字段自定义机器人行为，核心参数如下：

功能开关

• -all：启用所有核心功能（机器人、Web服务、背景任务、订阅源），推荐大多数用户使用。
• -bot：仅启动***机器人核心。
• -web：仅启动Web控制面板。
• -feeds：指定订阅源（逗号分隔，如reddit,youtube,twitter）。
• -backgroundworkers：启动背景任务处理（至少需一个实例启用）。

Web服务配置

• -pa：使用80/443端口（默认使用5000/5001），需配合宿主机端口映射。
• -https：启用HTTPS（默认true），由机器人自行处理SSL证书。
• -exthttps：启用外部HTTPS（通过反向代理），需同时设置-https=false。

调试与日志

• -ts：日志添加时间戳。
• -syslog：输出日志至syslog（仅Linux）。
• -version：打印版本信息并退出。

环境变量

通过app.env和db.env配置关键参数：

• app.env：机器人Token、数据库连接地址、Web域名等。
• db.env：Redis密码、端口等（首次启动后修改Redis密码需手动操作容器或重建数据卷）。

更新策略与版本管理

• 标签说明：
  • latest/版本标签（如v1.24.18）：多架构稳定版，每日更新。
  • master/devel：开发分支构建，包含最新功能但稳定性较低。
  • master-rootless/devel-rootless：根less部署版本。
• 镜像保留：超过6个月未更新的镜像可能被Docker Hub清理，建议定期更新或保留本地缓存。

常见问题

"exec format error"

原因：未使用64位操作系统。YAGPDB仅支持64位环境，ARM设备需确认硬件型号（见上文支持列表）及系统架构。

"400: Bad Request"

原因：可能使用旧版caskd/yagpdb镜像，需迁移至teyker/yagpdb并启用所有特权意图（见前置要求）。

Redis警告说明

Redis容器启动时可能出现以下警告，通常不影响功能，内存紧张时建议修复：

1. TCP backlog设置：需修改/proc/sys/net/core/somaxconn至511。
2. overcommit_memory：添加vm.overcommit_memory = 1至/etc/sysctl.conf并重启。
3. Transparent Huge Pages：执行echo never > /sys/kernel/mm/transparent_hugepage/enabled并添加至/etc/rc.local。

相关链接

• https://github.com/botlabs-gg/yagpdb
• 镜像构建代码
• ***开发者门户

许可证

• 基于YAGPDB项目文件（app.example.env、db.example.env）：MIT许可证（Copyright (c) 2019 jonas747）。
• 镜像构建相关文件（docker-compose.yml、Dockerfile等）：MIT许可证（Copyright (c) 2021 Teyloll）。
• 文档：知识共享署名-非商业性使用4.0国际许可协议。

支持与反馈

• 机器人功能问题：联系YAGPDB官方支持。
• 镜像相关问题：在YAGPDB社区***的#self-hosting-discussion频道ping teyloll。