add doc/email-backup.md

This commit is contained in:
Christian Hesse 2020-03-27 21:45:15 +01:00
parent e0346bf60e
commit 8b724a9b5a
2 changed files with 53 additions and 0 deletions

52
doc/email-backup.md Normal file
View file

@ -0,0 +1,52 @@
Send backup via e-mail
======================
[◀ Go back to main README](../README.md)
Description
-----------
This script sends binary backup (`/ system backup save`) and complete
configuration export (`/ export terse`) via e-mail.
Requirements and installation
-----------------------------
Just install the script:
$ScriptInstallUpdate email-backup;
Configuration
-------------
The configuration goes to `global-config-overlay`, These are the parameters:
* `BackupSendBinary`: whether to send binary backup
* `BackupSendExport`: whether to send configuration export
* `BackupPassword`: password to encrypt the backup with
* `EmailBackupTo`: e-mail address to send to
* `EmailBackupCc`: e-mail address(es) to send in copy
Also valid e-mail settings in `/ tool e-mail` are required to send mails.
Usage and invocation
--------------------
Just run the script:
/ system script run email-backup;
Creating a scheduler may be an option:
/ system scheduler add interval=1w name=email-backup on-event="/ system script run email-backup;" start-time=09:15:00;
See also
--------
* [Upload backup to Mikrotik cloud](cloud-backup.md)
* [Upload backup to server](upload-backup.md)
---
[◀ Go back to main README](../README.md)
[▲ Go back to top](#top)

View file

@ -3,6 +3,7 @@
# Copyright (c) 2013-2020 Christian Hesse <mail@eworm.de>
#
# create and email backup and config file
# https://git.eworm.de/cgit/routeros-scripts/about/doc/email-backup.md
:global BackupPassword;
:global BackupSendBinary;