denimgroup/notifier

tn-notifier Docker镜像文档

概述

tn-notifier是一款轻量级通知服务容器化解决方案，旨在提供简单高效的消息推送机制。该镜像封装了完整的通知服务功能，支持多种通知渠道，可快速集成到各类应用系统中，实现事件通知、告警提醒和业务消息的及时送达。

核心功能与特性

主要功能

• 支持多渠道通知推送（邮件、短信、即时通讯工具等）
• 提供RESTful API接口，便于应用系统集成
• 内置消息队列机制，确保通知可靠送达
• 支持消息模板自定义，满足不同场景需求
• 提供通知状态跟踪和失败重试功能

特性优势

• 轻量级设计，资源占用低
• 配置简单，通过环境变量即可完成基础设置
• 容器化部署，跨平台兼容性好
• 支持水平扩展，可满足高并发通知需求
• 完整的日志记录，便于问题排查和审计

使用场景

• 服务器监控告警通知
• 应用系统异常事件通知
• 业务流程节点提醒
• 系统运维通知
• 用户行为触发通知
• 定期报告自动发送

快速开始

基本使用（Docker Run）

bash
docker run -d \
  --name tn-notifier \
  -p 8080:8080 \
  -e NOTIFIER_PORT=8080 \
  -e LOG_LEVEL=info \
  tn-notifier:latest

Docker Compose配置

yaml
version: '3'
services:
  tn-notifier:
    image: tn-notifier:latest
    container_name: tn-notifier
    ports:
      - "8080:8080"
    environment:
      - NOTIFIER_PORT=8080
      - LOG_LEVEL=info
      - DB_CONNECTION=sqlite
      - CACHE_TTL=300
    volumes:
      - ./data:/app/data
    restart: unless-stopped

配置说明

环境变量

持久化数据

为确保配置和数据持久化，建议挂载以下目录：

bash
-v ./config:/app/config  # 配置文件目录
-v ./data:/app/data      # 数据存储目录
-v ./logs:/app/logs      # 日志文件目录

API使用示例

发送通知

bash
curl -X POST http://localhost:8080/api/v1/notify \
  -H "Content-Type: application/json" \
  -d '{
    "channel": "email",
    "recipient": "user@example.com",
    "subject": "系统告警",
    "content": "服务器CPU使用率超过阈值，请及时处理"
  }'

查看通知状态

bash
curl http://localhost:8080/api/v1/notify/{notificationId}

渠道配置

tn-notifier支持多种通知渠道，每种渠道需单独配置。详细配置方法请参考官方文档中对应渠道的配置指南。

维护与更新

查看日志

bash
docker logs -f tn-notifier

升级镜像

bash
docker pull tn-notifier:latest
docker stop tn-notifier
docker rm tn-notifier
# 重新运行容器（使用之前的配置参数）

常见问题

• Q: 如何添加新的通知渠道？
  A: 可以通过挂载自定义渠道配置文件到/app/config/channels目录实现。

• Q: 通知发送失败如何处理？
  A: 系统会自动重试发送，重试次数和间隔可通过环境变量配置。失败通知可通过API查询并手动触发重发。

• Q: 如何实现通知模板？
  A: 可将模板文件挂载到/app/templates目录，在发送通知时指定模板名称即可。

相关资源

• https://github.com/example/tn-notifier
• API文档
• https://github.com/example/tn-notifier/issues