aboutsummaryrefslogtreecommitdiffstats
path: root/doc/backup-cloud.md
diff options
context:
space:
mode:
authorGravatar Christian Hesse <mail@eworm.de>2022-01-06 10:23:03 +0100
committerGravatar Christian Hesse <mail@eworm.de>2022-01-06 10:23:03 +0100
commit97f35dcf0e99738e9170a413f6be52c989708b9c (patch)
tree1b9dee4af1a834b4cc2fa83d713743708498f1f4 /doc/backup-cloud.md
parent57c80dc2a42280c1a8d1f2c7de8d73a3e03190bc (diff)
parented0135c613b92ce59bda832f0e4a789a8268223f (diff)
Merge branch 'backup' into next
Diffstat (limited to 'doc/backup-cloud.md')
-rw-r--r--doc/backup-cloud.md54
1 files changed, 54 insertions, 0 deletions
diff --git a/doc/backup-cloud.md b/doc/backup-cloud.md
new file mode 100644
index 0000000..117e4c7
--- /dev/null
+++ b/doc/backup-cloud.md
@@ -0,0 +1,54 @@
+Upload backup to Mikrotik cloud
+===============================
+
+[◀ 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 uploads [binary backup to Mikrotik cloud](https://wiki.mikrotik.com/wiki/Manual:IP/Cloud#Backup).
+
+### Sample notification
+
+![backup-cloud notification](backup-cloud.d/notification.svg)
+
+Requirements and installation
+-----------------------------
+
+Just install the script:
+
+ $ScriptInstallUpdate backup-cloud;
+
+Configuration
+-------------
+
+The configuration goes to `global-config-overlay`, these are the parameters:
+
+* `BackupPassword`: password to encrypt the backup with
+* `BackupRandomDelay`: delay up to amount of seconds when run from scheduler
+
+Also notification settings are required for e-mail, matrix and/or telegram.
+
+Usage and invocation
+--------------------
+
+Just run the script:
+
+ / system script run backup-cloud;
+
+Creating a scheduler may be an option:
+
+ / system scheduler add interval=1w name=backup-cloud on-event="/ system script run backup-cloud;" start-time=09:20:00;
+
+See also
+--------
+
+* [Send backup via e-mail](backup-email.md)
+* [Upload backup to server](backup-upload.md)
+
+---
+[◀ Go back to main README](../README.md)
+[▲ Go back to top](#top)