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!
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.
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.
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 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/Let%27s%20Encrypt%20Authority%20X3.pem" dst-path="letsencrypt.pem"
status: finished
downloaded: 3KiBC-z pause]
total: 3KiB
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.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 certifiactes and print their count. Make sure the certificate count is three.
[admin@MikroTik] > / certificate set name="ISRG-Root-X1" [ find where fingerprint="96bcec06264976f37460779acf28c5a7cfe8a3c0aae11a8ffcee05c0bddf08c6" ]
[admin@MikroTik] > / certificate set name="Let-s-Encrypt-Authority-X3" [ find where fingerprint="731d3d9cfaa061487a1d71445a42f67df0afca2a6c2d2f98ff7b3ce112b1f568" ]
[admin@MikroTik] > / certificate set name="DST-Root-CA-X3" [ find where fingerprint="0687260331a72403d909f105e69bcf0d32e1bd2493ffc6d9206d11bcd6770739" ]
[admin@MikroTik] > / certificate print count-only where fingerprint="96bcec06264976f37460779acf28c5a7cfe8a3c0aae11a8ffcee05c0bddf08c6" or fingerprint="731d3d9cfaa061487a1d71445a42f67df0afca2a6c2d2f98ff7b3ce112b1f568" 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. Make sure not to send
your mails to mail@example.com! 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; }"
To update existing scripts just run function $ScriptInstallUpdate.
[admin@MikroTik] > $ScriptInstallUpdate
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
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!
- Find and remove access list duplicates
- Manage ports in bridge
- Download packages for CAP upgrade from CAPsMAN
- Run rolling CAP upgrades from CAPsMAN
- Renew locally issued certificates
- Renew certificates and notify on expiration
- Notify about health state
- Notify on LTE firmware upgrade
- Notify on RouterOS update
- Upload backup to Mikrotik cloud
- Collect MAC addresses in wireless access list
- Use wireless network with daily psk
- Comment DHCP leases with info from access list
- Create DNS records for DHCP leases
- Send backup via e-mail
- Wait for configuration und functions
- Send GPS position to server
- Use WPA2 network with hotspot credentials
- Update configuration on IPv6 prefix change
- Manage IP addresses with bridge status
- Run other scripts on DHCP lease
- Manage LEDs dark mode
- Forward log messages via notification
- Mode botton with multiple presses
- Notify on host up and down
- Manage remote logging
- Manage system update
- Run scripts on ppp connection
- Rotate NTP servers
- Act on received SMS
- Forward received SMS
- Import SSH keys
- Play Super Mario theme
- Install LTE firmware upgrade
- Update GRE configuration with dynamic addresses
- Update tunnelbroker configuration
- Upload backup to server
Thanks a lot for past contributions!
Feel free to contact me via e-mail or open an issue at github.
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.
Thanks a lot for your support!
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.
URL: GitHub.com
Mirror: eworm.de GitLab.com