extern/apprise
1
0
Fork 0
mirror of https://github.com/caronc/apprise.git synced 2025-07-31 13:05:44 +02:00
Code Issues Packages Projects Releases Wiki Activity

Updated Troubleshooting (markdown)

Chris Caron
2019-08-13 16:34:54 -04:00
parent c3ac9724c0
commit f2e470c667
1 changed files with 24 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
Troubleshooting.md

@ -12,6 +12,30 @@ If the output appears cryptic, or you feel that you've exhausted all avenues, Do
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.
## To Much Data and Overflow Directive
Out of the box, apprise passes _everything_ you give it right along to the source. Some sources can handle a large surplus of data; others might not deal with it as well and just not post anything at all.
Apprise has a somewhat non-elegant way of handling this situation; but it's much better than nothing. You simply need to tack on the **overflow** switch somewhere in your Apprise URL; for example:
* `schema://path/?overflow=split`
* `schema://path/?overflow=truncate`
* `schema://path/?overflow=upstream`
* `schema://path/?other=options&more=settings&overflow=split`
The possible **overflow=** options are defined as:
| Variable | Description
| ----------- | ----------- |
| **split** | This will break the message body (and title if required) into as many smaller chunks (based on the confines of the service itself) and send out multiple messages in order to deliver everything.<br/><br/>For example, Twitter restricts public tweets to 280 characters. If your Apprise/Twitter URL was updated to look like `twitter://<auth data>/?overflow=split`, A message of say 1000 characters would be broken (and sent) via 4 smaller messages (280 + 280 + 280 + 160).
| **truncate** | This just ensures that regardless of how much content you're sending to an remote notification service, all of it's contents will be truncated to fit within a single message. This means that any data that exceeds the maximum message side will just be removed for the message itself.
| **upstream** | This is the default configuration.
Please note that the **overflow=** option isn't a perfect solution:
* It can fail for services like Telegram which can take content in the format of both _HTML_ and _Markdown_. If you're using _HTML_, then there is a very strong possibility that both the upstream and/or truncate option could cut your message in the middle of an un-closed HTML tag. Telegram doesn't fair to well to this and in the past (at the time of writing this wiki entry) would error and not display the data.
* It doesn't elegantly wrap/truncate messages the end of a word (near the message limits). It just makes a cut right at the limit itself. Similarly with `?overflow=split` this hard cut happens throughout all of the messages needed to still send all of the content needed.
* The `overflow=split` can work against you too, especially if you're using apprise to send thousands of log entries accidentally to you via a SMS message. Be prepared to get hundreds of text messages to re-construct all of the data you asked it to deliver! :wink:
So while this is a viable solution for most services; consider that it may not work perfectly for all.
## 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.