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

improved documentation

pull/1231/head
Chris Caron 2024-10-27 13:53:43 -04:00
parent 4d5911a2c5
commit a309f9c557
2 changed files with 15 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -655,6 +655,17 @@ aobj = Apprise(asset=asset)
For more information on persistent storage, [visit here](https://github.com/caronc/apprise/wiki/persistent_storage). For more information on persistent storage, [visit here](https://github.com/caronc/apprise/wiki/persistent_storage).
# CLI Environment Variables
Those using the Command Line Interface (CLI) can also leverage environment variables to pre-set the default settings:
| Variable | Description |
|------------------------ | ----------------- |
| `APPRISE_URLS` | Specify the default URLs to notify IF none are otherwise specified on the command line explicitly. If the `--config` (`-c`) is specified, then this will over-rides any reference to this variable. Use white space and/or a comma (`,`) to delimit multiple entries.
| `APPRISE_CONFIG_PATH` | Explicitly specify the config search path to use (over-riding the default). The path(s) defined here must point to the absolute filename to open/reference. Use a semi-colon (`;`), line-feed (`\n`), and/or carriage return (`\r`) to delimit multiple entries.
| `APPRISE_PLUGIN_PATH` | Explicitly specify the custom plugin search path to use (over-riding the default). Use a semi-colon (`;`), line-feed (`\n`), and/or carriage return (`\r`) to delimit multiple entries.
| `APPRISE_STORAGE_PATH` | Explicitly specify the persistent storage path to use (over-riding the default).
# Want To Learn More? # Want To Learn More?
If you're interested in reading more about this and other methods on how to customize your own notifications, please check out the following links: If you're interested in reading more about this and other methods on how to customize your own notifications, please check out the following links:

7
packaging/man/apprise.md
View File

@ -295,15 +295,16 @@ configuration that you want and only specifically notify a subset of them:
## ENVIRONMENT VARIABLES ## ENVIRONMENT VARIABLES
`APPRISE_URLS`: `APPRISE_URLS`:
Specify the default URLs to notify if none are otherwise specified on the command line. Specify the default URLs to notify IF none are otherwise specified on the command line
Use white space and/or a comma (`,`) to delimit multiple entries. explicitly. If the `--config` (`-c`) is specified, then this will over-rides any
reference to this variable. Use white space and/or a comma (`,`) to delimit multiple entries.
`APPRISE_CONFIG_PATH`: `APPRISE_CONFIG_PATH`:
Explicitly specify the config search path to use (over-riding the default). Explicitly specify the config search path to use (over-riding the default).
Use a semi-colon (`;`), line-feed (`\n`), and/or carriage return (`\r`) to delimit multiple entries. Use a semi-colon (`;`), line-feed (`\n`), and/or carriage return (`\r`) to delimit multiple entries.
`APPRISE_PLUGIN_PATH`: `APPRISE_PLUGIN_PATH`:
Explicitly specify the plugin search path to use (over-riding the default). Explicitly specify the custom plugin search path to use (over-riding the default).
Use a semi-colon (`;`), line-feed (`\n`), and/or carriage return (`\r`) to delimit multiple entries. Use a semi-colon (`;`), line-feed (`\n`), and/or carriage return (`\r`) to delimit multiple entries.
`APPRISE_STORAGE_PATH`: `APPRISE_STORAGE_PATH`: