2020-03-27 20:42:19 +00:00
|
|
|
|
Notify on RouterOS update
|
|
|
|
|
=========================
|
|
|
|
|
|
2023-01-10 13:45:27 +00:00
|
|
|
|
[⬅️ Go back to main README](../README.md)
|
2020-03-27 20:42:19 +00:00
|
|
|
|
|
2022-02-12 12:05:56 +00:00
|
|
|
|
> ℹ️ **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.
|
2021-05-03 13:07:50 +00:00
|
|
|
|
|
2020-03-27 20:42:19 +00:00
|
|
|
|
Description
|
|
|
|
|
-----------
|
|
|
|
|
|
|
|
|
|
The primary use of this script is to notify about RouterOS updates.
|
|
|
|
|
|
|
|
|
|
Run from a terminal you can start the update process or schedule it.
|
|
|
|
|
|
|
|
|
|
Centrally managing update process of several devices is possibly by
|
2022-05-06 06:20:34 +00:00
|
|
|
|
specifying versions safe to be updated on a web server. Versions seen
|
|
|
|
|
in neighbor discovery can be specified to be safe as well.
|
2020-03-27 20:42:19 +00:00
|
|
|
|
|
2020-07-07 07:14:15 +00:00
|
|
|
|
Also installing patch updates (where just last digit is increased)
|
|
|
|
|
automatically is supported.
|
|
|
|
|
|
2022-05-06 06:20:53 +00:00
|
|
|
|
> ⚠️ **Warning**: Installing updates is important from a security point
|
|
|
|
|
> of view. At the same time it can be source of serve breakage. So test
|
2022-05-06 06:26:00 +00:00
|
|
|
|
> versions in lab and read
|
|
|
|
|
> [changelog](https://mikrotik.com/download/changelogs/) and
|
|
|
|
|
> [forum](https://forum.mikrotik.com/viewforum.php?f=21) before deploying
|
|
|
|
|
> to your production environment! Automatic updates should be handled
|
|
|
|
|
> with care!
|
2022-05-06 06:20:53 +00:00
|
|
|
|
|
2021-06-17 13:23:51 +00:00
|
|
|
|
### Sample notification
|
|
|
|
|
|
2022-10-20 08:39:52 +00:00
|
|
|
|
![check-routeros-update notification](check-routeros-update.d/notification.avif)
|
2021-06-17 13:23:51 +00:00
|
|
|
|
|
2020-03-27 20:42:19 +00:00
|
|
|
|
Requirements and installation
|
|
|
|
|
-----------------------------
|
|
|
|
|
|
|
|
|
|
Just install the script:
|
|
|
|
|
|
|
|
|
|
$ScriptInstallUpdate check-routeros-update;
|
|
|
|
|
|
|
|
|
|
And add a scheduler for automatic update notification:
|
|
|
|
|
|
2022-05-11 07:58:53 +00:00
|
|
|
|
/system/scheduler/add interval=1d name=check-routeros-update on-event="/system/script/run check-routeros-update;" start-time=startup;
|
2020-03-27 20:42:19 +00:00
|
|
|
|
|
|
|
|
|
Configuration
|
|
|
|
|
-------------
|
|
|
|
|
|
2023-03-03 13:08:48 +00:00
|
|
|
|
No extra configuration is required to receive notifications. Several
|
|
|
|
|
mechanisms are availalbe to enable automatic installation of updates.
|
|
|
|
|
The configuration goes to `global-config-overlay`, these are the parameters:
|
|
|
|
|
|
|
|
|
|
* `SafeUpdateNeighbor`: install updates automatically if at least one other
|
|
|
|
|
device is seen in neighbor list with new version
|
|
|
|
|
* `SafeUpdatePatch`: install patch updates (where just last digit changes)
|
|
|
|
|
automatically
|
|
|
|
|
* `SafeUpdateUrl`: url on webserver to check for safe update, the channel
|
|
|
|
|
(`long-term`, `stable` or `testing`) is appended
|
2023-03-03 13:15:24 +00:00
|
|
|
|
* `SafeUpdateAll`: install **all** updates automatically
|
|
|
|
|
|
2023-06-07 12:12:12 +00:00
|
|
|
|
> ℹ️ **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.
|
2020-03-27 20:42:19 +00:00
|
|
|
|
|
2022-09-23 13:07:30 +00:00
|
|
|
|
Also notification settings are required for
|
|
|
|
|
[e-mail](mod/notification-email.md),
|
2021-11-16 15:03:25 +00:00
|
|
|
|
[matrix](mod/notification-matrix.md) and/or
|
2021-11-16 15:03:43 +00:00
|
|
|
|
[telegram](mod/notification-telegram.md).
|
2022-02-20 22:34:35 +00:00
|
|
|
|
|
2020-03-27 20:42:19 +00:00
|
|
|
|
Usage and invocation
|
|
|
|
|
--------------------
|
|
|
|
|
|
|
|
|
|
Be notified when run from scheduler or run it manually:
|
|
|
|
|
|
2022-05-11 07:58:53 +00:00
|
|
|
|
/system/script/run check-routeros-update;
|
2020-03-27 20:42:19 +00:00
|
|
|
|
|
|
|
|
|
If an update is found you can install it right away.
|
|
|
|
|
|
|
|
|
|
Installing script [packages-update](packages-update.md) gives extra options.
|
|
|
|
|
|
2023-05-31 13:58:54 +00:00
|
|
|
|
Tips & Tricks
|
|
|
|
|
-------------
|
|
|
|
|
|
|
|
|
|
The script checks for full connectivity before acting, so scheduling at
|
|
|
|
|
startup is perfectly valid:
|
|
|
|
|
|
|
|
|
|
/system/scheduler/add name=check-routeros-update@startup on-event="/system/script/run check-routeros-update;" start-time=startup;
|
|
|
|
|
|
2020-03-27 20:42:19 +00:00
|
|
|
|
See also
|
|
|
|
|
--------
|
|
|
|
|
|
2022-02-02 20:10:10 +00:00
|
|
|
|
* [Automatically upgrade firmware and reboot](firmware-upgrade-reboot.md)
|
2020-03-27 20:42:19 +00:00
|
|
|
|
* [Manage system update](packages-update.md)
|
|
|
|
|
|
|
|
|
|
---
|
2023-01-10 13:45:27 +00:00
|
|
|
|
[⬅️ Go back to main README](../README.md)
|
|
|
|
|
[⬆️ Go back to top](#top)
|