extern/apprise
1
0
Fork 0
mirror of https://github.com/caronc/apprise.git synced 2025-08-03 06:09:10 +02:00
Code Issues Packages Projects Releases Wiki Activity

Updated config_text (markdown)

Chris Caron
2019-09-30 12:36:36 -04:00
parent 1a76a9c8a6
commit 8a145cc997
1 changed files with 17 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
config_text.md

@ -1,5 +1,13 @@
## Text Based Configuration Files
The TEXT Based configuration files are pretty straight forward. You just provide a list of your notification URLs. For details on how to use this configuration file [[click here|config]].
## Text Based Apprise Configuration
The TEXT Based configuration files are pretty straight forward and very easy to work with. You just provide a list of your notification URLs like so.
```apache
# Use pound/hashtag (#) characters to comment lines
# Here is an example of a very basic entry (without tagging):
mailto://someone:theirpassword@gmail.com
slack://token_a/token_b/token_c
```
Tagging is a very feature-rich aspect of Apprise, and you can easily associate tags with your URLs by just placing them before your URL you define. If you want to specify more then one tag, just separate them with a space and/or comma.
```apache
# Use pound/hashtag (#) characters to comment lines
# The syntax is <tags>=<url> or just <url> on each line
@ -18,4 +26,10 @@ desktop=gnome://
# notification service URL:
tv,kitchen=kodi://myuser:mypass@kitchen.hostame
tv,basement=kodi://myuser:mypass@basement.hostame
```
```
## 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:
- `text/plain`
- `text/html`