Skip to content

Latest commit

 

History

History
43 lines (37 loc) · 2.23 KB

README.md

File metadata and controls

43 lines (37 loc) · 2.23 KB

synology-notifications

Docker for forwarding notifications to various services written in Python.

Inspired by https://github.com/ryancurrah/synology-notifications

Supports:

  1. Discord

Docker Setup

  1. Add this repo via Docker
  2. Add a WEBHOOK_URL environment variable and set it to your service's url.
    1. For discord, you can find this in Edit channel->Integrations->Webhooks->WebhookName->Copy webhook URL
    2. You can optionally add a USERNAME environment variable to override the webhook's name (Discord only)

Setup for Synology

  1. Add a new SMS provider in Control Panel
  2. Enter your Synology ip followed by the port you've assigned the Docker container to as the URL. e.g. http://<your-synology-ip>:8686
  3. Set HTTP Method to POST
  4. Currently can hit next on Edit HTTP Request Header - future notification endpoints may require things like an API key here
  5. On Edit HTTP Request Body:
    1. Add phone_number parameter; leave the value field empty
    2. Add message parameter; enter hello world as the value
  6. Set the phone_number parameter category to Phone number
  7. Set the message parameter category to Message content
  8. Set the SMS Service provider to your newly created service
  9. Enter in a dummy phone number (it's not used)
  10. Hit apply
  11. Send a test notification to check you receive it

Setup for Synology Surveillance Station

  1. Add a new SMS provider in Notification app
  2. Enter your Synology ip followed by the port you've assigned the Docker container to as the URL. e.g. http://<your-synology-ip>:8686
  3. This time you'll also need to add some url parameters; the value of these parameters don't matter they're just required by Surveillance Station: e.g. 'http://your-synology-ip:8686?user=na&password=na&api_id=na&to=na&text=hello+world'
  4. Set HTTP Method to GET
  5. Set the user parameter category to Username
  6. Set the password parameter category to Password
  7. Set the to parameter category to Phone number
  8. Set the text parameter category to Message content
  9. Set the SMS Service provider to your newly created service
  10. Enter in a dummy username, password and confirm password (it's not used)
  11. Hit apply
  12. Send a test notification to check you receive it