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

Updated Notify_gotify (markdown)

master
Chris Caron 2020-07-27 11:18:18 -04:00
parent 0915ea8ce3
commit 913189b78e
1 changed files with 17 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
Notify_gotify.md

@ -6,10 +6,12 @@
### Syntax ### Syntax
Valid syntaxes are as follows: Valid syntaxes are as follows:
* **gotify**://**{hostname}**/**{token}** * `gotify://{hostname}/{token}`
* **gotifys**://**{hostname}**/**{token}** * `gotifys://{hostname}/{token}`
* **gotifys**://**{hostname}**:**{port}**/**{token}** * `gotifys://{hostname}:{port}/{token}`
* **gotifys**://**{hostname}**/**{token}**/?**priority=high** * `gotifys://{hostname}/{path}/{token}`
* `gotifys://{hostname}:{port}/{path}/{token}`
* `gotifys://{hostname}/{token}/?priority=high`
Secure connections (via https) should be referenced using **gotifys://** where as insecure connections (via http) should be referenced via **gotify://**. Secure connections (via https) should be referenced using **gotifys://** where as insecure connections (via http) should be referenced via **gotify://**.
@ -19,6 +21,7 @@ Secure connections (via https) should be referenced using **gotifys://** where a
| hostname | Yes | The Rocket.Chat server you're sending your notification to. | hostname | Yes | The Rocket.Chat server you're sending your notification to.
| token | Yes | The Application Token you generated on your Gotify Server | token | Yes | The Application Token you generated on your Gotify Server
| port | No | The port the Gotify server is listening on. By default the port is **80** for **gotify://** and **443** for all **gotifys://** references. | port | No | The port the Gotify server is listening on. By default the port is **80** for **gotify://** and **443** for all **gotifys://** references.
| path | No | For those that host their Gotify server on a hostname that requires you to specify an additional path prefix may just include this as part of their URL string (the default is '**/**'). What is important here is the final entry of your URL must still be the _token_.
| priority | No | The priority level to pass the message along as. Possible values are **low**, **moderate**, **normal**, and **high**. If no priority is specified then **normal** is used. | priority | No | The priority level to pass the message along as. Possible values are **low**, **moderate**, **normal**, and **high**. If no priority is specified then **normal** is used.
#### Example #### Example
@ -26,7 +29,16 @@ Send a Gotify message:
```bash ```bash
# Assuming our {hostname} is localhost # Assuming our {hostname} is localhost
# Assuming our {token} is abcdefghijklmn # Assuming our {token} is abcdefghijklmn
apprise gotify://gotify.server.local/abcdefghijklmn apprise -t "Test Message Title" -b "Test Message Body" \
gotify://gotify.server.local/abcdefghijklmn
# If your server is being hosted elsewhere and requires you to specify an
# additional path to get to it, you can notify it as follows:
# Assuming our {hostname} is localhost
# Assuming our {token} is abcdefghijklmn
# Assuming our {path} is /my/gotify/path/
apprise -t "Test Message Title" -b "Test Message Body" \
gotify://gotify.server.local/my/gotify/path/abcdefghijklmn
``` ```
## Setup ## Setup