aboutsummaryrefslogtreecommitdiffstats
path: root/doc
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
parent57c80dc2a42280c1a8d1f2c7de8d73a3e03190bc (diff)
parented0135c613b92ce59bda832f0e4a789a8268223f (diff)
Merge branch 'backup' into next
Diffstat (limited to 'doc')
-rw-r--r--doc/backup-cloud.d/notification.svg (renamed from doc/cloud-backup.d/notification.svg)2
-rw-r--r--doc/backup-cloud.md54
-rw-r--r--doc/backup-email.md54
-rw-r--r--doc/backup-upload.d/notification.svg (renamed from doc/upload-backup.d/notification.svg)2
-rw-r--r--doc/backup-upload.md70
-rw-r--r--doc/cloud-backup.md55
-rw-r--r--doc/email-backup.md55
-rw-r--r--doc/log-forward.d/notification.svg2
-rw-r--r--doc/packages-update.md8
-rw-r--r--doc/upload-backup.md71
10 files changed, 188 insertions, 185 deletions
diff --git a/doc/cloud-backup.d/notification.svg b/doc/backup-cloud.d/notification.svg
index 8b84b8f..b023e50 100644
--- a/doc/cloud-backup.d/notification.svg
+++ b/doc/backup-cloud.d/notification.svg
@@ -6,7 +6,7 @@
version="1.1"
id="svg8"
inkscape:version="1.1 (c4e8f9ed74, 2021-05-24)"
- sodipodi:docname="cloud-backup.svg"
+ sodipodi:docname="backup-cloud.svg"
inkscape:export-filename="logo.png"
inkscape:export-xdpi="96"
inkscape:export-ydpi="96"
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)
diff --git a/doc/backup-email.md b/doc/backup-email.md
new file mode 100644
index 0000000..be36cb4
--- /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](backup-upload.md)
+
+---
+[◀ Go back to main README](../README.md)
+[▲ Go back to top](#top)
diff --git a/doc/upload-backup.d/notification.svg b/doc/backup-upload.d/notification.svg
index a85bd5c..90573ab 100644
--- a/doc/upload-backup.d/notification.svg
+++ b/doc/backup-upload.d/notification.svg
@@ -6,7 +6,7 @@
version="1.1"
id="svg8"
inkscape:version="1.1 (c4e8f9ed74, 2021-05-24)"
- sodipodi:docname="upload-backup.svg"
+ sodipodi:docname="backup-upload.svg"
inkscape:export-filename="logo.png"
inkscape:export-xdpi="96"
inkscape:export-ydpi="96"
diff --git a/doc/backup-upload.md b/doc/backup-upload.md
new file mode 100644
index 0000000..212b16c
--- /dev/null
+++ b/doc/backup-upload.md
@@ -0,0 +1,70 @@
+Upload backup to server
+=======================
+
+[◀ 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 (`/ system backup save`) and complete
+configuration export (`/ export terse`) to external server.
+
+### Sample notification
+
+![backup-upload notification](backup-upload.d/notification.svg)
+
+Requirements and installation
+-----------------------------
+
+Just install the script:
+
+ $ScriptInstallUpdate backup-upload;
+
+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
+* `BackupUploadUrl`: url to upload to
+* `BackupUploadUser`: username for server authentication
+* `BackupUploadPass`: password for server authentication
+
+Also notification settings are required for e-mail, matrix and/or telegram.
+
+### Issues with SFTP client
+
+The RouterOS SFTP client is picky if it comes to authentication methods.
+I had to disable all but password authentication on server side. For openssh
+edit `/etc/ssh/sshd_config` and add a directive like this, changed for your
+needs:
+
+ Match User mikrotik
+ AuthenticationMethods password
+
+Usage and invocation
+--------------------
+
+Just run the script:
+
+ / system script run backup-upload;
+
+Creating a scheduler may be an option:
+
+ / system scheduler add interval=1w name=backup-upload on-event="/ system script run backup-upload;" start-time=09:25:00;
+
+See also
+--------
+
+* [Send backup via e-mail](backup-email.md)
+* [Upload backup to Mikrotik cloud](backup-cloud.md)
+
+---
+[◀ Go back to main README](../README.md)
+[▲ Go back to top](#top)
diff --git a/doc/cloud-backup.md b/doc/cloud-backup.md
index 7522bc1..e161cfa 100644
--- a/doc/cloud-backup.md
+++ b/doc/cloud-backup.md
@@ -1,54 +1 @@
-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
-
-![cloud-backup notification](cloud-backup.d/notification.svg)
-
-Requirements and installation
------------------------------
-
-Just install the script:
-
- $ScriptInstallUpdate cloud-backup;
-
-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 cloud-backup;
-
-Creating a scheduler may be an option:
-
- / system scheduler add interval=1w name=cloud-backup on-event="/ system script run cloud-backup;" 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)
+This script has been renamed. Please see [backup-cloud](backup-cloud.md).
diff --git a/doc/email-backup.md b/doc/email-backup.md
index 85d50bd..d674743 100644
--- a/doc/email-backup.md
+++ b/doc/email-backup.md
@@ -1,54 +1 @@
-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 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
-* `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 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)
+This script has been renamed. Please see [backup-email](backup-email.md). \ No newline at end of file
diff --git a/doc/log-forward.d/notification.svg b/doc/log-forward.d/notification.svg
index b3389fe..373144b 100644
--- a/doc/log-forward.d/notification.svg
+++ b/doc/log-forward.d/notification.svg
@@ -170,7 +170,7 @@
</tspan><tspan
x="180"
y="86.082811"
- id="tspan2327"> ● 13:24:02 script;error cloud-backup: Failed uploading backup </tspan><tspan
+ id="tspan2327"> ● 13:24:02 script;error backup-cloud: Failed uploading backup </tspan><tspan
x="180"
y="101.08281"
id="tspan2329">for MikroTik to cloud!
diff --git a/doc/packages-update.md b/doc/packages-update.md
index cc4a29b..ac69301 100644
--- a/doc/packages-update.md
+++ b/doc/packages-update.md
@@ -16,8 +16,8 @@ verification.
But it provides some extra functionality:
-* send backup via e-mail if [email-backup](email-backup.md) is installed
-* upload backup if [upload-backup](upload-backup.md) is installed
+* send backup via e-mail if [backup-email](backup-email.md) is installed
+* upload backup if [backup-upload](backup-upload.md) is installed
* schedule reboot at night
Requirements and installation
@@ -41,8 +41,8 @@ See also
--------
* [Notify on RouterOS update](check-routeros-update.md)
-* [Send backup via e-mail](email-backup.md)
-* [Upload backup to server](upload-backup.md)
+* [Send backup via e-mail](backup-email.md)
+* [Upload backup to server](backup-upload.md)
---
[◀ Go back to main README](../README.md)
diff --git a/doc/upload-backup.md b/doc/upload-backup.md
index 9566853..83c9991 100644
--- a/doc/upload-backup.md
+++ b/doc/upload-backup.md
@@ -1,70 +1 @@
-Upload backup to server
-=======================
-
-[◀ 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 (`/ system backup save`) and complete
-configuration export (`/ export terse`) to external server.
-
-### Sample notification
-
-![upload-backup notification](upload-backup.d/notification.svg)
-
-Requirements and installation
------------------------------
-
-Just install the script:
-
- $ScriptInstallUpdate upload-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
-* `BackupRandomDelay`: delay up to amount of seconds when run from scheduler
-* `BackupUploadUrl`: url to upload to
-* `BackupUploadUser`: username for server authentication
-* `BackupUploadPass`: password for server authentication
-
-Also notification settings are required for e-mail, matrix and/or telegram.
-
-### Issues with SFTP client
-
-The RouterOS SFTP client is picky if it comes to authentication methods.
-I had to disable all but password authentication on server side. For openssh
-edit `/etc/ssh/sshd_config` and add a directive like this, changed for your
-needs:
-
- Match User mikrotik
- AuthenticationMethods password
-
-Usage and invocation
---------------------
-
-Just run the script:
-
- / system script run upload-backup;
-
-Creating a scheduler may be an option:
-
- / system scheduler add interval=1w name=upload-backup on-event="/ system script run upload-backup;" start-time=09:25:00;
-
-See also
---------
-
-* [Send backup via e-mail](email-backup.md)
-* [Upload backup to Mikrotik cloud](cloud-backup.md)
-
----
-[◀ Go back to main README](../README.md)
-[▲ Go back to top](#top)
+This script has been renamed. Please see [backup-upload](backup-upload.md).