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

Updated Notify_Custom_XML (markdown)

master
Chris Caron 2019-09-07 16:47:52 -04:00
parent 2ee8d50ca5
commit bab2fcbbd6
1 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
Notify_Custom_XML.md

@ -31,16 +31,22 @@ The *MessageType* will be one of the following:
### Syntax ### Syntax
Valid syntaxes are as follows: Valid syntaxes are as follows:
* **xml**://**{hostname}** * `xml://{hostname}`
* **xml**://**{hostname}**:**{port}** * `xml://{hostname}:{port}`
* **xmls**://**{hostname}** * `xml://{user}:{password}@{hostname}`
* **xmls**://**{hostname}**:**{port}** * `xml://{user}:{password}@{hostname}:{port}`
* `xmls://{hostname}`
* `xmls://{hostname}:{port}`
* `xmls://{user}:{password}@{hostname}`
* `xmls://{user}:{password}@{hostname}:{port}`
### Parameter Breakdown ### Parameter Breakdown
| Variable | Required | Description | Variable | Required | Description
| ----------- | -------- | ----------- | ----------- | -------- | -----------
| hostname | Yes | The Web Server's hostname | 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. | 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 XML notification to our web server listening on port 80: Send a XML notification to our web server listening on port 80: