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 842c44b10a global-functions: $DNSIsResolving: have a final return 1 day ago
certs global-functions: $GetMacVendor: requires certificate "Cloudflare Inc ECC CA-3" now 1 week ago
doc doc/unattended-lte-firmware-upgrade: broadband connection is required! 6 days ago
.gitignore ignore all html files 2 years ago
CONTRIBUTIONS.md update list of contributors 2 months ago
COPYING.md explicitly name the license 8 months ago
INITIAL-COMMANDS.md INITIAL-COMMANDS: drop Let's Encrypt Authority X3 2 months ago
Makefile Makefile: update links for generated html 2 years ago
README.md We have a Telegram group! 1 week ago
accesslist-duplicates.capsman global: give script or function name in log messages 1 week ago
accesslist-duplicates.local global: give script or function name in log messages 1 week ago
accesslist-duplicates.template global: give script or function name in log messages 1 week ago
bridge-port-to-default global: give script or function name in log messages 1 week ago
bridge-port-toggle global: give script or function name in log messages 1 week ago
capsman-download-packages global: use $0 for $ScriptLock 1 week ago
capsman-rolling-upgrade global: use $0 for $ScriptLock 1 week ago
certificate-renew-issued global: give script or function name in log messages 1 week ago
check-certificates check-certificates: silence fetch 1 week ago
check-health global: give script or function name in log messages 1 week ago
check-lte-firmware-upgrade global: give script or function name in log messages 1 week ago
check-routeros-update global: use $0 for $ScriptFromTerminal 1 week ago
cloud-backup cloud-backup: add configurable random delay 1 week ago
collect-wireless-mac.capsman global: use $0 for $ScriptLock 1 week ago
collect-wireless-mac.local global: use $0 for $ScriptLock 1 week ago
collect-wireless-mac.template global: use $0 for $ScriptLock 1 week ago
daily-psk.capsman global: give script or function name in log messages 1 week ago
daily-psk.local global: give script or function name in log messages 1 week ago
daily-psk.template global: give script or function name in log messages 1 week ago
dhcp-lease-comment.capsman global: give script or function name in log messages 1 week ago
dhcp-lease-comment.local global: give script or function name in log messages 1 week ago
dhcp-lease-comment.template global: give script or function name in log messages 1 week ago
dhcp-to-dns global: give script or function name in log messages 1 week ago
early-errors global: give script or function name in log messages 1 week ago
email-backup email-backup: add configurable random delay 1 week ago
global-config let's keep next branch and document it 1 week ago
global-config-overlay certs: remove obsolote certificate "Let's Encrypt Authority X3" 1 week ago
global-config.changes certs: remove obsolote certificate "Let's Encrypt Authority X3" 1 week ago
global-functions global-functions: $DNSIsResolving: have a final return 1 day ago
global-wait global: give script or function name in log messages 1 week ago
gps-track gps-track: silence fetch 1 week ago
hotspot-to-wpa global: give script or function name in log messages 1 week ago
ip-addr-bridge update copyright for 2021 2 months ago
ipv6-update global: give script or function name in log messages 1 week ago
learn-mac-based-vlan update copyright for 2021 2 months ago
lease-script global: give script or function name in log messages 1 week ago
leds-day-mode update copyright for 2021 2 months ago
leds-night-mode update copyright for 2021 2 months ago
leds-toggle-mode update copyright for 2021 2 months ago
log-forward global: use $0 for $ScriptLock 1 week ago
manage-umts update copyright for 2021 2 months ago
mode-button mode-button: use $ValidateSyntax 6 days ago
mode-button-event global: give script or function name in log messages 1 week ago
mode-button-scheduler global: give script or function name in log messages 1 week ago
netwatch-notify netwatch-notify: use $ValidateSyntax 6 days ago
netwatch-syslog update copyright for 2021 2 months ago
ospf-to-leds global: give script or function name in log messages 1 week ago
packages-update global: use $0 for $ScriptFromTerminal 1 week ago
ppp-on-up global: give script or function name in log messages 1 week ago
rotate-ntp global: give script or function name in log messages 1 week ago
script-updates global: give script or function name in log messages 1 week ago
sms-action sms-action: use $ValidateSyntax 6 days ago
sms-forward global: use $0 for $ScriptLock 1 week ago
ssh-keys-import update copyright for 2021 2 months ago
super-mario-theme update copyright for 2021 2 months ago
unattended-lte-firmware-upgrade unattended-lte-firmware-upgrade: skip interface on missing firmware information 6 days ago
update-gre-address global: give script or function name in log messages 1 week ago
update-tunnelbroker update-tunnelbroker: silence fetch 1 week ago
upload-backup upload-backup: add configurable random delay 1 week ago

README.md

RouterOS Scripts

GitHub stars GitHub forks 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

Contact

We have a Telegram Group RouterOS-Scripts! 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