This image adds e-mail notifications with msmtp to the docker-borgmatic container.
For general usage instructions see the README of the base image.
To setup e-mail notifications follow these steps:
- Add your mail relay details to the
msmtp.env
and place it in the borgmatic.d directory. 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 yourcrontab.txt
. - Edit your
crontab.txt
to match the upstream file. - Extend the environment in
msmtp.env
to containMAIL_TO
andMAIL_SUBJECT
.
Set your mail configuration in msmtp.env
:
Key | Description |
---|---|
MAIL_RELAY_HOST |
IP or hostname of the mail relay (SMTP server) |
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_TO |
Recipients for e-mail notifications |
MAIL_SUBJECT |
Subject line for e-mail notifications |