From e6f19d050f03aea095e61c12176020e9cb39949b Mon Sep 17 00:00:00 2001 From: Philipp Heckel Date: Fri, 18 Mar 2022 17:34:14 -0400 Subject: [PATCH] Updated examples, release notes --- docs/examples.md | 191 ++++++++++++++++++++++++++++++++++++++++++----- docs/releases.md | 8 +- 2 files changed, 178 insertions(+), 21 deletions(-) diff --git a/docs/examples.md b/docs/examples.md index f6e76eec..7dbbdc3d 100644 --- a/docs/examples.md +++ b/docs/examples.md @@ -126,31 +126,186 @@ GitHub have been hopeless. In case it ever becomes available, I want to know imm ``` ## Download notifications (Sonarr, Radarr, Lidarr, Readarr, Prowlarr, SABnzbd) - It's possible to use custom scripts for all the *arr services, plus SABnzbd. Notifications for downloads, warnings, grabs etc. - -Some simple bash scripts to achieve this are available here +Some simple bash scripts to achieve this are kindly provided in [nickexyz's repository](https://github.com/nickexyz/ntfy-shellscripts). ## Node-RED +You can use the HTTP request node to send messages with [Node-RED](https://nodered.org), some examples: -You can use the HTTP request node to send messages with Node-RED, some examples: - -Send a message:
- Flow example - - ``` -[{"id":"8f09d37dd5773f88","type":"http request","z":"ff3ad4e1.d3415","name":"ntfy","method":"POST","ret":"txt", "paytoqs":"ignore","url":"https://example.com/topic","tls":"","persist":false,"proxy":"","authType":"","senderr":false,"credentials":{},"x":1410,"y":740,"wires":[[]]},{"id":"2603f296b25fe351","type":"function","z":"ff3ad4e1.d3415","name":"data","func":"msg.payload = \"Something happened\";\nmsg.headers = {};\nmsg.headers['tags'] = 'house';\nmsg.headers['X-Title'] = 'Home Assistant';\n\nreturn msg;","outputs":1,"noerr":0,"initialize":"","finalize":"","libs":[],"x":1290,"y":740,"wires":[["8f09d37dd5773f88"]]},{"id":"d2351ed0720a239f","type":"inject","z":"ff3ad4e1.d3415","name":"Manual start","props":[{"p":"payload"},{"p":"topic","vt":"str"}],"repeat":"","crontab":"","once":false,"onceDelay":"20","topic":"","payload":"","payloadType":"date","x":1150,"y":740,"wires":[["2603f296b25fe351"]]}] - ``` +Example: Send a message +``` +[ + { + "id": "8f09d37dd5773f88", + "type": "http request", + "z": "ff3ad4e1.d3415", + "name": "ntfy", + "method": "POST", + "ret": "txt", + "paytoqs": "ignore", + "url": "https://example.com/topic", + "tls": "", + "persist": false, + "proxy": "", + "authType": "", + "senderr": false, + "credentials": {}, + "x": 1410, + "y": 740, + "wires": [ + [] + ] + }, + { + "id": "2603f296b25fe351", + "type": "function", + "z": "ff3ad4e1.d3415", + "name": "data", + "func": "msg.payload = \"Something happened\";\nmsg.headers = {};\nmsg.headers['tags'] = 'house';\nmsg.headers['X-Title'] = 'Home Assistant';\n\nreturn msg;", + "outputs": 1, + "noerr": 0, + "initialize": "", + "finalize": "", + "libs": [], + "x": 1290, + "y": 740, + "wires": [ + [ + "8f09d37dd5773f88" + ] + ] + }, + { + "id": "d2351ed0720a239f", + "type": "inject", + "z": "ff3ad4e1.d3415", + "name": "Manual start", + "props": [ + { + "p": "payload" + }, + { + "p": "topic", + "vt": "str" + } + ], + "repeat": "", + "crontab": "", + "once": false, + "onceDelay": "20", + "topic": "", + "payload": "", + "payloadType": "date", + "x": 1150, + "y": 740, + "wires": [ + [ + "2603f296b25fe351" + ] + ] + } +] +```
-Send a picture:
- Flow example - - ``` -[{"id":"726d0d75d6c0f70e","type":"http request","z":"ff3ad4e1.d3415","name":"Download jpeg","method":"GET","ret":"bin","paytoqs":"ignore","url":"https://www.google.com/images/branding/googlelogo/1x/googlelogo_color_272x92dp.png","tls":"","persist":false,"proxy":"","authType":"","senderr":false,"credentials":{},"x":1320,"y":780,"wires":[["730dbbc9dbf1ed8a"]]},{"id":"730dbbc9dbf1ed8a","type":"function","z":"ff3ad4e1.d3415","name":"data","func":"msg.payload = msg.payload;\nmsg.headers = {};\nmsg.headers['tags'] = 'house';\nmsg.headers['X-Title'] = 'Home Assistant - Picture';\n\nreturn msg;","outputs":1,"noerr":0,"initialize":"","finalize":"","libs":[],"x":1470,"y":780,"wires":[["592f424b37f76f5c"]]},{"id":"592f424b37f76f5c","type":"http request","z":"ff3ad4e1.d3415","name":"ntfy","method":"PUT","ret":"bin","paytoqs":"ignore","url":"https://example.com/topic","tls":"","persist":false,"proxy":"","authType":"","senderr":false,"x":1590,"y":780,"wires":[[]]},{"id":"8aa06dda3c902f6a","type":"inject","z":"ff3ad4e1.d3415","name":"Manual start","props":[{"p":"payload"},{"p":"topic","vt":"str"}],"repeat":"","crontab":"","once":false,"onceDelay":"20","topic":"","payload":"","payloadType":"date","x":1150,"y":780,"wires":[["726d0d75d6c0f70e"]]}] - ``` +Example: Send a picture +``` +[ + { + "id": "726d0d75d6c0f70e", + "type": "http request", + "z": "ff3ad4e1.d3415", + "name": "Download jpeg", + "method": "GET", + "ret": "bin", + "paytoqs": "ignore", + "url": "https://www.google.com/images/branding/googlelogo/1x/googlelogo_color_272x92dp.png", + "tls": "", + "persist": false, + "proxy": "", + "authType": "", + "senderr": false, + "credentials": {}, + "x": 1320, + "y": 780, + "wires": [ + [ + "730dbbc9dbf1ed8a" + ] + ] + }, + { + "id": "730dbbc9dbf1ed8a", + "type": "function", + "z": "ff3ad4e1.d3415", + "name": "data", + "func": "msg.payload = msg.payload;\nmsg.headers = {};\nmsg.headers['tags'] = 'house';\nmsg.headers['X-Title'] = 'Home Assistant - Picture';\n\nreturn msg;", + "outputs": 1, + "noerr": 0, + "initialize": "", + "finalize": "", + "libs": [], + "x": 1470, + "y": 780, + "wires": [ + [ + "592f424b37f76f5c" + ] + ] + }, + { + "id": "592f424b37f76f5c", + "type": "http request", + "z": "ff3ad4e1.d3415", + "name": "ntfy", + "method": "PUT", + "ret": "bin", + "paytoqs": "ignore", + "url": "https://example.com/topic", + "tls": "", + "persist": false, + "proxy": "", + "authType": "", + "senderr": false, + "x": 1590, + "y": 780, + "wires": [ + [] + ] + }, + { + "id": "8aa06dda3c902f6a", + "type": "inject", + "z": "ff3ad4e1.d3415", + "name": "Manual start", + "props": [ + { + "p": "payload" + }, + { + "p": "topic", + "vt": "str" + } + ], + "repeat": "", + "crontab": "", + "once": false, + "onceDelay": "20", + "topic": "", + "payload": "", + "payloadType": "date", + "x": 1150, + "y": 780, + "wires": [ + [ + "726d0d75d6c0f70e" + ] + ] + } +] +```
## Gatus service health check @@ -159,7 +314,7 @@ An example for a custom alert with Gatus ``` alerting: custom: - url: "https://example.com" + url: "https://ntfy.sh" method: "POST" body: | { diff --git a/docs/releases.md b/docs/releases.md index bed1d890..dd2120e8 100644 --- a/docs/releases.md +++ b/docs/releases.md @@ -16,10 +16,12 @@ and the [ntfy Android app](https://github.com/binwiederhier/ntfy-android/release ## ntfy server v1.19.0 (UNRELEASED) -**Bug fixes & documentation:** +**Documentation:** -* Fix install instructions (thanks to [@Fallenbagel](https://github.com/Fallenbagel) for reporting) -* Additional examples (thanks to [@nickexyz](https://github.com/nickexyz)) +* Overhaul of [developer documentation](https://ntfy.sh/docs/develop/) +* PowerShell examples for [publish documentation](https://ntfy.sh/docs/publish/) ([#138](https://github.com/binwiederhier/ntfy/issues/138), thanks to [@Joeharrison94](https://github.com/Joeharrison94)) +* Additional examples for [NodeRED, Gatus, Sonarr, Radarr, ...](https://ntfy.sh/docs/examples/) (thanks to [@nickexyz](https://github.com/nickexyz)) +* Fixes in developer instructions (thanks to [@Fallenbagel](https://github.com/Fallenbagel) for reporting) -->