From 45ea5dbe9474a26699fb8bd81ff2d5a7c83756a6 Mon Sep 17 00:00:00 2001 From: Chris Caron Date: Sun, 19 Nov 2023 11:00:30 -0500 Subject: [PATCH] Created Notify_synology (markdown) --- Notify_synology.md | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 Notify_synology.md diff --git a/Notify_synology.md b/Notify_synology.md new file mode 100644 index 0000000..e38a4cd --- /dev/null +++ b/Notify_synology.md @@ -0,0 +1,41 @@ +## Synology Notifications +* **Source**: https://kb.synology.com/en-au/DSM/help/Chat/chat_integration?version=7 +* **Icon Support**: No +* **Message Format**: Text +* **Message Limit**: not set + +Bark is an iOS App which allows you to push custom notifications to your iPhone. + +### Syntax +Valid syntax is as follows: +* `synology://{hostname}}/{token}` +* `synology://{hostname}:{port}/{token}` +* `synology://{user}:{password}@{hostname}/{token}` +* `synology://{user}:{password}@{hostname}:{port}/{token}` + +The secure versions (https): +* `synologys://{hostname}/{token}` +* `synologys://{hostname}:{port}/{token}` +* `synologys://{user}:{password}@{hostname}/{token}` +* `synologys://{user}:{password}@{hostname}:{port}/{token}` + +### Parameter Breakdown +| Variable | Required | Description +| ----------- | -------- | ----------- +| hostname | Yes | The Web Server's hostname +| token | Yes | The Synology Chat Incoming Token generated +| port | No | The port our Web server is listening on. By default the port is **80** for **synology://** and **443** for all **synologys://** references. +| user | No | If you're system is set up to use HTTP-AUTH, you can provide _username_ for authentication to it. +| password | No | If you're system is set up to use HTTP-AUTH, you can provide _password_ for authentication to it. +| file_url | No | Synology allows you to directly link to a URL containing an attachment. If you set this on the Apprise URL, it will be passed down to the synology request made under the hood. + +#### Example +Send a Synology notification to all devices associated with a project: +```bash +# Assume: +# - our {hostname} is synology.home.arpa +# - our {port} is 5000 +# - our {token} is j300012fl9y0b5AW9g9Nsejb8P +apprise -vv -t "Test Message Title" -b "Test Message Body" \ + synology://synology.home.arpa:5000/j300012fl9y0b5AW9g9Nsejb8P +``` \ No newline at end of file