镜像概述

本镜像为 technosophos/slack-notify ***镜像的分支版本（Fork），主要用于通过Slack Incoming Webhook发送通知消息。基于原镜像核心功能开发，可能包含定制化调整（具体差异需参考项目文档或原镜像说明），适用于各类自动化场景中的实时通知需求。

核心功能与特性

• Slack消息发送：支持通过Slack Incoming Webhook发送文本通知，兼容原镜像基础消息格式
• 环境变量配置：通过环境变量灵活配置通知参数，无需修改镜像内部代码
• 轻量级设计：基于精简基础镜像（通常为Alpine），镜像体积小，资源占用低
• 易于集成：可直接嵌入Shell脚本、CI/CD流程或自动化工具链中执行
• 定制化支持：作为分支版本，可能包含针对特定场景的功能调整或优化（具体以实际实现为准）

使用场景与适用范围

• CI/CD流程通知：在代码构建、测试、部署等环节发送状态通知（如构建成功/失败、部署完成）
• 系统事件告警：服务器异常、资源超限、服务状态变化等系统事件的实时告警
• 自动化任务通知：定时任务执行结果、数据同步状态、脚本运行完成等自动化操作的状态反馈
• 开发协作工具：与项目管理工具、代码审查流程结合，发送任务分配、合并请求等通知

使用方法与配置说明

前置准备

1. 在Slack工作区中创建Incoming Webhook，获取Webhook URL（需Slack管理员权限或工作区配置权限）
2. 确保Docker环境已安装并可正常运行

环境变量说明

Docker 运行示例

基础文本消息发送

bash
docker run -e SLACK_WEBHOOK="[***]" \
           -e SLACK_MESSAGE="CI构建任务已完成：分支main构建成功" \
           -e SLACK_CHANNEL="#dev-ci" \
           -e SLACK_USERNAME="CI-Bot" \
           your-image-name:tag

带标题和颜色的通知

bash
docker run -e SLACK_WEBHOOK="[***]" \
           -e SLACK_MESSAGE="服务器CPU使用率已达90%，请检查系统负载" \
           -e SLACK_TITLE="服务器资源告警" \
           -e SLACK_COLOR="#FF0000" \
           -e SLACK_ICON=":warning:" \
           your-image-name:tag

Docker Compose 配置示例

yaml
version: '3.8'
services:
  slack-notify:
    image: your-image-name:tag
    environment:
      - SLACK_WEBHOOK=[***]
      - SLACK_MESSAGE=数据库备份任务已完成，备份文件大小：2.5GB
      - SLACK_CHANNEL=#ops-alerts
      - SLACK_USERNAME=Backup-Bot
      - SLACK_ICON=[***]

注意事项

1. Webhook安全性：SLACK_WEBHOOK 包含敏感信息，建议通过安全方式注入（如Docker Secrets、环境变量文件挂载），避免直接明文写在命令或配置文件中
2. 消息格式限制：默认支持纯文本消息，如需富文本（如换行、链接、@提及），需在 SLACK_MESSAGE 中使用Slack支持的消息格式（如 \n 换行、<[***]|链接文本>、@user）
3. 分支功能差异：作为 technosophos/slack-notify 的分支版本，部分功能可能与原镜像存在差异，建议参考项目源码或文档确认具体支持的参数和消息格式
4. 网络权限：确保运行容器的环境可访问Slack服务器（需开放 outbound HTTPS 连接）

故障排查

• 通知未发送：检查 SLACK_WEBHOOK 是否正确、网络是否通畅、Slack工作区是否限制外部通知
• 消息格式异常：确认 SLACK_MESSAGE 中的特殊字符是否符合Slack格式要求，避免使用未支持的HTML标签
• 环境变量不生效：检查变量名是否拼写正确，Docker命令中是否正确使用 -e 参数传递变量