routeros-scripts/doc/upload-backup.md
Michael Gisbers 8375673d93 global-functions: implement notifications via Matrix
Matrix is an open network for secure, decentralized communication - and
it has a web api.

A warning on message type: Using 'm.notice' breaks rendering on Element
for Android (no fixed width font) and does not pop up desktop
notification. Thus we use 'm.text'. Should be safe as we do not send the
messages in response to other messages.

https://matrix.org/
2021-06-08 21:07:25 +02:00

67 lines
1.8 KiB
Markdown

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.
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)