github
/
apprise
mirror of https://github.com/caronc/apprise
1
0
Fork 0
Code Issues Releases Wiki Activity

Updated Notify_ntfy (markdown)

master
Chris Caron 2023-02-19 14:07:19 -05:00
parent e669591f43
commit ee40fe0e47
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Notify_ntfy.md

@ -20,6 +20,7 @@ Valid syntax is as follows:
* `ntfy://{user}@{host}:{port}/{topics}`
* `ntfy://{user}:{password}@{host}/{topics}`
* `ntfy://{user}:{password}@{host}:{port}/{topics}`
* `ntfy://{token}@{hostname}/{targets}`
You can specify more then 1 topic such as:
* **ntfy**://**{user}**:**{password}**/**{hostname}**/**{topic1}**/**{topic2}**
@ -32,7 +33,9 @@ You can specify more then 1 topic such as:
| hostname | *No | The ntfy server you're sending your notification to.
| port | No | The port the ntfy server is listening on. By default the port is **80** for **ntfy://** and **443** for all **ntfys://** references.
| topic | Yes | All notifications to a ntfy server MUST have at least one topic defined.
| token | No | This is detected, but can otherwise be explicitly specified as a parameter.
| mode | No | The authentication mode is automatically detected based what it parses from the URL provided. You only need to set this if you feel it is being detected incorrectly. The possible modes are **private** and **cloud** and are explained above.
| auth | No | Can be set to either `basic` (default) or `token` . `basic` is for User/Password authentication with the Ntfy server while `token` assumes that the provided credentials was a Authorization Token and authenticates in a different fashion.
| email | No | An email to associate the ntfy post with.
| tags | No | The ntfy tags to associate with the ntfy post. Use a comma and/or space to specify more then one.
| attach | No | Specify a web URL pointing at a remote attachment you would like the post to reference.
@ -43,6 +46,7 @@ You can specify more then 1 topic such as:
| image | No | This defaults to 'Yes' and hauls in the image associated with the notification
| avatar_url | No | Optionally over-ride the Apprise Icon notifications and explicitly identify your own
#### Example
Send a ntfy notification to our server
```bash