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.
Go to file
Christian Hesse 36ee1ed039
telegram-chat: delay confirmation of updates
31 minutes ago
README.d README: install custom script from routeros-scripts-custom 3 weeks ago
certs global-functions: $GetMacVendor: switched to Let's Encrypt (R3) 5 months ago
doc telegram-chat: always reply to origin chat 1 day ago
mod mod/notification-telegram: support sending to specific chatid 2 days ago
.gitignore .gitignore: ignore folder settings file 1 month ago
CONTRIBUTIONS.md update list of contributors 1 week ago
COPYING.md explicitly name the license 3 years ago
INITIAL-COMMANDS.md use arrows with emoji representation 3 weeks ago
Makefile Makefile: add a clean target 4 months ago
README.md introduce telegram-chat 3 days ago
accesslist-duplicates.capsman update copyright for 2023 1 month ago
accesslist-duplicates.local update copyright for 2023 1 month ago
accesslist-duplicates.template update copyright for 2023 1 month ago
backup-cloud backup-cloud: keep floppy emoji for failure 1 month ago
backup-email backup-email: wait for the mail to be sent 1 day ago
backup-partition update copyright for 2023 1 month ago
backup-upload backup-upload: keep floppy emoji for failure 1 month ago
capsman-download-packages update copyright for 2023 1 month ago
capsman-rolling-upgrade update copyright for 2023 1 month ago
certificate-renew-issued update copyright for 2023 1 month ago
check-certificates check-certificates: handle decryption failures and warn 1 week ago
check-health check-health: silently exit without health readings... 2 weeks ago
check-lte-firmware-upgrade update copyright for 2023 1 month ago
check-routeros-update check-routeros-update: drop check for cap 3 days ago
collect-wireless-mac.capsman update copyright for 2023 1 month ago
collect-wireless-mac.local update copyright for 2023 1 month ago
collect-wireless-mac.template update copyright for 2023 1 month ago
daily-psk.capsman daily-psk: make qr-code url configurable 3 days ago
daily-psk.local daily-psk: make qr-code url configurable 3 days ago
daily-psk.template daily-psk: make qr-code url configurable 3 days ago
dhcp-lease-comment.capsman update copyright for 2023 1 month ago
dhcp-lease-comment.local update copyright for 2023 1 month ago
dhcp-lease-comment.template update copyright for 2023 1 month ago
dhcp-to-dns update copyright for 2023 1 month ago
firmware-upgrade-reboot update copyright for 2023 1 month ago
global-config daily-psk: make qr-code url configurable 3 days ago
global-config-overlay update copyright for 2023 1 month ago
global-config.changes daily-psk: make qr-code url configurable 3 days ago
global-functions global-functions: $WaitForFile: use delay instead of iterations 1 day ago
global-wait update copyright for 2023 1 month ago
gps-track update copyright for 2023 1 month ago
hotspot-to-wpa update copyright for 2023 1 month ago
hotspot-to-wpa-cleanup update copyright for 2023 1 month ago
ip-addr-bridge update copyright for 2023 1 month ago
ipsec-to-dns ipsec-to-dns: handle "CN=" from peer's id 2 weeks ago
ipv6-update update copyright for 2023 1 month ago
lease-script lease-script: use $Grep 2 weeks ago
leds-day-mode update copyright for 2023 1 month ago
leds-night-mode update copyright for 2023 1 month ago
leds-toggle-mode update copyright for 2023 1 month ago
log-forward log-forward: cache the result of $LogForwardFilterLogForwarding 2 weeks ago
logo.avif add AVIF logo 1 year ago
logo.png logo: clean png export 2 years ago
logo.svg logo: optimize the svg file 6 months ago
mode-button update copyright for 2023 1 month ago
netwatch-dns update copyright for 2023 1 month ago
netwatch-notify update copyright for 2023 1 month ago
ospf-to-leds update copyright for 2023 1 month ago
packages-update update copyright for 2023 1 month ago
ppp-on-up update copyright for 2023 1 month ago
sms-action update copyright for 2023 1 month ago
sms-forward sms-forward: support hooks 4 weeks ago
ssh-keys-import update copyright for 2023 1 month ago
super-mario-theme update copyright for 2023 1 month ago
telegram-chat telegram-chat: delay confirmation of updates 31 minutes ago
unattended-lte-firmware-upgrade update copyright for 2023 1 month ago
update-gre-address update copyright for 2023 1 month ago
update-tunnelbroker update copyright for 2023 1 month 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 relevant 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-custom/plain/";

screenshot: install custom script

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.

Linked custom scripts & modules

⚠️ Warning: These links are being provided for your convenience only; they do not constitute an endorsement or an approval by me. I bear no responsibility for the accuracy, legality or content of the external site or for that of subsequent links. Contact the external site for answers to questions regarding its content.

  • Hello World (This is a demo script to show how the linking to external documentation will be done.)

Info: You have your own set of scripts and/or modules and want these to be listed here? There should be a general info page that links here, and documentation for each script. You can start by cloning my Custom RouterOS-Scripts (or fork on GitHub or GitLab) and make your changes. Then please get in contact...

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 or pull request 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