routeros-scripts/doc/backup-upload.md

86 lines
2.7 KiB
Markdown
Raw Normal View History

Upload backup to server
=======================
[⬅️ Go back to main README](../README.md)
> **Info**: This script can not be used on its own but requires the base
2022-02-11 22:34:39 +00:00
> installation. See [main README](../README.md) for details.
Description
-----------
This script uploads binary backup (`/system/backup/save`) and complete
configuration export (`/export terse show-sensitive`) to external server.
> ⚠️ **Warning**: The used command can hit errors that a script can not handle.
> This may result in script termination (where no notification is sent) or
> malfunction of fetch command (where all up- and downloads break) for some
> time. Failed notifications are queued then.
### Sample notification
![backup-upload notification](backup-upload.d/notification.avif)
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
* `BackupSendGlobalConfig`: whether to send `global-config-overlay`
* `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
> **Info**: Copy relevant configuration from
> [`global-config`](../global-config.rsc) (the one without `-overlay`) to
> your local `global-config-overlay` and modify it to your specific needs.
Also notification settings are required for
[e-mail](mod/notification-email.md),
[matrix](mod/notification-matrix.md),
[ntfy](mod/notification-ntfy.md) and/or
2021-11-16 15:03:43 +00:00
[telegram](mod/notification-telegram.md).
### 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
--------
* [Upload backup to Mikrotik cloud](backup-cloud.md)
2022-03-30 16:03:50 +00:00
* [Send backup via e-mail](backup-email.md)
* [Save configuration to fallback partition](doc/backup-partition.md)
---
[⬅️ Go back to main README](../README.md)
[⬆️ Go back to top](#top)