diff --git a/doc/check-certificates.md b/doc/check-certificates.md index aa4a258..9059034 100644 --- a/doc/check-certificates.md +++ b/doc/check-certificates.md @@ -12,6 +12,10 @@ Description This script tries to download and renew certificates, then notifies about certificates that are still about to expire. +### Sample notification + +![check-certificates notification](notifications/check-certificates.svg) + Requirements and installation ----------------------------- diff --git a/doc/check-health.md b/doc/check-health.md index 39ce3d1..7accc62 100644 --- a/doc/check-health.md +++ b/doc/check-health.md @@ -23,6 +23,22 @@ hardware supports: / system health print; +### Sample notifications + +#### Voltage + +![check-health notification voltage](notifications/check-health-voltage.svg) + +#### Temperature + +![check-health notification](notifications/check-health-temperature-high.svg) +![check-health notification](notifications/check-health-temperature-ok.svg) + +#### PSU state + +![check-health notification](notifications/check-health-psu-fail.svg) +![check-health notification](notifications/check-health-psu-ok.svg) + Requirements and installation ----------------------------- diff --git a/doc/check-lte-firmware-upgrade.md b/doc/check-lte-firmware-upgrade.md index dea6b82..55d5cf8 100644 --- a/doc/check-lte-firmware-upgrade.md +++ b/doc/check-lte-firmware-upgrade.md @@ -17,6 +17,10 @@ upgrades. Currently supported LTE hardware: * R11e-4G * R11e-LTE6 +### Sample notification + +![check-lte-firmware-upgrade notification](notifications/check-lte-firmware-upgrade.svg) + Requirements and installation ----------------------------- diff --git a/doc/check-routeros-update.md b/doc/check-routeros-update.md index 416ba98..92ff1b1 100644 --- a/doc/check-routeros-update.md +++ b/doc/check-routeros-update.md @@ -19,6 +19,10 @@ specifying versions safe to be updated on a web server. Also installing patch updates (where just last digit is increased) automatically is supported. +### Sample notification + +![check-routeros-update notification](notifications/check-routeros-update.svg) + Requirements and installation ----------------------------- diff --git a/doc/cloud-backup.md b/doc/cloud-backup.md index 21d287f..182dd01 100644 --- a/doc/cloud-backup.md +++ b/doc/cloud-backup.md @@ -11,6 +11,10 @@ Description This script uploads [binary backup to Mikrotik cloud](https://wiki.mikrotik.com/wiki/Manual:IP/Cloud#Backup). +### Sample notification + +![cloud-backup notification](notifications/cloud-backup.svg) + Requirements and installation ----------------------------- diff --git a/doc/collect-wireless-mac.md b/doc/collect-wireless-mac.md index 8f3ff6f..7d3c815 100644 --- a/doc/collect-wireless-mac.md +++ b/doc/collect-wireless-mac.md @@ -15,6 +15,10 @@ address list. In addition a notification is sent. By default the access list entry is disabled, but you can easily enable and modify it to your needs. +### Sample notification + +![collect-wireless-mac notification](notifications/collect-wireless-mac.svg) + Requirements and installation ----------------------------- diff --git a/doc/daily-psk.md b/doc/daily-psk.md index 28f9afc..1d41f76 100644 --- a/doc/daily-psk.md +++ b/doc/daily-psk.md @@ -12,6 +12,10 @@ Description This script is supposed to provide a wifi network which changes the passphrase to a pseudo-random string daily. +### Sample notification + +![daily-psk notification](notifications/daily-psk.svg) + Requirements and installation ----------------------------- diff --git a/doc/log-forward.md b/doc/log-forward.md index 8f1c3f0..cdcd479 100644 --- a/doc/log-forward.md +++ b/doc/log-forward.md @@ -20,6 +20,10 @@ This has some limitation, however: The script is intended to be run periodically. It collects log messages and forwards them via notification. +### Sample notification + +![log-forward notification](notifications/log-forward.svg) + Requirements and installation ----------------------------- diff --git a/doc/netwatch-notify.md b/doc/netwatch-notify.md index 2bba8d9..52e4792 100644 --- a/doc/netwatch-notify.md +++ b/doc/netwatch-notify.md @@ -15,6 +15,11 @@ this script implements a simple state machine and dependency model. Host down events are triggered only if the host is down for several checks and optional parent host is not down to avoid false alerts. +### Sample notifications + +![netwatch-notify notification down](notifications/netwatch-notify-down.svg) +![netwatch-notify notification up](notifications/netwatch-notify-up.svg) + Requirements and installation ----------------------------- diff --git a/doc/notifications/check-certificates.svg b/doc/notifications/check-certificates.svg new file mode 100644 index 0000000..521db39 --- /dev/null +++ b/doc/notifications/check-certificates.svg @@ -0,0 +1,196 @@ + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + [MikroTik] 🔏 Certificate renewed + +A certificate on MikroTik has been renewed. + +Name: example.com +CommonName: example.com +Private key: available +Fingerprint: cc54cdd01fcd7698ecb71213874be776906eb33d26cd57754d168632f14c4c8b +Issuer: R3 +Validity: may/22/2021 22:29:34 to aug/20/2021 22:29:34 +Expires in: 11w 5d 08:18:06 + + diff --git a/doc/notifications/check-health-psu-fail.svg b/doc/notifications/check-health-psu-fail.svg new file mode 100644 index 0000000..0ca57a4 --- /dev/null +++ b/doc/notifications/check-health-psu-fail.svg @@ -0,0 +1,164 @@ + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + [MikroTik] ❌ Health warning: psu1-state + +The power supply unit 'psu1-state' on MikroTik failed! + + diff --git a/doc/notifications/check-health-psu-ok.svg b/doc/notifications/check-health-psu-ok.svg new file mode 100644 index 0000000..06f596b --- /dev/null +++ b/doc/notifications/check-health-psu-ok.svg @@ -0,0 +1,164 @@ + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + [MikroTik] ✅ Health recovery: psu1-state + +The power supply unit 'psu1-state' on MikroTik recovered! + + diff --git a/doc/notifications/check-health-temperature-high.svg b/doc/notifications/check-health-temperature-high.svg new file mode 100644 index 0000000..84c4256 --- /dev/null +++ b/doc/notifications/check-health-temperature-high.svg @@ -0,0 +1,164 @@ + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + [MikroTik] 🔥 Health warning: temperature + +The temperature on MikroTik is above threshold: 51°C + + diff --git a/doc/notifications/check-health-temperature-ok.svg b/doc/notifications/check-health-temperature-ok.svg new file mode 100644 index 0000000..d57ab4e --- /dev/null +++ b/doc/notifications/check-health-temperature-ok.svg @@ -0,0 +1,164 @@ + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + [MikroTik] ✅ Health recovery: temperature + +The temperature on MikroTik dropped below threshold: 48°C + + diff --git a/doc/notifications/check-health-voltage.svg b/doc/notifications/check-health-voltage.svg new file mode 100644 index 0000000..adc0328 --- /dev/null +++ b/doc/notifications/check-health-voltage.svg @@ -0,0 +1,176 @@ + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + [MikroTik] ⚡ Health warning: voltage + +The voltage on MikroTik jumped more than 10%. + +old value: 16.2V +new value: 12.4V + + diff --git a/doc/notifications/check-lte-firmware-upgrade.svg b/doc/notifications/check-lte-firmware-upgrade.svg new file mode 100644 index 0000000..01d3d44 --- /dev/null +++ b/doc/notifications/check-lte-firmware-upgrade.svg @@ -0,0 +1,184 @@ + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + [MikroTik] ✨ LTE firmware upgrade + +A new firmware version R11e-LTE6_V027 is available +for LTE interface lte on MikroTik. + +Interface: MikroTik R11e-LTE6 +Installed: R11e-LTE6_V025 +Available: R11e-LTE6_V027 + + diff --git a/doc/notifications/check-routeros-update.svg b/doc/notifications/check-routeros-update.svg new file mode 100644 index 0000000..9e049a4 --- /dev/null +++ b/doc/notifications/check-routeros-update.svg @@ -0,0 +1,235 @@ + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + [MikroTik] ✨ RouterOS update + +A new RouterOS version 6.48.3 is available for MikroTik. + +Hostname: MikroTik +Board name: CHR +Architecture: x86_64 +RouterOS: + Channel: stable + Installed: 6.48.2 + Available: 6.48.3 +RouterOS-Scripts: + Current: 55 + +🔗 https://mikrotik.com/download/changelogs/stable-release-tree + + + diff --git a/doc/notifications/cloud-backup.svg b/doc/notifications/cloud-backup.svg new file mode 100644 index 0000000..5a6e0c0 --- /dev/null +++ b/doc/notifications/cloud-backup.svg @@ -0,0 +1,216 @@ + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + [MikroTik] 💾☁ Cloud backup + +Uploaded backup for MikroTik to cloud. + +Hostname: MikroTik +Board name: CHR +Architecture: x86_64 +RouterOS: + Channel: stable + Installed: 6.48.3 +RouterOS-Scripts: + Current: 55 + +Name: cloud-20210614-092419 +Size: 370767 B (362 KiB) +Download key: LLDBfPcWXxmSetWilqeJX5V + + diff --git a/doc/notifications/collect-wireless-mac.svg b/doc/notifications/collect-wireless-mac.svg new file mode 100644 index 0000000..355fb8d --- /dev/null +++ b/doc/notifications/collect-wireless-mac.svg @@ -0,0 +1,208 @@ + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + [MikroTik] 📱 48:F1:7F:D0:E5:4E connected to Wifi + +A device with unknown MAC address connected to Wifi +on MikroTik. + +Controller: MikroTik +Interface: wl5-wifi +SSID: Wifi +MAC: 48:F1:7F:D0:E5:4E +Vendor: Intel Corporate +Hostname: host-523c8e0e +Address: 192.168.20.254 +DNS name: host-523c8e0e.dhcp.MikroTik.example.com +Date: jun/15/2021 09:21:56 + + diff --git a/doc/notifications/daily-psk.svg b/doc/notifications/daily-psk.svg new file mode 100644 index 0000000..824ce6b --- /dev/null +++ b/doc/notifications/daily-psk.svg @@ -0,0 +1,204 @@ + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + [MikroTik] 📅 daily PSK Guest-Wifi + +This is the daily PSK on MikroTik: + +SSID: Guest-Wifi +PSK: S3cr3tStr1ng +Date: jun/17/2021 + +A client device specific rule must not exist! + 🔗 https://www.eworm.de/cgi-bin/cqrlogo-wifi.cgi?scale=8&level=1&ssid=Guest-Wifi&pass=S3cr3tStr1ng + + diff --git a/doc/notifications/log-forward.svg b/doc/notifications/log-forward.svg new file mode 100644 index 0000000..7a4da2b --- /dev/null +++ b/doc/notifications/log-forward.svg @@ -0,0 +1,192 @@ + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + [MikroTik] ⚠ Log Forwarding + +The log on MikroTik contains these 3 messages after 6d23:55:18 uptime. + + ● 13:24:02 script;error cloud-backup: Failed uploading backup for MikroTik to cloud! + ● 13:24:17 system;info;account user admin logged in from 192.168.88.177 via ssh + ● 13:24:57 system;info;account user admin logged out from 192.168.88.177 via ssh + + diff --git a/doc/notifications/netwatch-notify-down.svg b/doc/notifications/netwatch-notify-down.svg new file mode 100644 index 0000000..320c837 --- /dev/null +++ b/doc/notifications/netwatch-notify-down.svg @@ -0,0 +1,168 @@ + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + [MikroTik] ❌ Netwatch Notify: example.com down + +Host example.com (93.184.216.34) is down since +jun/08/2021 06:55:03. + + diff --git a/doc/notifications/netwatch-notify-up.svg b/doc/notifications/netwatch-notify-up.svg new file mode 100644 index 0000000..9365b00 --- /dev/null +++ b/doc/notifications/netwatch-notify-up.svg @@ -0,0 +1,172 @@ + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + [MikroTik] ✅ Netwatch Notify: example.com up + +Host example.com (93.184.216.34) is up since +jun/08/2021 07:01:00. +It was down for 6 checks since jun/08/2021 06:55:03. + + diff --git a/doc/notifications/sms-forward.svg b/doc/notifications/sms-forward.svg new file mode 100644 index 0000000..76665cb --- /dev/null +++ b/doc/notifications/sms-forward.svg @@ -0,0 +1,176 @@ + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + [MikroTik] 📨 SMS Forwarding from 7277 + +Received this message by MikroTik from 7277: + +On Jun/12/2021 13:44:10 GMT -0 type class-0: +Welcome to our network! + + diff --git a/doc/notifications/upload-backup.svg b/doc/notifications/upload-backup.svg new file mode 100644 index 0000000..73d20a8 --- /dev/null +++ b/doc/notifications/upload-backup.svg @@ -0,0 +1,212 @@ + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + [MikroTik] 💾⬆ Backup & Config upload + +Backup and config export upload for MikroTik. + +Hostname: MikroTik +Board name: CHR +Architecture: x86_64 +RouterOS: + Channel: stable + Installed: 6.48.3 +RouterOS-Scripts: + Current: 55 + +Backup file: MikroTik_example_com.backup +Config file: MikroTik_example_com.rsc + + diff --git a/doc/sms-forward.md b/doc/sms-forward.md index 69ea5d0..9290b90 100644 --- a/doc/sms-forward.md +++ b/doc/sms-forward.md @@ -13,6 +13,10 @@ RouterOS can receive SMS. This script forwards SMS as notification. A broadband interface with SMS support is required. +### Sample notification + +![sms-forward notification](notifications/sms-forward.svg) + Requirements and installation ----------------------------- diff --git a/doc/upload-backup.md b/doc/upload-backup.md index f9a9b4f..f7d7c27 100644 --- a/doc/upload-backup.md +++ b/doc/upload-backup.md @@ -12,6 +12,10 @@ Description This script uploads binary backup (`/ system backup save`) and complete configuration export (`/ export terse`) to external server. +### Sample notification + +![upload-backup notification](notifications/upload-backup.svg) + Requirements and installation -----------------------------