mirror of https://github.com/caronc/apprise
Created Notify_ntfy (markdown)
parent
ef18738020
commit
293c53e3b3
|
@ -0,0 +1,51 @@
|
||||||
|
## Prowl Notifications
|
||||||
|
* **Source**: https://ntfy.sh/
|
||||||
|
* **Icon Support**: No
|
||||||
|
* **Attachment Support**: yes
|
||||||
|
* **Message Format**: Text
|
||||||
|
* **Message Limit**: 32768 Characters per message
|
||||||
|
|
||||||
|
[Ntfy](https://ntfy.sh/) is a easy to use messaging service.
|
||||||
|
|
||||||
|
### Syntax
|
||||||
|
Ntfy can send notifications through the following **modes**:
|
||||||
|
* **private**: A locally hosted private server ([github source](https://github.com/binwiederhier/ntfy))
|
||||||
|
* **cloud**: A setup pointing to https://ntfy.sh
|
||||||
|
|
||||||
|
Valid syntax is as follows:
|
||||||
|
* `ntfy://{topic}`
|
||||||
|
* `ntfy://{host}/{topic}`
|
||||||
|
* `ntfy://{host}:{port}/{topics}`
|
||||||
|
* `ntfy://{user}@{host}/{topics}`
|
||||||
|
* `ntfy://{user}@{host}:{port}/{topics}`
|
||||||
|
* `ntfy://{user}:{password}@{host}/{topics}`
|
||||||
|
* `ntfy://{user}:{password}@{host}:{port}/{topics}`
|
||||||
|
|
||||||
|
You can specify more then 1 topic such as:
|
||||||
|
* **ntfy**://**{user}**:**{password}**/**{hostname}**/**{topic1}**/**{topic2}**
|
||||||
|
|
||||||
|
### Parameter Breakdown
|
||||||
|
| Variable | Required | Description
|
||||||
|
| ----------- | -------- | -----------
|
||||||
|
| user | *No | The user account to perform the authentication with
|
||||||
|
| password | *No | The password to perform the authentication with
|
||||||
|
| 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.
|
||||||
|
| 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.
|
||||||
|
|
||||||
|
#### Example
|
||||||
|
Send a ntfy notification to our server
|
||||||
|
```bash
|
||||||
|
# Assuming our {hostname} is localhost
|
||||||
|
# Assuming our {topic} is great-place
|
||||||
|
apprise -vv -t "Test Message Title" -b "Test Message Body" \
|
||||||
|
ntfy://localhost/great-place
|
||||||
|
```
|
||||||
|
|
||||||
|
We can also send a notification to the ntfy.sh server:
|
||||||
|
```bash
|
||||||
|
# Assuming our {topic} is great-place
|
||||||
|
apprise -vv -t "Test Message Title" -b "Test Message Body" \
|
||||||
|
ntfy://great-place
|
||||||
|
```
|
Loading…
Reference in New Issue