dartsteven/nutify

notify-docker-nut 镜像文档

镜像概述和主要用途

notify-docker-nut是一个Docker化解决方案，集成网络UPS工具（NUT）与电子邮件通知功能，提供无缝的UPS监控和告警管理。该镜像旨在实时监控UPS事件（如电源中断、恢复等状态变化），并通过电子邮件发送告警通知。支持自定义SMTP配置，适配各类邮件服务提供商，可根据实际需求灵活调整。适用于家庭和企业级部署场景，通过实时通知保障关键基础设施的电力状态可见性，确保系统稳定运行。

核心功能和特性

• Docker化NUT实现：将Network UPS Tools (NUT) 封装为Docker镜像，简化部署流程。
• 实时UPS监控：持续检测UPS状态变化，包括电源故障、恢复、电池电量低等关键事件。
• 电子邮件告警：针对UPS状态变化自动发送邮件通知，及时提醒管理员处理异常。
• 可配置SMTP参数：支持自定义SMTP服务器、端口、认证信息等，适配不同邮件服务（如SMTP服务器、企业***等）。
• 轻量化部署：优化资源占用，适合在Docker环境中高效运行，对系统资源需求低。
• 易于集成：支持与现有Docker环境快速集成，部署步骤简单，无需复杂的系统配置。

使用场景和适用范围

家庭用户场景

• 家庭服务器、NAS存储等关键设备的UPS监控，确保断电时及时收到通知并进行数据保护。
• 家庭办公环境中，保障网络设备、服务器等持续运行，避免突然断电导致的数据丢失。

企业级场景

• 小型数据中心、机房的UPS集中监控，简化多台UPS的管理和告警流程。
• 企业IT基础设施（如服务器、网络设备）的电力状态监控，提升系统可靠性和故障响应速度。

使用方法和配置说明

环境变量配置

部署时需通过环境变量配置SMTP和NUT相关参数，常用配置如下：

Docker部署示例

docker run 命令

bash
docker run -d \
  --name notify-docker-nut \
  --device=/dev/bus/usb:/dev/bus/usb \  # 如UPS通过USB连接，需挂载USB设备
  -e SMTP_HOST=smtp.example.com \
  -e SMTP_PORT=587 \
  -e SMTP_USER=alerts@example.com \
  -e SMTP_PASSWORD=your-smtp-password \
  -e SMTP_FROM=ups-alert@example.com \
  -e SMTP_TO=admin@example.com \
  -e UPS_NAME=myups \
  -e UPS_DRIVER=usbhid-ups \
  -e UPS_PORT=auto \
  --restart unless-stopped \
  notify-docker-nut

docker-compose 配置

创建 docker-compose.yml 文件：

yaml
version: '3'
services:
  notify-docker-nut:
    image: docker.xuanyuan.run/notify-docker-nut
    container_name: notify-docker-nut
    devices:
      - /dev/bus/usb:/dev/bus/usb  # USB连接UPS时挂载
    environment:
      - SMTP_HOST=smtp.example.com
      - SMTP_PORT=587
      - SMTP_USER=alerts@example.com
      - SMTP_PASSWORD=your-smtp-password
      - SMTP_FROM=ups-alert@example.com
      - SMTP_TO=admin@example.com,tech@example.com
      - UPS_NAME=myups
      - UPS_DRIVER=usbhid-ups
      - UPS_PORT=auto
    restart: unless-stopped

运行命令：docker-compose up -d

注意事项

• 确保UPS设备已正确连接到运行Docker的主机（如USB连接需挂载设备，网络UPS需配置正确IP/端口）。
• SMTP配置需与邮件服务提供商要求一致（如启用TLS/SSL、使用正确端口），避免邮件发送失败。
• 首次部署后建议手动触发UPS测试事件（如断开市电），验证告警功能是否正常。