docker-notify 镜像文档

镜像概述和主要用途

docker-notify是一款集成多种通知平台的命令行工具Docker镜像，旨在提供一站式的命令行通知解决方案。通过该镜像，用户可便捷地从命令行发送消息至支持的通知平台，适用于自动化脚本、服务器监控、CI/CD流程等场景下的消息通知需求。

核心功能和特性

• 多平台支持：已集成***、Slack、***通知功能，计划支持Teams、Gitter、Line等更多平台
• 命令行操作：通过简单的命令行指令即可发送通知，易于集成到各类脚本中
• Docker化部署：封装为Docker镜像，无需复杂环境配置，开箱即用

使用场景和适用范围

典型使用场景

• 自动化脚本通知（如定时任务执行结果、文件同步状态）
• 服务器监控告警（如CPU/内存使用率超标、服务异常停止）
• CI/CD流程通知（如构建成功/失败、部署完成状态）
• 系统事件提醒（如用户登录、文件变更、端口占用）

适用人群

开发者、运维工程师、DevOps工程师等需要通过命令行发送通知的技术人员。

使用方法和配置说明

前提条件

• 已安装Docker环境
• 获取目标通知平台的API凭证（如*** Bot Token、Slack Webhook URL等）

基本使用命令格式

bash
docker run --rm sstc/notify [通知平台] [平台参数] "通知内容"

各平台配置与使用示例

***通知

所需凭证：*** Bot Token（通过@BotFather创建）、目标Chat ID
发送命令示例：

bash
docker run --rm \
  -e ***_BOT_TOKEN="your_bot_token" \
  sstc/notify *** \
  --chat-id "your_chat_id" \
  "这是一条来自docker-notify的***测试通知"

Slack通知

所需凭证：Slack Webhook URL（在Slack应用中创建Incoming Webhook）
发送命令示例：

bash
docker run --rm \
  -e SLACK_WEBHOOK_URL="your_slack_webhook_url" \
  sstc/notify slack \
  -m "这是一条来自docker-notify的Slack测试通知"

***通知

所需凭证：*** Webhook URL（在***服务器设置中创建Webhook）
发送命令示例：

bash
docker run --rm \
  -e ***_WEBHOOK_URL="your_***_webhook_url" \
  sstc/notify *** \
  --text "这是一条来自docker-notify的***测试通知"

环境变量说明

支持的通知平台状态

相关链接

• GitHub项目地址
• Docker Hub镜像页面