From c32a727b6e4a47058c6c37442ce54e93b2623e02 Mon Sep 17 00:00:00 2001
From: Christian Hesse <mail@eworm.de>
Date: Fri, 27 Mar 2020 21:52:17 +0100
Subject: add doc/upload-backup.md

---
 doc/upload-backup.md | 62 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 upload-backup        |  1 +
 2 files changed, 63 insertions(+)
 create mode 100644 doc/upload-backup.md

diff --git a/doc/upload-backup.md b/doc/upload-backup.md
new file mode 100644
index 0000000..bbfbcc4
--- /dev/null
+++ b/doc/upload-backup.md
@@ -0,0 +1,62 @@
+Upload backup to server
+=======================
+
+[◀ Go back to main README](../README.md)
+
+Description
+-----------
+
+This script uploads binary backup (`/ system backup save`) and complete
+configuration export (`/ export terse`) to external server.
+
+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
+* `BackupUploadUrl`: url to upload to
+* `BackupUploadUser`: username for server authentication
+* `BackupUploadPass`: password for server authentication
+
+Also notification settings are required for e-mail and 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)
diff --git a/upload-backup b/upload-backup
index 16c6bd8..3473884 100644
--- a/upload-backup
+++ b/upload-backup
@@ -3,6 +3,7 @@
 # Copyright (c) 2013-2020 Christian Hesse <mail@eworm.de>
 #
 # create and upload backup and config file
+# https://git.eworm.de/cgit/routeros-scripts/about/doc/upload-backup.md
 
 :global BackupPassword;
 :global BackupSendBinary;
-- 
cgit v1.2.3-54-g00ecf