msmtp: README.md: Adjust documentation for new notification script and settings

pull/102/head
Frieder Schrempf 2022-03-20 23:09:24 +01:00
rodzic b90fc3c88a
commit 49ef249675
Nie znaleziono w bazie danych klucza dla tego podpisu
ID klucza GPG: E7DD51F45F833802
1 zmienionych plików z 18 dodań i 10 usunięć

Wyświetl plik

@ -10,15 +10,21 @@ the docker-borgmatic container.
For general usage instructions see the [README](../base/README.md) of the base
image.
If you want to send the backup results from cron via mail:
* Add your mail relay details to the [msmtp.env](msmtp.env.template) or mount
your own
[msmtprc](https://wiki.alpinelinux.org/wiki/Relay_email_to_gmail_(msmtp,_mailx,_sendmail)
to `/etc/msmtprc`.
* Add your recipient mail address to `crontab.txt` by editing the line
`MAILTO=log@example.com`.
* Please note that logs will no longer end up in Docker logs when `MAILTO` is
set.
To setup e-mail notifications follow these steps:
* Add your mail relay details to the [msmtp.env](msmtp.env.template). See
the list of environment variables below.
* Restart the container to apply the changes.
For those who update the image from `v1.1.17-1.5.23` or below, you might want to
migrate to the new e-mail notification script that provides you proper subject
lines and adds further possibilities to use the environment for configuration:
* Remove the `MAILTO` from your `crontab.txt`.
* Edit your `crontab.txt` to match the [upstream file](data/borgmatic.d/crontab.txt).
* Add the [`env.sh`](data/borgmatic.d/env.sh) and
`run.sh`(data/borgmatic.d/run.sh).
* Extend the environment in `msmtp.env` to contain `MAIL_TO` and `MAIL_SUBJECT`.
### Environment
@ -30,4 +36,6 @@ Set your mail configuration in `msmtp.env`:
| `MAIL_PORT` | SMTP port of the mail relay |
| `MAIL_USER` | Username for SMTP login |
| `MAIL_PASSWORD` | Password for SMTP login |
| `MAIL_FROM` | From address for e-mail notifications |
| `MAIL_FROM` | From address for e-mail notifications |
| `MAIL_TO` | Recipients for e-mail notifications |
| `MAIL_SUBJECT` | Subject line for e-mail notifications |