From 95b17ab9a17b7ad11df7c467813a061aead1c835 Mon Sep 17 00:00:00 2001
From: Christian Hesse <mail@eworm.de>
Date: Wed, 5 Jan 2022 22:37:35 +0100
Subject: rename script email-backup -> backup-email

---
 doc/backup-email.md | 54 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 54 insertions(+)
 create mode 100644 doc/backup-email.md

(limited to 'doc/backup-email.md')

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)
-- 
cgit v1.2.3-54-g00ecf