flipdot/forumbot Docker 镜像 - 轩辕镜像

flipdot Discourse bot

概述

flipdot Discourse bot是一个针对Discourse论坛系统的自动化交互机器人，通过Discourse API实现与论坛的通信，支持执行定时任务及自定义任务扩展，旨在简化论坛管理流程并实现自动化交互。

核心功能

• Discourse API集成：通过API密钥认证，与Discourse论坛进行数据交互。
• 环境变量配置：支持通过环境变量自定义连接参数（API密钥、用户名、论坛地址）。
• 定时任务调度：内置任务调度机制，支持按时间规则（如每日、特定时间）执行任务。
• 任务扩展能力：提供标准化任务模板，支持用户添加自定义任务逻辑。
• 自动化部署：通过Ansible playbook管理部署，master分支变更自动触发部署。

使用场景

• Discourse论坛的日常自动化管理（如定时发布公告、清理过期内容）。
• 论坛用户互动自动化（如新用户欢迎、主题回复提醒）。
• 自定义业务逻辑执行（根据需求扩展任务脚本）。

使用方法

基本运行

通过Docker容器启动机器人，需指定必要环境变量：

bash
# 连接默认Discourse实例
docker run -d -e DISCOURSE_API_KEY=<your_api_key> flipdot/forumbot

# 连接自定义Discourse实例
docker run -d \
  -e DISCOURSE_API_KEY=<your_api_key> \
  -e DISCOURSE_USERNAME=<bot_username> \
  -e DISCOURSE_HOST=[***] \
  flipdot/forumbot

环境变量说明

部署方式

生产环境通过Ansible playbook部署，配置详情参见官方Ansible角色。部署流程支持自动化：master分支代码变更后，系统自动拉取更新并重启服务。

开发指南

构建与运行容器

1. 克隆仓库并修改代码：

   bash
   git clone <仓库地址>
   cd forumbot
   # 开发修改
   

2. 构建Docker镜像：

   bash
   ./build_docker.sh
   

3. 运行容器（支持测试用户）：

   bash
   # 使用默认配置
   DISCOURSE_API_KEY=<your_api_key> ./run_docker.sh
   # 或指定测试用户
   DISCOURSE_API_KEY=<your_api_key> DISCOURSE_USERNAME=flipbot_test ./run_docker.sh
   

本地非Docker开发

1. 安装依赖：

   bash
   pipenv sync
   

2. 直接运行脚本：

   bash
   # 默认配置
   DISCOURSE_API_KEY=<your_api_key> python src/app.py
   # 测试用户模式
   DISCOURSE_API_KEY=<your_api_key> DISCOURSE_USERNAME=flipbot_test python src/app.py
   

   测试用户flipbot_test凭据获取：API key für flipbot_test

执行测试

设置API密钥（可填无效值）后运行测试：

bash
DISCOURSE_API_KEY=_ pipenv run nosetests

添加自定义任务

1. 复制任务模板：

   bash
   cp src/tasks/hello_world.py src/tasks/my_task.py
   

2. 修改任务逻辑（编辑my_task.py）：

   python
   def main(client: DiscourseClient) -> None:
       # 通过client对象实现与Discourse的交互
       # 示例：发布主题、回复帖子等操作
       pass
   

3. 导入任务到主程序（编辑src/app.py）：

   python
   import tasks.my_task  # 添加到文件顶部导入区
   

4. 调度任务执行（在schedule_jobs函数中添加）：

   python
   # 示例：每日13:37执行任务
   schedule.every().day.at('13:37').do(tasks.my_task.main, client)
   

   调度语法参考：schedule库文档

5. 测试任务（dry run模式）：

   bash
   python src/app.py --dry --run_task my_task