extern/apprise
1
0
Fork 0
mirror of https://github.com/caronc/apprise.git synced 2024-12-13 10:21:51 +01:00
Code Issues Packages Projects Releases Wiki Activity

Updated config_text (markdown)

Chris Caron 2020-09-04 10:21:39 -04:00
parent 5cf2e6791a
commit 3a7bce9d53
1 changed files with 43 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
config_text.md

@ -28,6 +28,49 @@ tv,kitchen=kodi://myuser:mypass@kitchen.hostame
tv,basement=kodi://myuser:mypass@basement.hostame
```
## Expanding Configuration Sources
The TEXT based configuration also supports the keyword `include` which allows you to pull more configuration down from other locations. For example:
```apache
# Perhaps this is your default configuration that is always read
# stored in ~/.config/apprise (or ~/.apprise)
# The following could import all of the configuration located on your
# Apprise API:
include http://localhost:8080/get/apprise
```
From there you can easily use the CLI tool from the command line while managing your configuration remotely:
```bash
# automatically reads our above configuration
# Which further imports our additional configuration entries:
apprise -vv -t "my title" -b "my message body"
```
You can freely mix/match include statements and Apprise URLs as well, for example:
```apache
# Our config file located in ~/.config/apprise (or ~/.apprise)
# Our imports
include http://localhost:8080/get/apprise
# A relative config file import (relative to 'this' configuration file)
include more_configuration.cfg
# Absolute path inclusion works well too:
include /etc/apprise/cfg
# you can still include your other URLs here too
mailto://someone:theirpassword@gmail.com
# as always, it's recommended you tag everything and then just
# use the --tag (or -g) switch to access the entries. This
# is especially important if you're going to start storing your
# configuration elsewhere too!
devops=slack://tokenA/tokenB/TokenC
```
All loaded configuration files can also contain the `include` keyword as well. But by default they `include` recursion only happens at 1 level. If you want to allow more files to be included, you need to specify `--recursion-depth` (`-R`) and set it to the number of recursive levels you will allow the include to occur for. By default this is set to 1 with the `apprise` tool.
## Web Hosted TEXT Configuration
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 TEXT so long as you're using one of the following **Content-Type** entries: