Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ryancurrah/synology-notifications
Synology notifications service
https://github.com/ryancurrah/synology-notifications
diskstation dsm notifcation-service notifications slack synology synology-notifications
Last synced: 9 days ago
JSON representation
Synology notifications service
- Host: GitHub
- URL: https://github.com/ryancurrah/synology-notifications
- Owner: ryancurrah
- Created: 2019-05-24T03:05:26.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-07-22T13:03:18.000Z (over 1 year ago)
- Last Synced: 2024-10-20T21:42:28.286Z (16 days ago)
- Topics: diskstation, dsm, notifcation-service, notifications, slack, synology, synology-notifications
- Language: Go
- Homepage:
- Size: 746 KB
- Stars: 71
- Watchers: 6
- Forks: 9
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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 api
- `LISTEN_PORT`: Default `8080`. The port the service will listen on
## Slack settings
- `SLACK_WEBHOOK`: URL for the Slack web hook
- `SLACK_ATTACHMENT_COLOR`: Color to use for the attachments can use hex `#36a64f`
## Cmd
```bash
export API_KEY='LO45UXS%amLAWJn6CwJ1koaXW&7pY9#Z'
export SLACK_WEBHOOK='https://slack.com/myWebHookUrl'
./synology-notifications
listening on port 8080
```
## 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
listening on port 8080
```
## Setting up Synology
1. Login to Diskstation
2. Go to `Control Pannel` > `Notification` > `SMS`
3. Check `Enable SMS Notifications`
4. Click `Add SMS Provider` to create a new SMS provider which will be the `synology-notifications` service. (**NOTE**: We will not actually be using `SMS`)
1. **Provider Name**: `synology-notifications`
2. **SMS URL**: `http://:8080`
3. **HTTP Method**: `POST`
5. Click `Next` to go to the `Edit HTTP Request Header` page
5. Click `Add` and set the `Parameter` to `api_key` and leave `Value` empty
6. Click `Next` to go to the `Edit HTTP Request Body` page
6. Click `Add` and set the `Parameter` to `phone_number` and leave `Value` empty (**NOTE**: Synology requires this field to exist even though it's not used)
7. Click `Add` and set the `Parameter` to `message` set the `Value` to `Hello world` (**NOTE**: Synology requires a sample value)
8. Click `Next` to go to the `Select the corrosponding category for each parameter` page
8. Set the type of the `api_key` Parameter to `API Key`
9. Set the type of the `phone_number` Parameter to `Phone Number`
10. Set the type of the `message` Parameter to `Message content`
11. Click `Apply`
11. Select `synology-notifications` from the `SMS service provider` dropdown
12. In the `API Key` field paste the API Key you choose for the service
13. Click `Apply`
13. Test the notification service by clicking `Send a test SMS message`
## Setting up Synology with screenshots
