tidepool/hydrophone

Tidepool Hydrophone 镜像文档

一、镜像概述和主要用途

Tidepool Hydrophone 是一个微服务组件，专为 Tidepool 平台设计，主要用途是处理用户通知的发送。该服务负责在用户操作场景下触发通知，例如密码重置请求、新用户注册确认、用户间邀请等，确保用户及时获取账户相关的关键信息。

项目源码地址：https://github.com/tidepool-org/hydrophone

二、核心功能和特性

核心功能

• 支持多种用户账户相关通知类型，包括但不限于：
  • 初始注册确认通知
  • 密码重置链接发送
  • 用户邀请通知
• 与 Tidepool 平台其他微服务无缝集成，接收通知触发事件并处理发送逻辑

主要特性

• 轻量级微服务架构，易于部署和扩展
• 基于事件驱动设计，响应平台内用户操作事件
• 可配置的通知模板系统，支持自定义通知内容

三、使用场景和适用范围

适用范围

Tidepool Hydrophone 为 Tidepool 平台内部服务，仅用于处理平台用户账户相关的通知业务，不对外开放独立使用。

典型使用场景

• 新用户注册：用户完成注册后，发送欢迎邮件及账户激活指引
• 密码重置：用户提交密码重置请求后，发送包含重置链接的邮件/SMS
• 用户邀请：现有用户邀请他人加入平台时，向被邀请方发送邀请通知

四、使用方法和配置说明

4.1 前提条件

• 已安装 Docker 或 Docker Compose
• 具备 Tidepool 平台服务环境（需与其他微服务协同工作）
• 通知发送所需的外部服务配置（如邮件服务器、SMS 网关等）

4.2 获取镜像

镜像需从 Tidepool 私有仓库或 Docker Hub 获取（具体地址请参考项目文档）：

bash
docker pull docker.xuanyuan.run/tidepool/hydrophone:latest

4.3 运行容器（Docker Run）

bash
docker run -d \
  --name hydrophone \
  --network tidepool-network \  # 接入 Tidepool 平台网络
  -e TIDEPOOL_API_URL=http://tidepool-api:8080 \  # Tidepool API 地址
  -e NOTIFICATION_PROVIDER=smtp \  # 通知 provider（如 smtp、twilio 等）
  -e SMTP_HOST=smtp.example.com \  # SMTP 服务器地址
  -e SMTP_PORT=587 \  # SMTP 端口
  -e SMTP_USER=notifications@tidepool.org \  # SMTP 用户名
  -e SMTP_PASS=your-smtp-password \  # SMTP 密码
  -e LOG_LEVEL=info \  # 日志级别
  tidepool/hydrophone:latest

4.4 Docker Compose 配置

创建 docker-compose.yml 文件：

yaml
version: '3.8'

services:
  hydrophone:
    image: docker.xuanyuan.run/tidepool/hydrophone:latest
    container_name: hydrophone
    restart: always
    networks:
      - tidepool-network
    environment:
      - TIDEPOOL_API_URL=http://tidepool-api:8080
      - NOTIFICATION_PROVIDER=smtp
      - SMTP_HOST=smtp.example.com
      - SMTP_PORT=587
      - SMTP_USER=notifications@tidepool.org
      - SMTP_PASS=your-smtp-password
      - LOG_LEVEL=info
    depends_on:
      - tidepool-api  # 依赖 Tidepool API 服务

networks:
  tidepool-network:
    external: true  # 假设已存在 Tidepool 平台网络

启动服务：

bash
docker-compose up -d

4.5 配置参数说明

五、注意事项

• 该服务需与 Tidepool 平台其他组件（如用户认证服务、API 网关）协同工作，独立运行无法提供完整功能。
• 通知模板可通过挂载外部目录（-v /local/templates:/app/templates）自定义，模板格式请参考项目源码中的示例。
• 生产环境中需配置 TLS 加密（如 SMTP over SSL/TLS），并妥善保管敏感配置（如 SMTP 密码），建议使用 Docker Secrets 或环境变量管理工具。