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

Updated Troubleshooting (markdown)

lead2gold 2019-01-29 14:35:24 -05:00
parent dd075b0e8c
commit 5a3571fc1d
1 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
Troubleshooting.md

@ -8,20 +8,22 @@ python apprise -vvv -t "test title" -b "test body" \
```
The output can help you pinpoint what is wrong with your URL.
If the output appears cryptic, or you feel that you've exhausted all avenues, Don't be afraid to ask here. Just open up a ticket and post the output you got from your debug response. It might be just a simple tweak to your URL that is needed, otherwise we might have a good bug we need to solve.
If the output appears cryptic, or you feel that you've exhausted all avenues, Don't be afraid to [open a ticket and ask here](https://github.com/caronc/apprise/issues). It greatly helps if you share the output received from your debug response. It might be just a simple tweak to your URL that is needed, otherwise we might have a good bug we need to solve.
Just be cautious as the debugging information can potentially expose personal information (such as your password) to the screen. Please remember to erase this or swap it with some random characters before posting such a thing publicly.
Just be cautious as the debugging information can potentially expose personal information (such as your password and/or private access tokens) to the screen. Please remember to erase this or swap it with some random characters before posting such a thing publicly.
## Special Characters and URL Conflicts
Apprise is built around URLs. Unfortunately URLs have pre-reserved characters it uses as delimiters that help distinguish one argument/setting from another.
For example, in a URL, the &, /, and % all have extremely different meanings and if they also reside in your password or user-name, they can cause quite a troubleshooting mess as to why your email isn't working.
For example, in a URL, the **&**, **/**, and **%** all have extremely different meanings and if they also reside in your password or user-name, they can cause quite a troubleshooting mess as to why your notifications aren't working.
Below is a chart of special characters and the value you should set them to; you ONLY need to do this if these values reside in your username and/or password; otherwise they will not cause a problem:
Now there is a workaround: you can replace these characters with special **%XX** character-set (encoded) values. These encoded characters won't cause the URL to be mis-interpreted allowing you to send notifications at will.
Below is a chart of special characters and the value you should set them to; you ONLY need to do this if these values reside in your _username_ and/or _password_; otherwise they will not cause a problem:
### Parameter Breakdown
| Character | Escape Code | Description
| ----------- | -------- | -----------
| **%** | **%25** | The percent sign itself is the magic character that tells anything parsing the URL to read the next few digits after it to determine what the character should actually be. The actual percent (%) character itself can be interpreted as _%25_ from within a URL.
| **%** | **%25** | The percent sign itself is the starting value for defining the %XX character sets.
| **&** | **%26** | The ampersand sign is how a URL knows to stop reading the current variable and move onto the next. If this existed within a password or username, it would only read 'up' to this character. You'll need to escape it if you make use of it.
| _(a space)_ | **%20** | While most URLs will work with the space, it's a good idea to escape it so that it can be clearly read from the URL.
| **/** | **%2F** | The slash is the most commonly used delimiter that exists in a URL and helps define a path and/or location.