Skip to content

Commit

Permalink
readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
tetricky committed Oct 3, 2022
1 parent f779e99 commit a23c96d
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 21 deletions.
29 changes: 10 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,22 +165,27 @@ The recipient of the XMPP notifications. Required if SENDXMPP_ENABLE is true.

Default: ``

### MAIL Notification settings

The MAIL notification settings are inherited, and included if they might be of use. They should be considered unsupported.
### Notifications using mailx

#### MAIL_SMTP_ENABLE

The tool uses [heirloom-mailx](https://www.systutorials.com/docs/linux/man/1-heirloom-mailx/) to send mail.

Default: `FALSE`

#### MAIL_TO

The recipient of the mailx notifications. Required if MAIL_SMTP_ENABLE is true.

Default: ``

#### MAIL_SMTP_VARIABLES

Refer to the mailx documentation for the correct usage for your requirements. It's out of scope and unsupported here.
Defines how the email notification is sent. Refer to the mailx documentation for the correct usage for your requirements. It's out of scope and unsupported here.

**We will set the subject according to the usage scenario, so you should not use the `-s` option.**

As an example to send notifications using a zoho account and server.

```text
# My example:
Expand All @@ -193,29 +198,15 @@ Refer to the mailx documentation for the correct usage for your requirements. It
-S smtp-auth-password=<my-email-password> \
-S from=<my-email-address>
```
These settings would translate as an environment variable of
These settings would translate to an environment variable of:

```
MAIL_SMTP_VARIABLES="-S smtp-use-starttls -S smtp=smtp://smtp.zoho.com:587 -S smtp-auth=login -S smtp-auth-user=<my-email-address> -S smtp-auth-password=<my-email-password> -S from=<my-email-address>"
```

See [here](https://www.systutorials.com/sending-email-from-mailx-command-in-linux-using-gmails-smtp/) for more information.

#### MAIL_TO

Who will receive the notification email.

#### MAIL_WHEN_SUCCESS

Send email when backup is successful.

Default: `TRUE`

#### MAIL_WHEN_FAILURE

Send email when backup fails.

Default: `TRUE`


## License
Expand Down
4 changes: 2 additions & 2 deletions scripts/backup.sh
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,8 @@ function clear_history() {

echo "clear_history(): delete ${RCLONE_DELETE_FILE} failed" >> ${BACKUP_DIR}/report
fi
rclone cat ${RCLONE_REMOTE}
rclone cat ${RCLONE_REMOTE} >> ${BACKUP_DIR}/report
rclone lsl ${RCLONE_REMOTE}
rclone lsl ${RCLONE_REMOTE} >> ${BACKUP_DIR}/report
done
fi
}
Expand Down

0 comments on commit a23c96d

Please sign in to comment.