a collection of scripts for MikroTik RouterOS
Find a file
Christian Hesse 2db73a189c global-functions: $ScriptInstallUpdate: fix change notification
In RouterOS functions are of type 'array' with 'code' (numerical index 1)
inside. Cast to string to make comparison work.

Also define the function to make it available.
2021-02-18 21:45:38 +01:00
certs certs: add plain text info about certificates 2020-12-30 00:45:11 +01:00
doc ipv6-update: update interface specific address list entries 2020-12-18 10:11:18 +01:00
.gitignore ignore all html files 2019-01-02 16:26:32 +01:00
accesslist-duplicates.capsman update copyright for 2021 2021-01-01 21:33:52 +01:00
accesslist-duplicates.local update copyright for 2021 2021-01-01 21:33:52 +01:00
accesslist-duplicates.template update copyright for 2021 2021-01-01 21:33:52 +01:00
bridge-port-to-default update copyright for 2021 2021-01-01 21:33:52 +01:00
bridge-port-toggle update copyright for 2021 2021-01-01 21:33:52 +01:00
capsman-download-packages capsman-download-packages: handle error when creating directory 2021-01-20 14:43:27 +01:00
capsman-rolling-upgrade update copyright for 2021 2021-01-01 21:33:52 +01:00
certificate-renew-issued certificate-renew-issued: handle error when creating directory 2021-01-20 14:38:11 +01:00
check-certificates global-functions: drop support for attachment in notification e-mail 2021-02-16 16:04:18 +01:00
check-health update copyright for 2021 2021-01-01 21:33:52 +01:00
check-lte-firmware-upgrade global-functions: drop support for attachment in notification e-mail 2021-02-16 16:04:18 +01:00
check-routeros-update global-functions: drop support for attachment in notification e-mail 2021-02-16 16:04:18 +01:00
cloud-backup cloud-backup: wait to be fully connected 2021-02-18 09:12:07 +01:00
collect-wireless-mac.capsman collect-wireless-mac: always use first entry to place before 2021-01-03 20:33:32 +01:00
collect-wireless-mac.local collect-wireless-mac: always use first entry to place before 2021-01-03 20:33:32 +01:00
collect-wireless-mac.template collect-wireless-mac: always use first entry to place before 2021-01-03 20:33:32 +01:00
CONTRIBUTIONS.md update list of contributors 2020-12-30 12:47:55 +01:00
COPYING.md explicitly name the license 2020-06-19 22:17:42 +02:00
daily-psk.capsman daily-psk: drop support for attaching QR-Code 2021-02-16 16:01:36 +01:00
daily-psk.local daily-psk: drop support for attaching QR-Code 2021-02-16 16:01:36 +01:00
daily-psk.template daily-psk: drop support for attaching QR-Code 2021-02-16 16:01:36 +01:00
dhcp-lease-comment.capsman update copyright for 2021 2021-01-01 21:33:52 +01:00
dhcp-lease-comment.local update copyright for 2021 2021-01-01 21:33:52 +01:00
dhcp-lease-comment.template update copyright for 2021 2021-01-01 21:33:52 +01:00
dhcp-to-dns dhcp-to-dns: always use first entry to place before 2021-01-03 20:34:04 +01:00
early-errors extend magic pattern with "by RouterOS" 2020-09-18 11:00:27 +02:00
email-backup email-backup: no example address, complain if missing 2021-02-18 12:54:04 +01:00
global-config email-backup: no example address, complain if missing 2021-02-18 12:54:04 +01:00
global-config-overlay global-functions: send (and re-send) e-mails from queue 2021-02-16 16:45:13 +01:00
global-config.changes global-functions: send (and re-send) e-mails from queue 2021-02-16 16:45:13 +01:00
global-functions global-functions: $ScriptInstallUpdate: fix change notification 2021-02-18 21:45:38 +01:00
global-wait update copyright for 2021 2021-01-01 21:33:52 +01:00
gps-track update copyright for 2021 2021-01-01 21:33:52 +01:00
hotspot-to-wpa hotspot-to-wpa: always use first entry to place before 2021-01-03 20:34:19 +01:00
INITIAL-COMMANDS.md INITIAL-COMMANDS: drop Let's Encrypt Authority X3 2020-12-18 20:32:29 +01:00
ip-addr-bridge update copyright for 2021 2021-01-01 21:33:52 +01:00
ipv6-update ipv6-update: simplify the code... 2021-01-03 20:27:24 +01:00
learn-mac-based-vlan update copyright for 2021 2021-01-01 21:33:52 +01:00
lease-script update copyright for 2021 2021-01-01 21:33:52 +01:00
leds-day-mode update copyright for 2021 2021-01-01 21:33:52 +01:00
leds-night-mode update copyright for 2021 2021-01-01 21:33:52 +01:00
leds-toggle-mode update copyright for 2021 2021-01-01 21:33:52 +01:00
log-forward global-functions: drop $MailServerIsUp 2021-02-16 16:45:13 +01:00
Makefile Makefile: update links for generated html 2019-01-02 16:22:14 +01:00
manage-umts update copyright for 2021 2021-01-01 21:33:52 +01:00
mode-button update copyright for 2021 2021-01-01 21:33:52 +01:00
mode-button-event mode-button: merge mode-button-event & mode-button-scheduler 2020-10-16 08:24:19 +02:00
mode-button-scheduler mode-button: merge mode-button-event & mode-button-scheduler 2020-10-16 08:24:19 +02:00
netwatch-notify update copyright for 2021 2021-01-01 21:33:52 +01:00
netwatch-syslog update copyright for 2021 2021-01-01 21:33:52 +01:00
ospf-to-leds update copyright for 2021 2021-01-01 21:33:52 +01:00
packages-update update copyright for 2021 2021-01-01 21:33:52 +01:00
ppp-on-up update copyright for 2021 2021-01-01 21:33:52 +01:00
README.md README: fix typo 2021-02-18 11:30:04 +01:00
rotate-ntp update copyright for 2021 2021-01-01 21:33:52 +01:00
script-updates extend magic pattern with "by RouterOS" 2020-09-18 11:00:27 +02:00
sms-action update copyright for 2021 2021-01-01 21:33:52 +01:00
sms-forward global-functions: drop $MailServerIsUp 2021-02-16 16:45:13 +01:00
ssh-keys-import update copyright for 2021 2021-01-01 21:33:52 +01:00
super-mario-theme update copyright for 2021 2021-01-01 21:33:52 +01:00
unattended-lte-firmware-upgrade update copyright for 2021 2021-01-01 21:33:52 +01:00
update-gre-address update copyright for 2021 2021-01-01 21:33:52 +01:00
update-tunnelbroker update copyright for 2021 2021-01-01 21:33:52 +01:00
upload-backup upload-backup: wait to be fully connected 2021-02-18 09:12:44 +01:00

RouterOS Scripts

GitHub forks GitHub stars GitHub watchers

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.

Be warned! 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.

[admin@MikroTik] > / tool fetch "https://git.eworm.de/cgit/routeros-scripts/plain/certs/R3.pem" dst-path="letsencrypt-R3.pem"
      status: finished
  downloaded: 4KiBC-z pause]
       total: 4KiB
    duration: 1s

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.

[admin@MikroTik] > / certificate import file-name=letsencrypt-R3.pem passphrase=""
     certificates-imported: 3
     private-keys-imported: 0
            files-imported: 1
       decryption-failures: 0
  keys-with-no-certificate: 0

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

[admin@MikroTik] > / certificate set name="R3" [ find where fingerprint="67add1166b020ae61b8f5fc96813c04c2aa589960796865572a3c7e737613dfd" ]
[admin@MikroTik] > / certificate set name="ISRG-Root-X1" [ find where fingerprint="96bcec06264976f37460779acf28c5a7cfe8a3c0aae11a8ffcee05c0bddf08c6" ]
[admin@MikroTik] > / certificate set name="DST-Root-CA-X3" [ find where fingerprint="0687260331a72403d909f105e69bcf0d32e1bd2493ffc6d9206d11bcd6770739" ]
[admin@MikroTik] > / certificate print count-only where fingerprint="67add1166b020ae61b8f5fc96813c04c2aa589960796865572a3c7e737613dfd" or fingerprint="96bcec06264976f37460779acf28c5a7cfe8a3c0aae11a8ffcee05c0bddf08c6" or fingerprint="0687260331a72403d909f105e69bcf0d32e1bd2493ffc6d9206d11bcd6770739"
3

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

Actually we do not require the certificate named DST Root CA X3, but as it is used by Let's Encrypt to cross-sign we install it anyway - this makes sure things do not go wrong if the intermediate certificate is replaced. The IdenTrust certificate should be available from their download page. The site is crap and a good example how to not do it.

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

[admin@MikroTik] > :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"); }

Mark global-config-overlay not to be overwritten by future updates.

[admin@MikroTik] > / system script set comment="ignore" global-config-overlay

The configuration needs to be tweaked for your needs. Edit global-config-overlay, copy configuration from global-config (the one without -overlay).

[admin@MikroTik] > / system script edit global-config-overlay source

And finally load configuration and functions and add the scheduler.

[admin@MikroTik] > / system script { run global-config; run global-config-overlay; run global-functions; }
[admin@MikroTik] > / system scheduler add name="global-scripts" start-time=startup on-event="/ system script { run global-config; run global-config-overlay; run global-functions; }"

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

[admin@MikroTik] > / system scheduler add name="ScriptInstallUpdate" start-time=startup interval=1d on-event=":global ScriptInstallUpdate; \$ScriptInstallUpdate;"

Updating scripts

To update existing scripts just run function $ScriptInstallUpdate.

[admin@MikroTik] > $ScriptInstallUpdate

Adding a script

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

[admin@MikroTik] > $ScriptInstallUpdate check-certificates,check-routeros-update

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.

[admin@MikroTik] > / system scheduler add name="check-routeros-update" interval=1h on-event="/ system script run check-routeros-update;"

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.

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

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

Available Scripts

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