mirror.MikroTik/eworm.routeros-scripts
1
0
Fork 0
mirror of https://git.eworm.de/cgit/routeros-scripts synced 2025-06-30 13:14:27 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge branch 'external-links' into next

Browse source
This commit is contained in:
Christian Hesse 2025-04-28 10:59:33 +02:00
commit 507a520994
13 changed files with 47 additions and 31 deletions
Download patch file Download diff file Expand all files Collapse all files

2
BRANCHES.md
View file

@ -13,7 +13,7 @@ Installing from branches
> ⚠️ **Warning**: Living on the edge? Great, read on! > ⚠️ **Warning**: Living on the edge? Great, read on!
> If not: Please use the `main` branch and leave this page! > If not: Please use the `main` branch and leave this page!
These scripts are developed in a [git](https://git-scm.com/) repository. These scripts are developed in a [git ↗️](https://git-scm.com/) repository.
Development and experimental branches are used to provide early access Development and experimental branches are used to provide early access
for specific changes. You can install scripts from these branches for specific changes. You can install scripts from these branches
for testing. for testing.

4
CERTIFICATES.md
View file

@ -21,7 +21,7 @@ first step of [installation](README.md#the-long-way-in-detail) is importing
the certificate. the certificate.
The scripts can install additional certificates when required. This happens The scripts can install additional certificates when required. This happens
from this repository if available, or from [mkcert.org](https://mkcert.org) from this repository if available, or from [mkcert.org ↗️](https://mkcert.org)
as a fallback. as a fallback.
Get the certificate's CommonName Get the certificate's CommonName
@ -29,7 +29,7 @@ Get the certificate's CommonName
But how to determine what certificate may be required? Often easiest way But how to determine what certificate may be required? Often easiest way
is to use a desktop browser to get that information. This demonstration uses is to use a desktop browser to get that information. This demonstration uses
[Mozilla Firefox](https://www.mozilla.org/firefox/). [Mozilla Firefox ↗️](https://www.mozilla.org/firefox/).
Let's assume we want to make sure the certificate for Let's assume we want to make sure the certificate for
[git.eworm.de](https://git.eworm.de/) is available. Open that page in the [git.eworm.de](https://git.eworm.de/) is available. Open that page in the

2
CONTRIBUTIONS.md
View file

@ -31,7 +31,7 @@ for details!
## Donations ## Donations
Add yourself to the list, Add yourself to the list,
[donate with PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=A4ZXBD6YS2W8J)! [donate with PayPal ↗️](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=A4ZXBD6YS2W8J)!
* Abdul Mannan Abbasi * Abdul Mannan Abbasi
* Andrea Ruffini Perico * Andrea Ruffini Perico

38
README.md
View file

@ -10,13 +10,14 @@ RouterOS Scripts
![RouterOS Scripts Logo](logo.svg) ![RouterOS Scripts Logo](logo.svg)
[RouterOS](https://mikrotik.com/software) is the operating system developed [RouterOS ↗️](https://mikrotik.com/software) is the operating system developed
by [MikroTik](https://mikrotik.com/aboutus) for networking tasks. This by [MikroTik ↗️](https://mikrotik.com/aboutus) for networking tasks. This
repository holds a number of [scripts](https://wiki.mikrotik.com/wiki/Manual:Scripting) repository holds a number of [scripts ↗️](https://wiki.mikrotik.com/wiki/Manual:Scripting)
to manage RouterOS devices or extend their functionality. to manage RouterOS devices or extend their functionality.
*Use at your own risk*, pay attention to *Use at your own risk*, pay attention to
[license and warranty](#license-and-warranty)! [license and warranty](#license-and-warranty), and
[disclaimer on external links](#disclaimer-on-external-links)!
Requirements Requirements
------------ ------------
@ -35,7 +36,7 @@ Specific scripts may require even newer RouterOS version.
> running RouterOS v6 switch to `routeros-v6` branch! > running RouterOS v6 switch to `routeros-v6` branch!
Starting with RouterOS 7.17 the Starting with RouterOS 7.17 the
[device-mode](https://help.mikrotik.com/docs/spaces/ROS/pages/93749258/Device-mode) [device-mode ↗️](https://help.mikrotik.com/docs/spaces/ROS/pages/93749258/Device-mode)
has been extended to give more fine-grained control over what features are has been extended to give more fine-grained control over what features are
available. You need to enable `scheduler` and `fetch` at least, specific available. You need to enable `scheduler` and `fetch` at least, specific
scripts may require additional features. scripts may require additional features.
@ -61,9 +62,9 @@ First time users should take the long way below.
### Live presentation ### Live presentation
Want to see it in action? I've had a presentation [Repository based Want to see it in action? I've had a presentation [Repository based
RouterOS script distribution](https://www.youtube.com/watch?v=B9neG3oAhcY) RouterOS script distribution ↗️](https://www.youtube.com/watch?v=B9neG3oAhcY)
including demonstation recorded live at [MUM Europe including demonstation recorded live at [MUM Europe
2019](https://mum.mikrotik.com/2019/EU/) in Vienna. 2019 ↗️](https://mum.mikrotik.com/2019/EU/) in Vienna.
> ⚠️ **Warning**: Some details changed. So see the presentation, then follow > ⚠️ **Warning**: Some details changed. So see the presentation, then follow
> the steps below for up-to-date commands. > the steps below for up-to-date commands.
@ -83,7 +84,7 @@ 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 want to be safe download with your workstations's browser and transfer the
file to your MikroTik device. file to your MikroTik device.
* [ISRG Root X2](https://letsencrypt.org/certs/isrg-root-x2.pem) * [ISRG Root X2 ↗️](https://letsencrypt.org/certs/isrg-root-x2.pem)
Then we import the certificate. Then we import the certificate.
@ -194,7 +195,7 @@ Scheduler and events
-------------------- --------------------
Most scripts are designed to run regularly from Most scripts are designed to run regularly from
[scheduler](https://wiki.mikrotik.com/wiki/Manual:System/Scheduler). We just [scheduler ↗️](https://wiki.mikrotik.com/wiki/Manual:System/Scheduler). We just
added `check-routeros-update`, so let's run it daily to make sure not to added `check-routeros-update`, so let's run it daily to make sure not to
miss an update. miss an update.
@ -328,7 +329,7 @@ Possibly a scheduler and other configuration has to be removed as well.
Contact Contact
------- -------
We have a Telegram Group [RouterOS-Scripts](https://t.me/routeros_scripts)! We have a Telegram Group [RouterOS-Scripts ↗️](https://t.me/routeros_scripts)!
[![RouterOS Scripts Telegram Group](README.d/telegram-group.avif)](https://t.me/routeros_scripts) [![RouterOS Scripts Telegram Group](README.d/telegram-group.avif)](https://t.me/routeros_scripts)
@ -352,7 +353,7 @@ at github.
This project is developed in private spare time and usage is free of charge 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 for you. If you like the scripts and think this is of value for you or your
business please consider to business please consider to
[donate with PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=A4ZXBD6YS2W8J). [donate with PayPal ↗️](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=A4ZXBD6YS2W8J).
[![donate with PayPal](https://img.shields.io/badge/Like_it%3F-Donate!-orange?logo=githubsponsors&logoColor=orange&style=for-the-badge)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=A4ZXBD6YS2W8J) [![donate with PayPal](https://img.shields.io/badge/Like_it%3F-Donate!-orange?logo=githubsponsors&logoColor=orange&style=for-the-badge)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=A4ZXBD6YS2W8J)
@ -371,6 +372,21 @@ but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
[GNU General Public License](COPYING.md) for more details. [GNU General Public License](COPYING.md) for more details.
Disclaimer on external links
----------------------------
Our website contains links to the websites of third parties ("external
links"). As the content of these websites is not under our control, we
cannot assume any liability for such external content. In all cases, the
provider of information of the linked websites is liable for the content
and accuracy of the information provided. At the point in time when the
links were placed, no infringements of the law were recognisable to us.
As soon as an infringement of the law becomes known to us, we will
immediately remove the link in question.
> 💡️ **Hint**: All external links are marked with an arrow pointing
> diagonally in an up-right (or north-east) direction (↗️).
Upstream Upstream
-------- --------

2
doc/backup-cloud.md
View file

@ -17,7 +17,7 @@ Description
----------- -----------
This script uploads This script uploads
[binary backup to Mikrotik cloud](https://wiki.mikrotik.com/wiki/Manual:IP/Cloud#Backup). [binary backup to Mikrotik cloud ↗️](https://wiki.mikrotik.com/wiki/Manual:IP/Cloud#Backup).
> ⚠️ **Warning**: The used command can hit errors that a script can with > ⚠️ **Warning**: The used command can hit errors that a script can with
> workaround only. A notification *should* be sent anyway. But it can result > workaround only. A notification *should* be sent anyway. But it can result

2
doc/backup-partition.md
View file

@ -17,7 +17,7 @@ Description
----------- -----------
This script saves the current configuration to fallback This script saves the current configuration to fallback
[partition](https://wiki.mikrotik.com/wiki/Manual:Partitions). [partition ↗️](https://wiki.mikrotik.com/wiki/Manual:Partitions).
It can also copy-over the RouterOS installation when run interactively It can also copy-over the RouterOS installation when run interactively
or just before a feature update. or just before a feature update.

4
doc/check-routeros-update.md
View file

@ -30,8 +30,8 @@ automatically is supported.
> ⚠️ **Warning**: Installing updates is important from a security point > ⚠️ **Warning**: Installing updates is important from a security point
> of view. At the same time it can be source of serve breakage. So test > of view. At the same time it can be source of serve breakage. So test
> versions in lab and read > versions in lab and read
> [changelog](https://mikrotik.com/download/changelogs/) and > [changelog ↗️](https://mikrotik.com/download/changelogs/) and
> [forum](https://forum.mikrotik.com/viewforum.php?f=21) before deploying > [forum ↗️](https://forum.mikrotik.com/viewforum.php?f=21) before deploying
> to your production environment! Automatic updates should be handled > to your production environment! Automatic updates should be handled
> with care! > with care!

8
doc/fw-addr-lists.md
View file

@ -19,10 +19,10 @@ Description
This script downloads, imports and updates firewall address-lists. Its main This script downloads, imports and updates firewall address-lists. Its main
purpose is to block attacking ip addresses, spam hosts, command-and-control purpose is to block attacking ip addresses, spam hosts, command-and-control
servers and similar malicious entities. The default configuration contains a servers and similar malicious entities. The default configuration contains a
[collective list by GitHub user @stamparm](https://github.com/stamparm/ipsum), [collective list by GitHub user @stamparm ↗️](https://github.com/stamparm/ipsum),
lists from [dshield.org](https://dshield.org/) and lists from [dshield.org ↗️](https://dshield.org/) and
[blocklist.de](https://www.blocklist.de/), and lists from [blocklist.de ↗️](https://www.blocklist.de/), and lists from
[spamhaus.org](https://spamhaus.org/) are prepared. [spamhaus.org ↗️](https://spamhaus.org/) are prepared.
The address-lists are updated in place, so after initial import you will not The address-lists are updated in place, so after initial import you will not
see situation when the lists are not populated. see situation when the lists are not populated.

2
doc/log-forward.md
View file

@ -72,7 +72,7 @@ The configuration goes to `global-config-overlay`, these are the parameters:
> your local `global-config-overlay` and modify it to your specific needs. > your local `global-config-overlay` and modify it to your specific needs.
These patterns are matched as These patterns are matched as
[regular expressions](https://wiki.mikrotik.com/wiki/Manual:Regular_Expressions). [regular expressions ↗️](https://wiki.mikrotik.com/wiki/Manual:Regular_Expressions).
To forward **all** (ignoring severity) log messages with topics `account` To forward **all** (ignoring severity) log messages with topics `account`
(which includes user logins) and `dhcp` you need something like: (which includes user logins) and `dhcp` you need something like:

2
doc/mod/notification-email.md
View file

@ -32,7 +32,7 @@ Configuration
------------- -------------
Set up your device's Set up your device's
[e-mail settings](https://wiki.mikrotik.com/wiki/Manual:Tools/email). [e-mail settings ↗️](https://wiki.mikrotik.com/wiki/Manual:Tools/email).
Also make sure the device has correct time configured, best is to set up Also make sure the device has correct time configured, best is to set up
the ntp client. the ntp client.

2
doc/mod/notification-matrix.md
View file

@ -17,7 +17,7 @@ Description
----------- -----------
This module adds support for sending notifications via This module adds support for sending notifications via
[Matrix](https://matrix.org/) via client server api. A queue is used to [Matrix ↗️](https://matrix.org/) via client server api. A queue is used to
make sure notifications are not lost on failure but sent later. make sure notifications are not lost on failure but sent later.
Requirements and installation Requirements and installation

4
doc/mod/notification-ntfy.md
View file

@ -17,7 +17,7 @@ Description
----------- -----------
This module adds support for sending notifications via This module adds support for sending notifications via
[Ntfy](https://ntfy.sh/). A queue is used to make sure [Ntfy ↗️](https://ntfy.sh/). A queue is used to make sure
notifications are not lost on failure but sent later. notifications are not lost on failure but sent later.
Requirements and installation Requirements and installation
@ -28,7 +28,7 @@ Just install the module:
$ScriptInstallUpdate mod/notification-ntfy; $ScriptInstallUpdate mod/notification-ntfy;
Also install the Ntfy app on your mobile device or use the Also install the Ntfy app on your mobile device or use the
[web app](https://ntfy.sh/app) in a browser of your choice. [web app ↗️](https://ntfy.sh/app) in a browser of your choice.
Configuration Configuration
------------- -------------

6
doc/mod/notification-telegram.md
View file

@ -17,7 +17,7 @@ Description
----------- -----------
This module adds support for sending notifications via This module adds support for sending notifications via
[Telegram](https://telegram.org/) via bot api. A queue is used to make sure [Telegram ↗️](https://telegram.org/) via bot api. A queue is used to make sure
notifications are not lost on failure but sent later. notifications are not lost on failure but sent later.
Requirements and installation Requirements and installation
@ -33,7 +33,7 @@ and create an account.
Configuration Configuration
------------- -------------
Open Telegram, then start a chat with [BotFather](https://t.me/BotFather) and Open Telegram, then start a chat with [BotFather ↗️](https://t.me/BotFather) and
create your own bot: create your own bot:
![create new bot](notification-telegram.d/newbot.avif) ![create new bot](notification-telegram.d/newbot.avif)
@ -102,7 +102,7 @@ Tips & Tricks
### Set a profile photo ### Set a profile photo
You can use a profile photo for your bot to make it recognizable. Open the You can use a profile photo for your bot to make it recognizable. Open the
chat with [BotFather](https://t.me/BotFather) and set it there. chat with [BotFather ↗️](https://t.me/BotFather) and set it there.
![set profile photo](notification-telegram.d/setuserpic.avif) ![set profile photo](notification-telegram.d/setuserpic.avif)