From 8b724a9b5accef55bb85cc54ce19298f3a7ffc5e Mon Sep 17 00:00:00 2001 From: Christian Hesse Date: Fri, 27 Mar 2020 21:45:15 +0100 Subject: [PATCH] add doc/email-backup.md --- doc/email-backup.md | 52 +++++++++++++++++++++++++++++++++++++++++++++ email-backup | 1 + 2 files changed, 53 insertions(+) create mode 100644 doc/email-backup.md diff --git a/doc/email-backup.md b/doc/email-backup.md new file mode 100644 index 0000000..7f89a06 --- /dev/null +++ b/doc/email-backup.md @@ -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) diff --git a/email-backup b/email-backup index 2449173..3a00d04 100644 --- a/email-backup +++ b/email-backup @@ -3,6 +3,7 @@ # Copyright (c) 2013-2020 Christian Hesse # # create and email backup and config file +# https://git.eworm.de/cgit/routeros-scripts/about/doc/email-backup.md :global BackupPassword; :global BackupSendBinary;