aboutsummaryrefslogtreecommitdiffstats
path: root/doc/backup-email.md
diff options
context:
space:
mode:
authorGravatar Christian Hesse <mail@eworm.de>2022-01-05 22:37:35 +0100
committerGravatar Christian Hesse <mail@eworm.de>2022-01-06 08:19:58 +0100
commit95b17ab9a17b7ad11df7c467813a061aead1c835 (patch)
tree5d29fd04bc66168a435af77dd394937841a3d98c /doc/backup-email.md
parent8c39f41ffcf3af7fe6d8b4091db5791756f59879 (diff)
rename script email-backup -> backup-email
Diffstat (limited to 'doc/backup-email.md')
-rw-r--r--doc/backup-email.md54
1 files changed, 54 insertions, 0 deletions
diff --git a/doc/backup-email.md b/doc/backup-email.md
new file mode 100644
index 0000000..7361b44
--- /dev/null
+++ b/doc/backup-email.md
@@ -0,0 +1,54 @@
+Send backup via e-mail
+======================
+
+[◀ Go back to main README](../README.md)
+
+🛈 This script can not be used on its own but requires the base installation.
+See [main README](../README.md) for details.
+
+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 backup-email;
+
+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
+* `BackupRandomDelay`: delay up to amount of seconds when run from scheduler
+
+Also valid e-mail settings are required to send mails.
+
+Usage and invocation
+--------------------
+
+Just run the script:
+
+ / system script run backup-email;
+
+Creating a scheduler may be an option:
+
+ / system scheduler add interval=1w name=backup-email on-event="/ system script run backup-email;" start-time=09:15:00;
+
+See also
+--------
+
+* [Upload backup to Mikrotik cloud](backup-cloud.md)
+* [Upload backup to server](upload-backup.md)
+
+---
+[◀ Go back to main README](../README.md)
+[▲ Go back to top](#top)