You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Christian Hesse dd22dfd26d backup-email: check if dependency for sending e-mail is installed 5 days ago
README.d optimize all svg files... 1 month ago
certs global-functions: $GetMacVendor: switched to Let's Encrypt (R3) 3 weeks ago
doc drop 'netwatch-syslog' 1 week ago
mod introduce 'mod/notification-email', split off from global-functions 1 week ago
.gitignore ignore all html files 4 years ago
CONTRIBUTIONS.md update list of contributors 2 months ago
COPYING.md explicitly name the license 2 years ago
INITIAL-COMMANDS.md INITIAL-COMMANDS: RouterOS v7 path syntax 5 months ago
Makefile Makefile: add a clean target 1 week ago
README.md drop 'learn-mac-based-vlan' and 'manage-umts' 1 week ago
accesslist-duplicates.capsman accesslist-duplicates: update initialization of empty array 3 months ago
accesslist-duplicates.local accesslist-duplicates: update initialization of empty array 3 months ago
accesslist-duplicates.template accesslist-duplicates: update initialization of empty array 3 months ago
backup-cloud backup-cloud: RouterOS v7 path syntax 5 months ago
backup-email backup-email: check if dependency for sending e-mail is installed 5 days ago
backup-partition backup-partition: RouterOS v7 path syntax 5 months ago
backup-upload backup-upload: RouterOS v7 path syntax 5 months ago
capsman-download-packages capsman-download-packages: use proper array syntax 2 months ago
capsman-rolling-upgrade capsman-rolling-upgrade: RouterOS v7 path syntax 5 months ago
certificate-renew-issued certificate-renew-issued: RouterOS v7 path syntax 5 months ago
check-certificates check-certificates: RouterOS v7 path syntax 5 months ago
check-health check-health: update initialization of empty array 3 months ago
check-lte-firmware-upgrade check-lte-firmware-upgrade: use $0 for $ScriptFromTerminal 2 months ago
check-routeros-update check-routeros-update: use a better check for valid version 3 months ago
collect-wireless-mac.capsman collect-wireless-mac: RouterOS v7 path syntax 5 months ago
collect-wireless-mac.local collect-wireless-mac: RouterOS v7 path syntax 5 months ago
collect-wireless-mac.template collect-wireless-mac: RouterOS v7 path syntax 5 months ago
daily-psk.capsman daily-psk: update initialization of empty array 3 months ago
daily-psk.local daily-psk: update initialization of empty array 3 months ago
daily-psk.template daily-psk: update initialization of empty array 3 months ago
dhcp-lease-comment.capsman dhcp-lease-comment: RouterOS v7 path syntax 5 months ago
dhcp-lease-comment.local dhcp-lease-comment: RouterOS v7 path syntax 5 months ago
dhcp-lease-comment.template dhcp-lease-comment: RouterOS v7 path syntax 5 months ago
dhcp-to-dns dhcp-to-dns: RouterOS v7 path syntax 5 months ago
firmware-upgrade-reboot firmware-upgrade-reboot: RouterOS v7 path syntax 5 months ago
global-config introduce 'mod/notification-email', split off from global-functions 1 week ago
global-config-overlay global-config: new setting to disable news and change notifications... 3 months ago
global-config.changes drop 'netwatch-syslog' 1 week ago
global-functions global-functions: $ScriptInstallUpdate: disable notification only... 6 days ago
global-wait global-wait: do not claim to be a backup script... 5 months ago
gps-track gps-track: RouterOS v7 path syntax 5 months ago
hotspot-to-wpa hotspot-to-wpa: RouterOS v7 path syntax 5 months ago
hotspot-to-wpa-cleanup hotspot-to-wpa-cleanup: RouterOS v7 path syntax 5 months ago
ip-addr-bridge ip-addr-bridge: RouterOS v7 path syntax 5 months ago
ipsec-to-dns ipsec-to-dns: RouterOS v7 path syntax 5 months ago
ipv6-update ipv6-update: RouterOS v7 path syntax 5 months ago
lease-script lease-script: update initialization of empty array 3 months ago
leds-day-mode leds-{day,night,toggle}-mode: RouterOS v7 path syntax 5 months ago
leds-night-mode leds-{day,night,toggle}-mode: RouterOS v7 path syntax 5 months ago
leds-toggle-mode leds-{day,night,toggle}-mode: RouterOS v7 path syntax 5 months ago
log-forward log-forward: update initialization of empty array 3 months ago
logo.avif add AVIF logo 9 months ago
logo.png logo: clean png export 1 year ago
logo.svg logo: optimize the svg file 2 months ago
mode-button mode-button: RouterOS v7 path syntax 5 months ago
netwatch-dns netwatch-dns: support downloading / importing certificate 3 weeks ago
netwatch-notify netwatch-notify: use a counter for resolve failures 2 weeks ago
ospf-to-leds ospf-to-leds: RouterOS v7 path syntax 5 months ago
packages-update packages-update: RouterOS v7 path syntax 5 months ago
ppp-on-up ppp-on-up: RouterOS v7 path syntax 5 months ago
sms-action update copyright for 2022 9 months ago
sms-forward sms-forward: update initialization of empty array 3 months ago
ssh-keys-import ssh-keys-import: RouterOS v7 path syntax 5 months ago
super-mario-theme update copyright for 2022 9 months ago
unattended-lte-firmware-upgrade unattended-lte-firmware-upgrade: increase delay before extra reset 2 weeks ago
update-gre-address update-gre-address: RouterOS v7 path syntax 5 months ago
update-tunnelbroker update-tunnelbroker: RouterOS v7 path syntax 5 months ago

README.md

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.

Info: The main branch is now RouterOS v7 only. If you are still running RouterOS v6 switch to routeros-v6 branch!

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!

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

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

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

If the update includes news or requires configuration changes a notification is sent - in addition to terminal output and log messages.

news and changes notification

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.

Removing a script

There is no specific function for script removal. Just remove it from configuration...

/system/script/remove to-be-removed;

screenshot: remove script

Possibly a scheduler and other configuration has to be removed as well.

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