mazzolino/apprise-microservice

Apprise Microservice 镜像文档

镜像概述和主要用途

Apprise Microservice 是一个基于 Apprise 构建的小型 JSON API 服务器，旨在提供简单、标准化的接口用于发送通知。通过该镜像，用户可以轻松集成多种通知服务（如 Email、Slack、、 等），无需直接处理各服务的底层 API 差异。

![构建状态]([***]
项目源码：https://github.com/djmaze/apprise-microservice

核心功能和特性

• 多渠道支持：基于 Apprise 框架，支持 50+ 种通知服务（如 Email、Slack、、、SMS 等）
• JSON API 接口：提供简洁的 HTTP API，支持通过 JSON 格式发送通知请求
• 轻量级设计：容器化部署，资源占用低，适合微服务架构
• 灵活配置：支持通过 API 参数或环境变量配置通知渠道
• 无状态服务：便于水平扩展，满足高并发通知需求

使用场景和适用范围

• 应用集成：需在应用中集成多种通知渠道的场景（如监控告警、用户通知）
• 微服务架构：作为独立通知服务组件，为其他微服务提供通知能力
• 自动化流程：CI/CD 流水线、定时任务等自动化场景的状态通知
• 跨平台通知：需统一管理不同平台（移动端、桌面端、社交软件）通知的系统

详细使用方法和配置说明

快速启动

通过以下命令启动容器，默认暴露 8000 端口：

bash
docker run -d -p 8000:8000 --name apprise-ms djmaze/apprise-microservice

环境变量配置

支持通过环境变量调整服务行为：

• APPRISE_LOG_LEVEL：日志级别（默认：INFO，可选：DEBUG/WARNING/ERROR）
• APPRISE_DEFAULT_URLS：默认通知渠道 URL（多个 URL 用逗号分隔，如 mailto://user:pass@gmail.com,slack://token#channel）
• PORT：服务监听端口（默认：8000）

API 使用示例

通过 HTTP POST 请求发送通知，API 端点为 /notify，请求体为 JSON 格式。

基本请求示例（curl）

bash
curl -X POST http://localhost:8000/notify \
  -H "Content-Type: application/json" \
  -d '{
    "title": "服务告警",
    "body": "数据库连接失败，请及时处理",
    "urls": [
      "slack://xoxb-1234567890-abcdefghijklmnopqrstuvwxyz",
      "telegram://123456789:ABC-DEF1234ghIkl-zyx57W2v1u123ew11"
    ]
  }'

请求参数说明

高级配置

• 持久化配置：通过挂载配置文件到容器，自定义默认通知渠道（参考 https://github.com/caronc/apprise/wiki/config%EF%BC%89

  bash
  docker run -d -p 8000:8000 \
    -v /host/path/to/apprise.yml:/app/apprise.yml \
    -e APPRISE_CONFIG=/app/apprise.yml \
    djmaze/apprise-microservice
  

• HTTPS 支持：结合反向代理（如 Nginx）配置 SSL，确保 API 通信安全

注意事项

• 通知渠道 URL 需符合 Apprise 格式，具体参考 https://github.com/caronc/apprise/wiki
• 高并发场景下建议通过负载均衡扩展多个实例
• 生产环境中建议配置身份验证（如 API Key），可通过反向代理实现