diff --git a/README.md b/README.md index f7143ddf..6a0d1d89 100644 --- a/README.md +++ b/README.md @@ -230,7 +230,7 @@ everything is up-to-date it will not produce any output. If the update includes news or requires configuration changes a notification is sent - in addition to terminal output and log messages. -![news and changes notification](README.d/notification-news-and-changes.avif) +![notification: news and changes](README.d/notification-news-and-changes.avif) Adding a script --------------- diff --git a/contrib/html.sh b/contrib/html.sh index adacbbb8..0fca66ee 100755 --- a/contrib/html.sh +++ b/contrib/html.sh @@ -17,6 +17,7 @@ markdown -f toc,idanchor "${1}" | sed \ -e '//s|pre|pre class="code" onclick="CopyToClipboard(this)"|g' \ + -e '/[a-z]\+: .*/s|alt="\([a-z]\+\):|class="\1" alt="\1:|' \ -e '/The above link may be broken on code hosting sites/s|blockquote|blockquote style="display: none;"|' sed \ diff --git a/contrib/html.sh.d/foot.html b/contrib/html.sh.d/foot.html index 9e28e115..f7c0b83b 100644 --- a/contrib/html.sh.d/foot.html +++ b/contrib/html.sh.d/foot.html @@ -1,3 +1,4 @@ +

RouterOS Scripts documentation generated on __DATE__ for __VERSION__
Copyright © 2013-2026 Christian Hesse <mail@eworm.de>

diff --git a/contrib/html.sh.d/head.html b/contrib/html.sh.d/head.html index 656a63c0..8621350c 100644 --- a/contrib/html.sh.d/head.html +++ b/contrib/html.sh.d/head.html @@ -6,7 +6,7 @@ - +
eworm on meadow QR code: rsc.eworm.de RouterOS Scripts
@@ -14,3 +14,4 @@
+ diff --git a/contrib/logo-color.html b/contrib/logo-color.html index c39a20b8..e369694f 100644 --- a/contrib/logo-color.html +++ b/contrib/logo-color.html @@ -40,9 +40,9 @@ something that differentiates? Color it!

Then right-click, click "Take Screenshot" and finally select the logo and download it.

-

Screenshot Browser 01

-

Screenshot Browser 02

-

Screenshot Browser 03

+

screenshot: browser 01

+

screenshot: browser 02

+

screenshot: browser 03

(This example is with Mozilla Firefox ↗️. The workflow diff --git a/doc/backup-cloud.md b/doc/backup-cloud.md index dcbd0f75..05187652 100644 --- a/doc/backup-cloud.md +++ b/doc/backup-cloud.md @@ -26,7 +26,7 @@ This script uploads ### Sample notification -![backup-cloud notification](backup-cloud.d/notification.avif) +![notification: backup-cloud](backup-cloud.d/notification.avif) Requirements and installation ----------------------------- diff --git a/doc/backup-upload.md b/doc/backup-upload.md index bbf5227b..eb79671b 100644 --- a/doc/backup-upload.md +++ b/doc/backup-upload.md @@ -26,7 +26,7 @@ configuration export (`/export terse show-sensitive`) to external server. ### Sample notification -![backup-upload notification](backup-upload.d/notification.avif) +![notification: backup-upload](backup-upload.d/notification.avif) Requirements and installation ----------------------------- diff --git a/doc/check-certificates.md b/doc/check-certificates.md index c6db7c88..c4df2ba1 100644 --- a/doc/check-certificates.md +++ b/doc/check-certificates.md @@ -21,8 +21,8 @@ certificates that are still about to expire. ### Sample notifications -![check-certificates notification warning](check-certificates.d/notification-01-warn.avif) -![check-certificates notification renew](check-certificates.d/notification-02-renew.avif) +![notification: check-certificates warning](check-certificates.d/notification-01-warn.avif) +![notification: check-certificates renew](check-certificates.d/notification-02-renew.avif) Requirements and installation ----------------------------- diff --git a/doc/check-health.md b/doc/check-health.md index d67a3dde..8ec79f5e 100644 --- a/doc/check-health.md +++ b/doc/check-health.md @@ -40,27 +40,27 @@ sensors available in hardware: #### CPU utilization -![check-health notification cpu utilization high](check-health.d/notification-01-cpu-utilization-high.avif) -![check-health notification cpu utilization ok](check-health.d/notification-02-cpu-utilization-ok.avif) +![notification: check-health cpu utilization high](check-health.d/notification-01-cpu-utilization-high.avif) +![notification: check-health cpu utilization ok](check-health.d/notification-02-cpu-utilization-ok.avif) #### RAM utilization (low available RAM) -![check-health notification ram utilization high](check-health.d/notification-03-ram-utilization-high.avif) -![check-health notification ram utilization ok](check-health.d/notification-04-ram-utilization-ok.avif) +![notification: check-health ram utilization high](check-health.d/notification-03-ram-utilization-high.avif) +![notification: check-health ram utilization ok](check-health.d/notification-04-ram-utilization-ok.avif) #### Voltage -![check-health notification voltage](check-health.d/notification-05-voltage.avif) +![notification: check-health voltage](check-health.d/notification-05-voltage.avif) #### Temperature -![check-health notification temperature high](check-health.d/notification-06-temperature-high.avif) -![check-health notification temperature ok](check-health.d/notification-07-temperature-ok.avif) +![notification: check-health temperature high](check-health.d/notification-06-temperature-high.avif) +![notification: check-health temperature ok](check-health.d/notification-07-temperature-ok.avif) #### PSU state -![check-health notification state fail](check-health.d/notification-08-state-fail.avif) -![check-health notification state ok](check-health.d/notification-09-state-ok.avif) +![notification: check-health state fail](check-health.d/notification-08-state-fail.avif) +![notification: check-health state ok](check-health.d/notification-09-state-ok.avif) Requirements and installation ----------------------------- diff --git a/doc/check-lte-firmware-upgrade.md b/doc/check-lte-firmware-upgrade.md index 37ca4896..0731b7a3 100644 --- a/doc/check-lte-firmware-upgrade.md +++ b/doc/check-lte-firmware-upgrade.md @@ -26,7 +26,7 @@ upgrades. Currently supported LTE hardware: ### Sample notification -![check-lte-firmware-upgrade notification](check-lte-firmware-upgrade.d/notification.avif) +![notification: check-lte-firmware-upgrade](check-lte-firmware-upgrade.d/notification.avif) Requirements and installation ----------------------------- diff --git a/doc/check-perpetual-license.md b/doc/check-perpetual-license.md index de91eeb5..155f56f6 100644 --- a/doc/check-perpetual-license.md +++ b/doc/check-perpetual-license.md @@ -22,8 +22,8 @@ and sends a notification to warn before expiration. ### Sample notifications -![check-perpetual-license notification warn](check-perpetual-license.d/notification-01-warn.avif) -![check-perpetual-license notification renew](check-perpetual-license.d/notification-02-renew.avif) +![notification: check-perpetual-license warn](check-perpetual-license.d/notification-01-warn.avif) +![notification: check-perpetual-license renew](check-perpetual-license.d/notification-02-renew.avif) Requirements and installation ----------------------------- diff --git a/doc/check-routeros-update.md b/doc/check-routeros-update.md index 18ad444a..120c9b91 100644 --- a/doc/check-routeros-update.md +++ b/doc/check-routeros-update.md @@ -37,8 +37,8 @@ automatically is supported. ### Sample notifications -![check-routeros-update notification found](check-routeros-update.d/notification-01-found.avif) -![check-routeros-update notification neighbor](check-routeros-update.d/notification-02-neighbor.avif) +![notification: check-routeros-update found](check-routeros-update.d/notification-01-found.avif) +![notification: check-routeros-update neighbor](check-routeros-update.d/notification-02-neighbor.avif) Requirements and installation ----------------------------- @@ -88,7 +88,7 @@ Be notified when run from scheduler or run it manually: If an update is found you can install it right away. -![Terminal](check-routeros-update.d/terminal.avif) +![screenshot: terminal](check-routeros-update.d/terminal.avif) Installing script [packages-update](packages-update.md) gives extra options. diff --git a/doc/collect-wireless-mac.md b/doc/collect-wireless-mac.md index 96b314e1..dbf24c02 100644 --- a/doc/collect-wireless-mac.md +++ b/doc/collect-wireless-mac.md @@ -24,7 +24,7 @@ and modify it to your needs. ### Sample notification -![collect-wireless-mac notification](collect-wireless-mac.d/notification.avif) +![notification: collect-wireless-mac](collect-wireless-mac.d/notification.avif) Requirements and installation ----------------------------- diff --git a/doc/daily-psk.md b/doc/daily-psk.md index 7ddb4d98..de3b5092 100644 --- a/doc/daily-psk.md +++ b/doc/daily-psk.md @@ -21,7 +21,7 @@ passphrase to a pseudo-random string daily. ### Sample notification -![daily-psk notification](daily-psk.d/notification.avif) +![notification: daily-psk](daily-psk.d/notification.avif) Requirements and installation ----------------------------- diff --git a/doc/log-forward.md b/doc/log-forward.md index 7bee120f..8dc3e192 100644 --- a/doc/log-forward.md +++ b/doc/log-forward.md @@ -37,8 +37,8 @@ log messages and forwards them via notification. ### Sample notifications -![log-forward notification info](log-forward.d/notification-01-info.avif) -![log-forward notification warn](log-forward.d/notification-02-warn.avif) +![notification: log-forward info](log-forward.d/notification-01-info.avif) +![notification: log-forward warn](log-forward.d/notification-02-warn.avif) Requirements and installation ----------------------------- diff --git a/doc/mod/inspectvar.md b/doc/mod/inspectvar.md index 28032651..526f51e1 100644 --- a/doc/mod/inspectvar.md +++ b/doc/mod/inspectvar.md @@ -33,7 +33,7 @@ Call the function `$InspectVar` with a variable as parameter: $InspectVar $ModeButton; -![InspectVar](inspectvar.d/01-inspectvar.avif) +![screenshot: InspectVar](inspectvar.d/01-inspectvar.avif) --- [⬅️ Go back to main README](../../README.md) diff --git a/doc/mod/ipcalc.md b/doc/mod/ipcalc.md index c393ec3a..552860be 100644 --- a/doc/mod/ipcalc.md +++ b/doc/mod/ipcalc.md @@ -43,7 +43,7 @@ It expects an IP address in CIDR notation as argument. $IPCalc 192.168.88.1/24; -![IPCalc](ipcalc.d/01-ipcalc.avif) +![screenshot: IPCalc](ipcalc.d/01-ipcalc.avif) ### IPCalcReturn @@ -53,7 +53,7 @@ the information in a named array. :put ([ $IPCalcReturn 192.168.88.1/24 ]->"broadcast"); -![IPCalcReturn](ipcalc.d/02-ipcalcreturn.avif) +![screenshot: IPCalcReturn](ipcalc.d/02-ipcalcreturn.avif) --- [⬅️ Go back to main README](../../README.md) diff --git a/doc/mod/notification-gotify.md b/doc/mod/notification-gotify.md index 7482ba72..45776286 100644 --- a/doc/mod/notification-gotify.md +++ b/doc/mod/notification-gotify.md @@ -38,7 +38,7 @@ and the [First Login ↗️](https://gotify.net/docs/first-login) setup. Once you have a user and account you can start creating apps. Each app is an independent notification feed for a device or application. -![Create new app](notification-gotify.d/appsetup.avif) +![screenshot: Create new app](notification-gotify.d/appsetup.avif) On creation apps are assigned a *Token* for authentification, you will need that in configuration. diff --git a/doc/mod/notification-matrix.md b/doc/mod/notification-matrix.md index 60001416..f9cd4ddf 100644 --- a/doc/mod/notification-matrix.md +++ b/doc/mod/notification-matrix.md @@ -74,7 +74,7 @@ and write first part of the configuration: $SetupMatrixAuthenticate "@example:matrix.org" "v3ry-s3cr3t"; -![authenticate](notification-matrix.d/01-authenticate.avif) +![screenshot: authenticate](notification-matrix.d/01-authenticate.avif) The configuration is written to a new configuration snippet `global-config-overlay.d/mod/notification-matrix`. @@ -94,7 +94,7 @@ the invite. $SetupMatrixJoinRoom "!WUcxpSjKyxSGelouhA:matrix.org"; -![join room](notification-matrix.d/02-join-room.avif) +![screenshot: join room](notification-matrix.d/02-join-room.avif) The configuration is appended to the configuration snippet `global-config-overlay.d/mod/notification-matrix`. diff --git a/doc/mod/notification-telegram.md b/doc/mod/notification-telegram.md index 1d2cec8c..8d485801 100644 --- a/doc/mod/notification-telegram.md +++ b/doc/mod/notification-telegram.md @@ -36,7 +36,7 @@ Configuration Open Telegram, then start a chat with [BotFather ↗️](https://t.me/BotFather) and create your own bot: -![create new bot](notification-telegram.d/01-newbot.avif) +![screenshot: create new bot](notification-telegram.d/01-newbot.avif) Set that token from *BotFather* (use your own!) to `TelegramTokenId`, for now just temporarily: @@ -49,7 +49,7 @@ then send your first message. Any text will do. On your device run $GetTelegramChatId; -![get chat id](notification-telegram.d/02-getchatid.avif) +![screenshot: get chat id](notification-telegram.d/02-getchatid.avif) Finally edit `global-config-overlay`, add `TelegramTokenId` with the token from *BotFather* and `TelegramChatId` with your retrieved chat id. Then @@ -104,7 +104,7 @@ Tips & Tricks 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. -![set profile photo](notification-telegram.d/03-setuserpic.avif) +![screenshot: set profile photo](notification-telegram.d/03-setuserpic.avif) Have a look at my [Logo Color Changer](../../contrib/logo-color.html) to create a colored version of this scripts' logo. diff --git a/doc/mod/scriptrunonce.md b/doc/mod/scriptrunonce.md index e960d767..69c6964b 100644 --- a/doc/mod/scriptrunonce.md +++ b/doc/mod/scriptrunonce.md @@ -50,7 +50,7 @@ The function `$ScriptRunOnce` expects an URL (or name if $ScriptRunOnce https://rsc.eworm.de/main/doc/mod/scriptrunonce.d/hello-world.rsc; -![ScriptRunOnce](scriptrunonce.d/01-scriptrunonce.avif) +![screenshot: ScriptRunOnce](scriptrunonce.d/01-scriptrunonce.avif) Giving multiple scripts is possible, separated by comma. diff --git a/doc/netwatch-notify.md b/doc/netwatch-notify.md index 70d6fe03..c1f5a04b 100644 --- a/doc/netwatch-notify.md +++ b/doc/netwatch-notify.md @@ -24,8 +24,8 @@ optional parent host is not down to avoid false alerts. ### Sample notifications -![netwatch-notify notification down](netwatch-notify.d/notification-01-down.avif) -![netwatch-notify notification up](netwatch-notify.d/notification-02-up.avif) +![notification: netwatch-notify down](netwatch-notify.d/notification-01-down.avif) +![notification: netwatch-notify up](netwatch-notify.d/notification-02-up.avif) Requirements and installation ----------------------------- diff --git a/doc/sms-forward.md b/doc/sms-forward.md index 5f038926..75e171ab 100644 --- a/doc/sms-forward.md +++ b/doc/sms-forward.md @@ -22,7 +22,7 @@ A broadband interface with SMS support is required. ### Sample notification -![sms-forward notification](sms-forward.d/notification.avif) +![notification: sms-forward](sms-forward.d/notification.avif) Requirements and installation ----------------------------- diff --git a/doc/telegram-chat.md b/doc/telegram-chat.md index 51cd3d6a..8988db2f 100644 --- a/doc/telegram-chat.md +++ b/doc/telegram-chat.md @@ -61,13 +61,13 @@ containing `! identity` (exclamation mark, optional space and system's identity). To query all dynamic ip addresses form a device named "*MikroTik*" send `! MikroTik`, followed by `/ip/address/print where dynamic;`. -![chat to specific device](telegram-chat.d/01-chat-specific.avif) +![screenshot: chat to specific device](telegram-chat.d/01-chat-specific.avif) Devices can be grouped to chat with them simultaneously. The default group "*all*" can be activated by sending `! @all`, which will make all devices act on your commands. -![chat to all devices](telegram-chat.d/02-chat-all.avif) +![screenshot: chat to all devices](telegram-chat.d/02-chat-all.avif) Send a single exclamation mark or non-existent identity to make all devices passive again. @@ -78,7 +78,7 @@ Let's assume you received a message from a device before, and want to send a command to that device. No need to activate it, you can just reply to that message. -![reply to message](telegram-chat.d/03-reply.avif) +![screenshot: reply to message](telegram-chat.d/03-reply.avif) Associated messages are cleared on device reboot. diff --git a/general/style.css b/general/style.css index c3e86901..f561766f 100644 --- a/general/style.css +++ b/general/style.css @@ -42,6 +42,12 @@ div.content { hr { clear: both; } +img.notification { + box-shadow: 3px 3px 7px rgba(100,100,100,0.7); +} +img.screenshot { + box-shadow: 3px 3px 7px rgba(100,100,100,0.7); +} img.logo { float: left; /* border-radius: 50%; */ @@ -66,6 +72,7 @@ pre { pre.code { background-color: #f8f8f8; border: 1px solid #ccc; + box-shadow: 3px 3px 7px rgba(100,100,100,0.7); overflow: auto; padding: 6px 10px; border-radius: 3px;