mirror of https://github.com/caronc/apprise
Updated Notify_notica (markdown)
parent
f3fff86052
commit
cb55f0b10e
|
@ -22,10 +22,27 @@ Valid syntaxes are as follows:
|
||||||
* `https://notica.us/?{token}`
|
* `https://notica.us/?{token}`
|
||||||
* `notica://{token}`
|
* `notica://{token}`
|
||||||
|
|
||||||
|
For self hosted solutions, you can use the following:
|
||||||
|
* `{schema}://{host}/{token}`
|
||||||
|
* `{schema}://{host}:{port}/{token}`
|
||||||
|
* `{schema}://{user}@{host}/{token}`
|
||||||
|
* `{schema}://{user}@{host}:{port}/{token}`
|
||||||
|
* `{schema}://{user}:{password}@{host}/{token}`
|
||||||
|
* `{schema}://{user}:{password}@{host}:{port}/{token}`
|
||||||
|
|
||||||
### Parameter Breakdown
|
### Parameter Breakdown
|
||||||
| Variable | Required | Description
|
| Variable | Required | Description
|
||||||
| ----------- | -------- | -----------
|
| ----------- | -------- | -----------
|
||||||
| token | Yes | The Token that was generated for you after visiting their [website](https://notica.us/).
|
| token | Yes | The Token that was generated for you after visiting their [website](https://notica.us/). Alternatively this should be the token used by your self hosted solution.
|
||||||
|
|
||||||
|
A self hosted solution allows for a few more parameters:
|
||||||
|
|
||||||
|
| Variable | Required | Description
|
||||||
|
| ----------- | -------- | -----------
|
||||||
|
| hostname | Yes | The Web Server's hostname.
|
||||||
|
| port | No | The port our Web server is listening on. By default the port is **80** for **xml://** and **443** for all **xmls://** 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.
|
||||||
|
|
||||||
#### Example
|
#### Example
|
||||||
Send a notica notification:
|
Send a notica notification:
|
||||||
|
@ -34,3 +51,23 @@ Send a notica notification:
|
||||||
|
|
||||||
apprise notica://abc123
|
apprise notica://abc123
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Header Manipulation
|
||||||
|
Self-hosted solutions may require users to set special HTTP headers when they post their data to their server. This can be accomplished by just sticking a hyphen (**-**) in front of any parameter you specify on your URL string.
|
||||||
|
```bash
|
||||||
|
# Below would set the header:
|
||||||
|
# X-Token: abcdefg
|
||||||
|
#
|
||||||
|
# Assuming our {hostname} is localhost
|
||||||
|
# Assuming our {token} is abc123
|
||||||
|
apprise "notica://localhost/abc123/?-X-Token=abcdefg"
|
||||||
|
|
||||||
|
# Multiple headers just require more entries defined with a hyphen in front:
|
||||||
|
# Below would set the headers:
|
||||||
|
# X-Token: abcdefg
|
||||||
|
# X-Apprise: is great
|
||||||
|
#
|
||||||
|
# Assuming our {hostname} is localhost
|
||||||
|
# Assuming our {token} is abc123
|
||||||
|
apprise "notica://localhost/abc123/?-X-Token=abcdefg&-X-Apprise=is%20great"
|
||||||
|
```
|
Loading…
Reference in New Issue