ryancurrah/synology-notifications

synology-notifications

镜像概述和主要用途

synology-notifications是一款用于接收Synology系统通知并转发至指定通知服务的工具。它作为中间服务，接收来自Synology设备的通知请求，然后将通知内容转发到用户配置的通知服务（目前支持Slack），帮助用户更便捷地管理和接收Synology系统通知。

核心功能和特性

• 多服务支持：目前已支持Slack通知服务
• 安全认证：通过API密钥进行身份验证，确保通知传输安全
• 灵活配置：通过环境变量设置服务参数，无需修改代码
• 自定义端口：可指定服务监听端口，适应不同网络环境

使用场景和适用范围

适用于需要将Synology系统通知（如存储容量警告、备份完成状态、系统错误等）转发到Slack的用户。特别适合需要集中管理多设备通知、或团队协作中需要共享Synology系统状态的场景。

使用方法和配置说明

环境变量配置

服务基础设置

• API_KEY：Synology服务器用于认证的API密钥，至少32个字符
• LISTEN_PORT：服务监听端口，默认值为8080

Slack通知设置

• SLACK_WEBHOOK：Slack Webhook URL，用于接收通知
• SLACK_ATTACHMENT_COLOR：Slack通知附件颜色，支持十六进制格式（如#36a64f）

Docker部署示例

基本运行命令

bash
docker run -e API_KEY='LO45UXS%amLAWJn6CwJ1koaXW&7pY9#Z' -e SLACK_WEBHOOK='https://slack.com/myWebHookUrl' -p 8080:8080 ryancurrah/synology-notifications:latest

Synology配置步骤

1. 登录DiskStation管理界面
2. 进入控制面板 > 通知 > 短信
3. 勾选启用短信通知
4. 点击添加短信服务提供商创建新提供商（注意：实际不使用短信功能）
   • 提供商名称：synology-notifications
   • 短信URL：http://<synology-notifications服务IP地址>:8080
   • HTTP方法：POST
5. 点击下一步进入编辑HTTP请求头页面
6. 点击添加，设置参数为api_key，值留空
7. 点击下一步进入编辑HTTP请求体页面
8. 点击添加，设置参数为phone_number，值留空（注意：Synology要求此字段必须存在）
9. 点击添加，设置参数为message，值设为Hello world（注意：Synology要求提供示例值）
10. 点击下一步进入为每个参数选择对应的类别页面
11. 将api_key参数类型设为API密钥
12. 将phone_number参数类型设为电话号码
13. 将message参数类型设为消息内容
14. 点击应用
15. 在短信服务提供商下拉菜单中选择synology-notifications
16. 在API密钥字段中粘贴服务配置的API Key
17. 点击应用
18. 点击发送测试短信测试通知服务是否正常工作

Synology配置截图参考

!https://github.com/ryancurrah/synology-notifications/blob/master/assets/Step_1.png?raw=true

!https://github.com/ryancurrah/synology-notifications/blob/master/assets/Step_2.png?raw=true

!https://github.com/ryancurrah/synology-notifications/blob/master/assets/Step_3.png?raw=true

!https://github.com/ryancurrah/synology-notifications/blob/master/assets/Step_4.png?raw=true

!https://github.com/ryancurrah/synology-notifications/blob/master/assets/Step_5.png?raw=true