alecu/redmine-teams

Redmine to MS Teams 通知镜像

概述

该Docker镜像提供Redmine与Microsoft Teams的集成功能，能够实时监控Redmine问题的变更，并将相关信息自动发送至指定的MS Teams频道，帮助团队及时获取项目任务状态更新。

核心功能与特性

• 实时监控：持续监听Redmine问题的创建、更新、状态变更等事件
• 多事件支持：支持多种Redmine事件类型（新建、更新、状态变更、优先级变更、指派变更等）
• 自定义消息：可配置消息格式，包含问题标题、描述、状态、优先级、指派人员等关键信息
• 安全连接：通过Redmine API密钥和MS Teams Webhook实现安全认证与通信
• 轻量级部署：基于Docker容器化设计，易于部署和集成到现有环境

使用场景

• 开发团队：实时获取任务分配、状态更新通知，提高协作效率
• 项目管理：跟踪项目进度，及时了解问题解决状态
• 运维团队：监控系统缺陷修复进度，协调资源分配
• 跨部门协作：确保不同团队同步获取Redmine问题变更信息

使用方法与配置说明

环境变量配置

Docker Run 示例

bash
docker run -d \
  --name redmine-teams-notifier \
  -e REDMINE_URL="https://redmine.yourcompany.com" \
  -e REDMINE_API_KEY="your_redmine_api_key_here" \
  -e TEAMS_WEBHOOK_URL="https://outlook.office.com/webhook/your_teams_webhook_url" \
  -e REDMINE_PROJECT_ID="123" \
  -e MONITORED_EVENTS="issue.create,issue.update,issue.status_change" \
  -e POLL_INTERVAL="30" \
  your-image-name:latest

Docker Compose 示例

yaml
version: '3'
services:
  redmine-teams-notifier:
    image: your-image-name:latest
    container_name: redmine-teams-notifier
    environment:
      - REDMINE_URL=https://redmine.yourcompany.com
      - REDMINE_API_KEY=your_redmine_api_key_here
      - TEAMS_WEBHOOK_URL=https://outlook.office.com/webhook/your_teams_webhook_url
      - REDMINE_PROJECT_ID=123
      - MONITORED_EVENTS=issue.create,issue.update,issue.status_change,issue.priority_change
      - POLL_INTERVAL=30
    restart: unless-stopped

自定义消息模板

默认消息模板包含基本问题信息，可通过MESSAGE_TEMPLATE环境变量自定义。支持的占位符包括：

• {{issue.id}}：问题ID
• {{issue.subject}}：问题标题
• {{issue.description}}：问题描述
• {{issue.status}}：当前状态
• {{issue.priority}}：优先级
• {{issue.assignee}}：指派人员
• {{issue.url}}：问题URL
• {{event.type}}：事件类型（创建/更新等）

示例自定义模板：

**Redmine问题{{event.type}}**  
标题：{{issue.subject}}  
状态：{{issue.status}}  
指派给：{{issue.assignee}}  
查看：{{issue.url}}

注意事项

• 确保Redmine API密钥具有足够权限（至少能访问需要监控的项目和问题）
• MS Teams Webhook URL需正确配置，可在Teams频道设置中创建"Incoming Webhook"获取
• 轮询间隔建议根据实际需求调整，过短可能增加Redmine服务器负载，过长可能延迟通知