cdzombak/humidity-reminder

humidity-reminder镜像说明

镜像概述

humidity-reminder镜像通过监控国家气象局（weather.gov）的天气预报数据，计算未来一周的推荐室内相对湿度，并在推荐值发生变化时通过Mailgun发送邮件提醒。它使用状态文件记录历史推荐值，仅在变化时通知用户，避免重复打扰。

核心功能

• 从weather.gov获取指定位置的天气预报数据
• 提取未来七天的夜间最低温度
• 根据最低温度计算推荐的室内相对湿度
• 对比历史状态，仅在推荐值变化时发送邮件通知
• 支持多架构部署，镜像基于scratch构建，体积小巧

使用场景

• 家庭用户根据天气变化调整室内湿度，保持舒适环境
• 办公场所维护适宜的湿度条件，提升工作环境质量
• 自动化调整加湿器设置的辅助工具

配置说明

配置文件示例

yaml
latitude: 41.1234
longitude: -81.5679
weather:
  user_agent: "humidity-reminder/1.0 (you@example.com)"
  timeout: "10s"
mailgun:
  domain: "mg.example.com"
  api_key: "key-XXXXXXXXXXXXXXXXXXXXXXX"
  from: "Humidity Reminder <humidity@example.com>"
  to: "you@example.com"
state_dir: "/var/lib/humidity-reminder"

关键配置项解释

• latitude/longitude: 目标位置的经纬度（WGS84格式）
• weather.user_agent: NOAA要求的用户代理，需包含联系信息
• weather.timeout: 天气API请求超时时间（默认10秒）
• mailgun: Mailgun服务配置，包括域名、API密钥、发件人和收件人
• state_dir: 状态文件存储目录，需持久化且可写

Docker部署示例

单容器运行

shell
docker run --rm \
  -v /path/to/your/config.yaml:/app/config.yaml:ro \
  -v /path/to/state/dir:/var/lib/humidity-reminder \
  cdzombak/humidity-reminder:1 \
  -config /app/config.yaml

注意事项

• 确保配置文件中的state_dir指向容器内路径（如/var/lib/humidity-reminder）
• 挂载的状态目录需具备读写权限，以便保存历史状态

许可证

GNU General Public License v3.0