Skip to content

Commit

Permalink
Documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
joergschultzelutter committed Dec 20, 2021
1 parent 14b7f14 commit c3c15a0
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions docs/INSTALLATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,11 @@

## Requirements

- DAPNET, Telegram and/or email account access credentials are required.
- For APRS tracking (``follow-the-ham`` option), a valid aprs.fi access key is required
- For automated translations, a free deepl.com API license key is required.
- DAPNET, Telegram and/or email account access credentials are required.
- DAPNET: [https://hampager.de/dokuwiki/doku.php](https://hampager.de/dokuwiki/doku.php)
- Telegram: create your own bot. See e.g. [https://sarafian.github.io/low-code/2020/03/24/create-private-telegram-chatbot.html](https://sarafian.github.io/low-code/2020/03/24/create-private-telegram-chatbot.html)
- For APRS tracking (``follow-the-ham`` option), a valid aprs.fi access key is required. Get it here: [https://aprs.fi/page/api](https://aprs.fi/page/api)
- For automated translations, a free deepl.com API license key is required which can be obtained here: [https://www.deepl.com/pro-api?cta=header-pro-api](https://www.deepl.com/pro-api?cta=header-pro-api)

## General instructions

Expand Down Expand Up @@ -59,9 +61,11 @@ will automatically ___disable___ the program option that is associated with this

### IMAP garbage collector

:bangbang::bangbang::bangbang: Potential loss of IMAP data :bangbang::bangbang::bangbang:
:bangbang::bangbang::bangbang: __Potential loss of IMAP data - READ THIS CAREFULLY__ :bangbang::bangbang::bangbang:

The use of a separate email account for generating messages is __strongly__ recommended, __especially__ if you activate the IMAP garbage collector by specifying a value for ``imap_mail_retention_max_days`` that is different to zero. When activated, the garbage collector will delete ALL of your mails in your 'Sent' mailbox, __regardless of who created them__. If you don't care about the generated emails in your account, keep the garbage collector's default setting of ```0``` days which will deactivate the GC process.
The use of a separate email account for generating messages is __strongly__ recommended, __especially__ if you activate the IMAP garbage collector by specifying a value for ``imap_mail_retention_max_days`` that is different to zero.

When activated, the garbage collector will delete ALL of your mails in your 'Sent' mailbox, __regardless of who created them__. If you don't care about the generated emails in your account, keep the garbage collector's default setting of ```0``` days which will deactivate the GC process.

### Config file template

Expand Down

0 comments on commit c3c15a0

Please sign in to comment.