aboutsummaryrefslogtreecommitdiffstats
path: root/doc/backup-cloud.md
diff options
context:
space:
mode:
authorGravatar Christian Hesse <mail@eworm.de>2022-01-05 22:36:49 +0100
committerGravatar Christian Hesse <mail@eworm.de>2022-01-06 08:19:58 +0100
commit8c39f41ffcf3af7fe6d8b4091db5791756f59879 (patch)
treed5fdd47c6c965849ab05b20c298fddce59ba6f5c /doc/backup-cloud.md
parent57c80dc2a42280c1a8d1f2c7de8d73a3e03190bc (diff)
rename script cloud-backup -> backup-cloud
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..18b9ec1
--- /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](email-backup.md)
+* [Upload backup to server](upload-backup.md)
+
+---
+[◀ Go back to main README](../README.md)
+[▲ Go back to top](#top)