a collection of scripts for MikroTik RouterOS
Find a file
2022-05-11 13:48:27 +02:00
certs certs: drop old chain GTS CA 1O1 / GlobalSign 2021-09-21 21:26:09 +02:00
doc doc/check-routeros-update: link changelog and forum 2022-05-06 08:26:00 +02:00
mod update copyright for 2022 2022-01-01 21:38:15 +01:00
README.d README: installing custom scripts & modules 2022-05-05 10:42:03 +02:00
.gitignore ignore all html files 2019-01-02 16:26:32 +01:00
accesslist-duplicates.capsman accesslist-duplicates: RouterOS v7 path syntax 2022-05-11 13:48:27 +02:00
accesslist-duplicates.local accesslist-duplicates: RouterOS v7 path syntax 2022-05-11 13:48:27 +02:00
accesslist-duplicates.template accesslist-duplicates: RouterOS v7 path syntax 2022-05-11 13:48:27 +02:00
backup-cloud backup-cloud: RouterOS v7 path syntax 2022-05-11 13:48:27 +02:00
backup-email backup-email: RouterOS v7 path syntax 2022-05-11 13:48:27 +02:00
backup-partition backup-partition: RouterOS v7 path syntax 2022-05-11 13:48:27 +02:00
backup-upload backup-upload: RouterOS v7 path syntax 2022-05-11 13:48:27 +02:00
capsman-download-packages capsman-download-packages: RouterOS v7 path syntax 2022-05-11 13:48:27 +02:00
capsman-rolling-upgrade capsman-rolling-upgrade: RouterOS v7 path syntax 2022-05-11 13:48:27 +02:00
certificate-renew-issued certificate-renew-issued: RouterOS v7 path syntax 2022-05-11 13:48:27 +02:00
check-certificates check-certificates: RouterOS v7 path syntax 2022-05-11 13:48:27 +02:00
check-health check-health: RouterOS v7 path syntax 2022-05-11 13:48:27 +02:00
check-lte-firmware-upgrade check-lte-firmware-upgrade: RouterOS v7 path syntax 2022-05-11 13:48:27 +02:00
check-routeros-update check-routeros-update: RouterOS v7 path syntax 2022-05-11 13:48:27 +02:00
collect-wireless-mac.capsman update copyright for 2022 2022-01-01 21:38:15 +01:00
collect-wireless-mac.local update copyright for 2022 2022-01-01 21:38:15 +01:00
collect-wireless-mac.template update copyright for 2022 2022-01-01 21:38:15 +01:00
CONTRIBUTIONS.md update list of contributors 2022-05-02 12:05:11 +02:00
COPYING.md explicitly name the license 2020-06-19 22:17:42 +02:00
daily-psk.capsman update copyright for 2022 2022-01-01 21:38:15 +01:00
daily-psk.local update copyright for 2022 2022-01-01 21:38:15 +01:00
daily-psk.template update copyright for 2022 2022-01-01 21:38:15 +01:00
dhcp-lease-comment.capsman update copyright for 2022 2022-01-01 21:38:15 +01:00
dhcp-lease-comment.local update copyright for 2022 2022-01-01 21:38:15 +01:00
dhcp-lease-comment.template update copyright for 2022 2022-01-01 21:38:15 +01:00
dhcp-to-dns update copyright for 2022 2022-01-01 21:38:15 +01:00
firmware-upgrade-reboot firmware-upgrade-reboot: ignore firmware downgrade 2022-03-08 22:47:26 +01:00
global-config global-config: RouterOS v7 path syntax 2022-05-10 16:03:19 +02:00
global-config-overlay introduce backup-partition 2022-03-30 18:24:14 +02:00
global-config.changes global-config.changes: RouterOS v7 path syntax 2022-05-10 16:03:19 +02:00
global-functions global-functions: RouterOS v7 path syntax 2022-05-11 13:48:27 +02:00
global-wait global-wait: do not claim to be a backup script... 2022-05-04 21:11:26 +02:00
gps-track update copyright for 2022 2022-01-01 21:38:15 +01:00
hotspot-to-wpa hotspot-to-wpa: create template if missing 2022-04-26 14:26:17 +02:00
hotspot-to-wpa-cleanup update copyright for 2022 2022-01-01 21:38:15 +01:00
INITIAL-COMMANDS.md INITIAL-COMMANDS: give another delay before fetch 2022-02-23 09:24:10 +01:00
ip-addr-bridge update copyright for 2022 2022-01-01 21:38:15 +01:00
ipsec-to-dns update copyright for 2022 2022-01-01 21:38:15 +01:00
ipv6-update update copyright for 2022 2022-01-01 21:38:15 +01:00
learn-mac-based-vlan update copyright for 2022 2022-01-01 21:38:15 +01:00
lease-script update copyright for 2022 2022-01-01 21:38:15 +01:00
leds-day-mode update copyright for 2022 2022-01-01 21:38:15 +01:00
leds-night-mode update copyright for 2022 2022-01-01 21:38:15 +01:00
leds-toggle-mode update copyright for 2022 2022-01-01 21:38:15 +01:00
log-forward update copyright for 2022 2022-01-01 21:38:15 +01:00
logo.avif add AVIF logo 2022-01-03 10:00:16 +01:00
logo.png logo: clean png export 2021-05-07 09:18:39 +02:00
logo.svg logo: convert text to path 2021-05-07 09:16:52 +02:00
Makefile Makefile: RouterOS v7 path syntax 2022-05-11 13:48:27 +02:00
manage-umts update copyright for 2022 2022-01-01 21:38:15 +01:00
mode-button update copyright for 2022 2022-01-01 21:38:15 +01:00
netwatch-dns netwatch-dns: flush cache on configuration change 2022-02-10 08:41:12 +01:00
netwatch-notify netwatch-notify: nest conditions 2022-02-10 08:41:12 +01:00
netwatch-syslog update copyright for 2022 2022-01-01 21:38:15 +01:00
ospf-to-leds ospf-to-leds: get state from count of neighbors 2022-01-14 09:20:09 +01:00
packages-update packages-update: use correct syntax 2022-01-30 22:06:37 +01:00
ppp-on-up update copyright for 2022 2022-01-01 21:38:15 +01:00
README.md README: installing custom scripts & modules 2022-05-05 10:42:03 +02:00
rotate-ntp rotate-ntp: syntax for ROS 7.x 2022-01-14 09:20:09 +01:00
sms-action update copyright for 2022 2022-01-01 21:38:15 +01:00
sms-forward update copyright for 2022 2022-01-01 21:38:15 +01:00
ssh-keys-import update copyright for 2022 2022-01-01 21:38:15 +01:00
super-mario-theme update copyright for 2022 2022-01-01 21:38:15 +01:00
unattended-lte-firmware-upgrade update copyright for 2022 2022-01-01 21:38:15 +01:00
update-gre-address update copyright for 2022 2022-01-01 21:38:15 +01:00
update-tunnelbroker update copyright for 2022 2022-01-01 21:38:15 +01:00

RouterOS Scripts

GitHub stars GitHub forks GitHub watchers

RouterOS Scripts Logo

RouterOS is the operating system developed by MikroTik for networking tasks. This repository holds a number of scripts to manage RouterOS devices or extend their functionality.

Use at your own risk, pay attention to license and warranty!

Requirements

Latest version of the scripts require recent RouterOS to function properly. Make sure to install latest updates before you begin.

Specific scripts may require even newer RouterOS version.

Initial setup

Get me ready!

If you know how things work just copy and paste the initial commands. Remember to edit and rerun global-config-overlay! First time users should take the long way below.

Live presentation

Want to see it in action? I've had a presentation Repository based RouterOS script distribution including demonstation recorded live at MUM Europe 2019 in Vienna.

⚠️ Warning: Some details changed. So see the presentation, then follow the steps below for up-to-date commands.

The long way in detail

The update script does server certificate verification, so first step is to download the certificates. If you intend to download the scripts from a different location (for example from github.com) install the corresponding certificate chain.

/ tool fetch "https://git.eworm.de/cgit/routeros-scripts/plain/certs/R3.pem" dst-path="letsencrypt-R3.pem";

screenshot: download certs

Note that the commands above do not verify server certificate, so if you want to be safe download with your workstations's browser and transfer the files to your MikroTik device.

Then we import the certificates.

/ certificate import file-name=letsencrypt-R3.pem passphrase="";

screenshot: import certs

For basic verification we rename the certificates and print their count. Make sure the certificate count is two.

/ certificate set name="R3" [ find where fingerprint="67add1166b020ae61b8f5fc96813c04c2aa589960796865572a3c7e737613dfd" ];
/ certificate set name="ISRG-Root-X1" [ find where fingerprint="96bcec06264976f37460779acf28c5a7cfe8a3c0aae11a8ffcee05c0bddf08c6" ];
/ certificate print count-only where fingerprint="67add1166b020ae61b8f5fc96813c04c2aa589960796865572a3c7e737613dfd" or fingerprint="96bcec06264976f37460779acf28c5a7cfe8a3c0aae11a8ffcee05c0bddf08c6";

screenshot: check certs

Always make sure there are no certificates installed you do not know or want!

All following commands will verify the server certificate. For validity the certificate's lifetime is checked with local time, so make sure the device's date and time is set correctly!

One extra step is required if you run RouterOS v6:

:global ScriptUpdatesUrlSuffix "\?h=routeros-v6";

Now let's download the main scripts and add them in configuration on the fly.

:global ScriptUpdatesUrlSuffix;
:foreach Script in={ "global-config"; "global-config-overlay"; "global-functions" } do={ / system script add name=$Script source=([ / tool fetch check-certificate=yes-without-crl ("https://git.eworm.de/cgit/routeros-scripts/plain/" . $Script . $ScriptUpdatesUrlSuffix) output=user as-value]->"data"); };

screenshot: import scripts

The configuration needs to be tweaked for your needs. Edit global-config-overlay, copy configuration from global-config (the one without -overlay). Save changes and exit with Ctrl-o.

/ system script edit global-config-overlay source;

screenshot: edit global-config-overlay

And finally load configuration and functions and add the scheduler.

/ system script { run global-config; run global-functions; };
/ system scheduler add name="global-scripts" start-time=startup on-event="/ system script { run global-config; run global-functions; }";

screenshot: run and schedule scripts

The last step is optional: Add this scheduler only if you want the scripts to be updated automatically!

/ system scheduler add name="ScriptInstallUpdate" start-time=startup interval=1d on-event=":global ScriptInstallUpdate; \$ScriptInstallUpdate;";

screenshot: schedule update

Changes for RouterOS v6

RouterOS v7 is the way to go, let's consider RouterOS v6 deprecated. If you want to stay with RouterOS v6 for some time add these lines to your global-config-overlay, if missing:

# Use branch routeros-v6 with RouterOS v6:
:global ScriptUpdatesUrlSuffix "\?h=routeros-v6";

Then reload the configuration.

Updating scripts

To update existing scripts just run function $ScriptInstallUpdate. If everything is up-to-date it will not produce any output.

$ScriptInstallUpdate;

screenshot: update scripts

Adding a script

To add a script from the repository run function $ScriptInstallUpdate with a comma separated list of script names.

$ScriptInstallUpdate check-certificates,check-routeros-update;

screenshot: install scripts

Scheduler and events

Most scripts are designed to run regularly from scheduler. We just added check-routeros-update, so let's run it every hour to make sure not to miss an update.

/ system scheduler add name="check-routeros-update" interval=1h on-event="/ system script run check-routeros-update;";

screenshot: schedule script

Some events can run a script. If you want your DHCP hostnames to be available in DNS use dhcp-to-dns with the events from dhcp server. For a regular cleanup add a scheduler entry.

$ScriptInstallUpdate dhcp-to-dns,lease-script;
/ ip dhcp-server set lease-script=lease-script [ find ];
/ system scheduler add name="dhcp-to-dns" interval=5m on-event="/ system script run dhcp-to-dns;";

screenshot: setup lease script

There's much more to explore... Have fun!

Available scripts

Available modules

Installing custom scripts & modules

My scripts cover a lot of use cases, but you may have your own ones. You can still use my scripts to manage and deploy yours, by specifying base-url (and url-suffix) for each script.

This will fetch and install a script hello-world.rsc from the given url:

$ScriptInstallUpdate hello-world.rsc "base-url=https://git.eworm.de/cgit/routeros-scripts/plain/README.d/"

screenshot: install custom script

(Yes, the example url still belongs to the repository for easy handling - but the url can be what ever you use.)

For a script to be considered valid it has to begin with a magic token. Have a look at any script and copy the first line without modification.

Starting a script's name with mod/ makes it a module and it is run automatically by global-functions.

Contact

We have a Telegram Group RouterOS-Scripts!

RouterOS Scripts Telegram Group

Get help, give feedback or just chat - but do not expect free professional support!

Contribute

Thanks a lot for past contributions!

Patches, issues and whishlist

Feel free to contact me via e-mail or open an issue at github.

Donate

This project is developed in private spare time and usage is free of charge for you. If you like the scripts and think this is of value for you or your business please consider to donate with PayPal.

donate with PayPal

Thanks a lot for your support!

License and warranty

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

Upstream

URL: GitHub.com

Mirror: eworm.de GitLab.com


▲ Go back to top