jupyternaas/notifications

Naas Notifications镜像说明

镜像概述

Naas Notifications是一款与naas服务配套运行的通知服务，主要用于向用户发送naas服务状态通知及自定义通知，支持多种配置以适配不同场景需求。

核心功能

1. 发送naas服务状态变更通知（如任务完成、失败）
2. 支持自定义业务事件通知
3. 通过SMTP协议实现邮件通知
4. 集成Sentry进行错误监控
5. 适配Jupyter Hub实例
6. 支持SQLite（内存模式）或PostgreSQL数据库存储
7. 管理员令牌机制：允许无需特定Jupyter用户即可发送邮件

使用场景

• naas服务运行状态提醒
• 自定义业务流程通知（如数据处理完成）
• 管理员批量发送系统通知

配置说明

关键环境变量配置：

• EMAIL_SECURE：是否启用SSL（布尔值）
• EMAIL_USER：SMTP服务器登录用户名
• EMAIL_PASSWORD：SMTP服务器登录密码
• EMAIL_HOST：SMTP服务器地址
• SENTRY_DSN：Sentry监控服务的DSN地址
• HUB_HOST：部署的Jupyter Hub实例主机名
• PROXY_DB：数据库连接地址（支持sqlite::memory:或PostgreSQL URI）
• ADMIN_TOKEN：管理员令牌，用于免用户验证发送邮件

部署示例

Docker Run命令

bash
docker run -d \
  --name naas-notifications \
  -e EMAIL_SECURE=true \
  -e EMAIL_USER="your-email@example.com" \
  -e EMAIL_PASSWORD="your-email-password" \
  -e EMAIL_HOST="smtp.example.com" \
  -e SENTRY_DSN="your-sentry-dsn" \
  -e HUB_HOST="your-jupyter-hub-host" \
  -e PROXY_DB="sqlite::memory:" \
  -e ADMIN_TOKEN="your-admin-token" \
  jupyternaas/notifications

Docker Compose示例（片段）

yaml
services:
  naas-notifications:
    image: jupyternaas/notifications
    environment:
      EMAIL_SECURE: "true"
      EMAIL_USER: "***"
      EMAIL_PASSWORD: "your-email-password"
      EMAIL_HOST: "smtp.example.com"
      SENTRY_DSN: "your-sentry-dsn"
      HUB_HOST: "your-jupyter-hub-host"
      PROXY_DB: "postgres://user:pass@postgres:5432/naas_notifications"
      ADMIN_TOKEN: "your-admin-token"
    depends_on:
      - postgres