Go to file
Christian Hesse 698c795eee update list of contributors 2021-07-15 11:25:46 +02:00
certs drop certificate DST Root CA X3 2021-05-18 16:32:26 +02:00
doc doc/netwatch-notify: hint on escaping, with example 2021-07-09 12:46:03 +02:00
global-functions.d global-functions.d/notification-telegram: subject in bold & underline 2021-07-09 21:21:30 +02:00
.gitignore ignore all html files 2019-01-02 16:26:32 +01:00
CONTRIBUTIONS.md update list of contributors 2021-07-15 11:25:46 +02:00
COPYING.md explicitly name the license 2020-06-19 22:17:42 +02:00
INITIAL-COMMANDS.md INITIAL-COMMANDS: make github copy function work 2021-06-08 20:58:25 +02:00
Makefile Makefile: generate html files for documentation 2021-06-18 11:23:58 +02:00
README.md drop certificate DST Root CA X3 2021-05-18 16:32:26 +02:00
accesslist-duplicates.capsman global: give script or function name in log messages 2021-02-24 21:51:54 +01:00
accesslist-duplicates.local global: give script or function name in log messages 2021-02-24 21:51:54 +01:00
accesslist-duplicates.template global: give script or function name in log messages 2021-02-24 21:51:54 +01:00
bridge-port-to-default global: give script or function name in log messages 2021-02-24 21:51:54 +01:00
bridge-port-toggle global: give script or function name in log messages 2021-02-24 21:51:54 +01:00
capsman-download-packages global: use $0 for $ScriptLock 2021-02-24 21:51:56 +01:00
capsman-rolling-upgrade capsman-rolling-upgrade: properly handle vanished cap 2021-04-29 15:34:09 +02:00
certificate-renew-issued global: give script or function name in log messages 2021-02-24 21:51:54 +01:00
check-certificates check-certificates: fix variable name 2021-05-21 08:31:45 +02:00
check-health check-health: pass origin to $SendNotification2 2021-04-28 13:58:37 +02:00
check-lte-firmware-upgrade check-lte-firmware-upgrade: pass origin to $SendNotification2 2021-04-28 13:58:37 +02:00
check-routeros-update check-routeros-update: allow update for cap 2021-07-01 22:56:18 +02:00
cloud-backup packages-update: use 'provides' to find backup scripts 2021-06-23 08:38:44 +02:00
collect-wireless-mac.capsman collect-wireless-mac: check for existence of mac address 2021-07-11 22:30:00 +02:00
collect-wireless-mac.local collect-wireless-mac: check for existence of mac address 2021-07-11 22:30:00 +02:00
collect-wireless-mac.template collect-wireless-mac: check for existence of mac address 2021-07-11 22:30:00 +02:00
daily-psk.capsman daily-psk: pass origin to $SendNotification2 2021-04-28 13:58:37 +02:00
daily-psk.local daily-psk: pass origin to $SendNotification2 2021-04-28 13:58:37 +02:00
daily-psk.template daily-psk: pass origin to $SendNotification2 2021-04-28 13:58:37 +02:00
dhcp-lease-comment.capsman lease-script: implement script order 2021-07-08 21:03:31 +02:00
dhcp-lease-comment.local lease-script: implement script order 2021-07-08 21:03:31 +02:00
dhcp-lease-comment.template lease-script: implement script order 2021-07-08 21:03:31 +02:00
dhcp-to-dns lease-script: implement script order 2021-07-08 21:03:31 +02:00
email-backup packages-update: use 'provides' to find backup scripts 2021-06-23 08:38:44 +02:00
global-config global-functions: introduce $ScriptRunOnce 2021-07-10 23:18:04 +02:00
global-config-overlay global-functions: introduce $ScriptRunOnce 2021-07-10 23:18:04 +02:00
global-config.changes global-functions: introduce $ScriptRunOnce 2021-07-10 23:18:04 +02:00
global-functions global-functions: $ScriptLock: fix off-by-one check... 2021-07-15 10:17:25 +02:00
gps-track gps-track: silence fetch 2021-02-24 22:55:08 +01:00
hotspot-to-wpa global: give script or function name in log messages 2021-02-24 21:51:54 +01:00
hotspot-to-wpa-cleanup lease-script: implement script order 2021-07-08 21:03:31 +02:00
ip-addr-bridge update copyright for 2021 2021-01-01 21:33:52 +01:00
ipsec-to-dns add 'ipsec-to-dns' 2021-05-17 16:41:51 +02:00
ipv6-update ipv6-update: use $LogPrintExit2 2021-06-23 15:15:19 +02:00
learn-mac-based-vlan update copyright for 2021 2021-01-01 21:33:52 +01:00
lease-script lease-script: add the order in log 2021-07-08 21:03:31 +02: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 log-forward: use $HexToNum, do not resend old messages 2021-06-15 16:59:02 +02:00
logo.png logo: clean png export 2021-05-07 09:18:39 +02:00
logo.svg logo: convert text to path 2021-05-07 09:16:52 +02:00
manage-umts update copyright for 2021 2021-01-01 21:33:52 +01:00
mode-button mode-button: use $ValidateSyntax 2021-02-26 16:01:39 +01:00
netwatch-notify netwatch-notify: implement pre-down hook 2021-07-09 12:46:03 +02:00
netwatch-syslog update copyright for 2021 2021-01-01 21:33:52 +01:00
ospf-to-leds ospf-to-leds: do not flood but log properly 2021-07-06 21:41:33 +02:00
packages-update packages-update: use 'provides' to find backup scripts 2021-06-23 08:38:44 +02:00
ppp-on-up ppp-on-up: use $LogPrintExit2 2021-06-23 15:15:19 +02:00
rotate-ntp global: give script or function name in log messages 2021-02-24 21:51:54 +01:00
sms-action sms-action: use $ValidateSyntax 2021-02-26 15:51:29 +01:00
sms-forward sms-forward: pass origin to $SendNotification2 2021-04-28 13:58:37 +02: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 unattended-lte-firmware-upgrade: skip interface on missing firmware information 2021-02-26 12:21:38 +01:00
update-gre-address global: give script or function name in log messages 2021-02-24 21:51:54 +01:00
update-tunnelbroker ppp-on-up: use 'provides' to find ppp-on-up scripts 2021-06-23 10:21:34 +02:00
upload-backup packages-update: use 'provides' to find backup scripts 2021-06-23 08:38:44 +02:00

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.

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: 2
     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 two.

[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 print count-only where fingerprint="67add1166b020ae61b8f5fc96813c04c2aa589960796865572a3c7e737613dfd" or fingerprint="96bcec06264976f37460779acf28c5a7cfe8a3c0aae11a8ffcee05c0bddf08c6"
2

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

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"); }

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