extern/apprise
1
0
Fork 0
mirror of https://github.com/caronc/apprise.git synced 2025-08-23 14:35:55 +02:00
Code Issues Packages Projects Releases Wiki Activity

Updated config_yaml (markdown)

Chris Caron
2019-09-30 12:26:19 -04:00
parent 5293203c3d
commit 3bdc03f00b
1 changed files with 11 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
config_yaml.md

@@ -1,5 +1,7 @@
## YAML Based Configuration Files ## YAML Based Configuration Files
YAML Support offers a much more advance use then what is provided by the TEXT format. Here is the configuration in it's absolute simplest form: YAML Support offers a much more advance use then what is provided by the TEXT format. Apprise expects configuration files to be found with the extension of `.yml` or `.yaml`.
Here is a configuration example in it's absolute simplest form:
```yaml ```yaml
# #
# Minimal Configuration Example # Minimal Configuration Example
@@ -111,3 +113,11 @@ urls:
``` ```
For details on how to use this configuration file [[click here|config]]. For details on how to use this configuration file [[click here|config]].
## YAML Web Based Hosting
Apprise can retrieve configuration files from over a network as well using the HTTP protocol.
For HTTP requests, the **Content-Type** HTTP Header (_which defines Mime Type_) is very important. Apprise will parse remote network hosted configuration files as YAML so long as you're using one of the following **Content-Type** entries:
* `text/yaml`
* `text/x-yaml`
* `application/yaml`
* `application/x-yaml`