Awesome
synology-notifications
Receive notifications from Synology and forward them to the notification service of your choice
Supported notification services
- Slack
Service settings
Settings are supplied by setting environment variables
API_KEY
: A minimum of 32 character api key that Synology server needs to use to auth to this services apiLISTEN_PORT
: Default8080
. The port the service will listen on
Slack settings
SLACK_WEBHOOK
: URL for the Slack web hookSLACK_ATTACHMENT_COLOR
: Color to use for the attachments can use hex#36a64f
Cmd
export API_KEY='LO45UXS%amLAWJn6CwJ1koaXW&7pY9#Z'
export SLACK_WEBHOOK='https://slack.com/myWebHookUrl'
./synology-notifications
listening on port 8080
Docker
docker run -e API_KEY='LO45UXS%amLAWJn6CwJ1koaXW&7pY9#Z' -e SLACK_WEBHOOK='https://slack.com/myWebHookUrl' -p 8080:8080 ryancurrah/synology-notifications:latest
listening on port 8080
Setting up Synology
- Login to Diskstation
- Go to
Control Pannel
>Notification
>SMS
- Check
Enable SMS Notifications
- Click
Add SMS Provider
to create a new SMS provider which will be thesynology-notifications
service. (NOTE: We will not actually be usingSMS
)- Provider Name:
synology-notifications
- SMS URL:
http://<ip address of synology-notifications service>:8080
- HTTP Method:
POST
- Provider Name:
- Click
Next
to go to theEdit HTTP Request Header
page - Click
Add
and set theParameter
toapi_key
and leaveValue
empty - Click
Next
to go to theEdit HTTP Request Body
page - Click
Add
and set theParameter
tophone_number
and leaveValue
empty (NOTE: Synology requires this field to exist even though it's not used) - Click
Add
and set theParameter
tomessage
set theValue
toHello world
(NOTE: Synology requires a sample value) - Click
Next
to go to theSelect the corrosponding category for each parameter
page - Set the type of the
api_key
Parameter toAPI Key
- Set the type of the
phone_number
Parameter toPhone Number
- Set the type of the
message
Parameter toMessage content
- Click
Apply
- Select
synology-notifications
from theSMS service provider
dropdown - In the
API Key
field paste the API Key you choose for the service - Click
Apply
- Test the notification service by clicking
Send a test SMS message