mirror of
https://git.eworm.de/cgit/routeros-scripts
synced 2025-08-03 09:44:33 +02:00
introduce 'mod/notification-email', split off from global-functions
This commit is contained in:
Christian Hesse
parent
562c565fcf
commit
eccc187014
20 changed files with 240 additions and 151 deletions
|
|
@ -36,7 +36,8 @@ The configuration goes to `global-config-overlay`, these are the parameters:
|
|||
* `BackupPassword`: password to encrypt the backup with
|
||||
* `BackupRandomDelay`: delay up to amount of seconds when run from scheduler
|
||||
|
||||
Also notification settings are required for e-mail,
|
||||
Also notification settings are required for
|
||||
[e-mail](mod/notification-email.md),
|
||||
[matrix](mod/notification-matrix.md) and/or
|
||||
[telegram](mod/notification-telegram.md).
|
||||
|
||||
|
|
|
|||
|
|
@ -15,9 +15,12 @@ configuration export (`/export terse show-sensitive`) via e-mail.
|
|||
Requirements and installation
|
||||
-----------------------------
|
||||
|
||||
Just install the script:
|
||||
Just install the script and the required module:
|
||||
|
||||
$ScriptInstallUpdate backup-email;
|
||||
$ScriptInstallUpdate mod/notification-email,backup-email;
|
||||
|
||||
Also make sure you configure
|
||||
[sending notifications via e-mail](mod/notification-email.md).
|
||||
|
||||
Configuration
|
||||
-------------
|
||||
|
|
@ -29,8 +32,6 @@ The configuration goes to `global-config-overlay`, these are the parameters:
|
|||
* `BackupPassword`: password to encrypt the backup with
|
||||
* `BackupRandomDelay`: delay up to amount of seconds when run from scheduler
|
||||
|
||||
Also valid e-mail settings are required to send mails.
|
||||
|
||||
Usage and invocation
|
||||
--------------------
|
||||
|
||||
|
|
@ -47,6 +48,7 @@ See also
|
|||
|
||||
* [Upload backup to Mikrotik cloud](backup-cloud.md)
|
||||
* [Save configuration to fallback partition](doc/backup-partition.md)
|
||||
* [Send notifications via e-mail](mod/notification-email.md)
|
||||
* [Upload backup to server](backup-upload.md)
|
||||
|
||||
---
|
||||
|
|
|
|||
|
|
@ -41,7 +41,8 @@ The configuration goes to `global-config-overlay`, these are the parameters:
|
|||
* `BackupUploadUser`: username for server authentication
|
||||
* `BackupUploadPass`: password for server authentication
|
||||
|
||||
Also notification settings are required for e-mail,
|
||||
Also notification settings are required for
|
||||
[e-mail](mod/notification-email.md),
|
||||
[matrix](mod/notification-matrix.md) and/or
|
||||
[telegram](mod/notification-telegram.md).
|
||||
|
||||
|
|
|
|||
|
|
@ -26,10 +26,6 @@ Just install the script:
|
|||
Configuration
|
||||
-------------
|
||||
|
||||
The expiry notifications just require notification settings for e-mail,
|
||||
[matrix](mod/notification-matrix.md) and/or
|
||||
[telegram](mod/notification-telegram.md).
|
||||
|
||||
For automatic download and renewal of certificates you need configuration
|
||||
in `global-config-overlay`, these are the parameters:
|
||||
|
||||
|
|
@ -39,6 +35,11 @@ in `global-config-overlay`, these are the parameters:
|
|||
Certificates on the web server should be named `CN.pem` (`PEM` format) or
|
||||
`CN.p12` (`PKCS#12` format).
|
||||
|
||||
Also notification settings are required for
|
||||
[e-mail](mod/notification-email.md),
|
||||
[matrix](mod/notification-matrix.md) and/or
|
||||
[telegram](mod/notification-telegram.md).
|
||||
|
||||
Usage and invocation
|
||||
--------------------
|
||||
|
||||
|
|
|
|||
|
|
@ -56,7 +56,8 @@ The configuration goes to `global-config-overlay`, these are the parameters:
|
|||
* `CheckHealthVoltageLow`: value (in volt*10) giving a hard lower limit
|
||||
* `CheckHealthVoltagePercent`: percentage value to trigger voltage jumps
|
||||
|
||||
Also notification settings are required for e-mail,
|
||||
Also notification settings are required for
|
||||
[e-mail](mod/notification-email.md),
|
||||
[matrix](mod/notification-matrix.md) and/or
|
||||
[telegram](mod/notification-telegram.md).
|
||||
|
||||
|
|
|
|||
|
|
@ -35,7 +35,8 @@ Just install the script:
|
|||
Configuration
|
||||
-------------
|
||||
|
||||
Notification setting are required for e-mail,
|
||||
Also notification settings are required for
|
||||
[e-mail](mod/notification-email.md),
|
||||
[matrix](mod/notification-matrix.md) and/or
|
||||
[telegram](mod/notification-telegram.md).
|
||||
|
||||
|
|
|
|||
|
|
@ -56,7 +56,8 @@ safe versions from a web server. The configuration goes to
|
|||
* `SafeUpdateUrl`: url to check for safe update, the channel (`long-term`,
|
||||
`stable` or `testing`) is appended
|
||||
|
||||
Also notification settings are required for e-mail,
|
||||
Also notification settings are required for
|
||||
[e-mail](mod/notification-email.md),
|
||||
[matrix](mod/notification-matrix.md) and/or
|
||||
[telegram](mod/notification-telegram.md).
|
||||
|
||||
|
|
|
|||
|
|
@ -40,7 +40,8 @@ On first run a disabled access list entry acting as marker (with comment
|
|||
"`--- collected above ---`") is added. Move this entry to define where new
|
||||
entries are to be added.
|
||||
|
||||
Also notification settings are required for e-mail,
|
||||
Also notification settings are required for
|
||||
[e-mail](mod/notification-email.md),
|
||||
[matrix](mod/notification-matrix.md) and/or
|
||||
[telegram](mod/notification-telegram.md).
|
||||
|
||||
|
|
|
|||
|
|
@ -51,7 +51,8 @@ Then add an access list entry:
|
|||
|
||||
/interface/wireless/access-list/add comment="Daily PSK" interface=wl-daily private-pre-shared-key="ToBeChangedDaily";
|
||||
|
||||
Also notification settings are required for e-mail,
|
||||
Also notification settings are required for
|
||||
[e-mail](mod/notification-email.md),
|
||||
[matrix](mod/notification-matrix.md) and/or
|
||||
[telegram](mod/notification-telegram.md).
|
||||
|
||||
|
|
|
|||
|
|
@ -46,7 +46,8 @@ The configuration goes to `global-config-overlay`, these are the parameters:
|
|||
* `LogForwardIncludeMessage`: define message text to be forwarded (even if
|
||||
filter matches)
|
||||
|
||||
Also notification settings are required for e-mail,
|
||||
Also notification settings are required for
|
||||
[e-mail](mod/notification-email.md),
|
||||
[matrix](mod/notification-matrix.md) and/or
|
||||
[telegram](mod/notification-telegram.md).
|
||||
|
||||
|
|
|
|||
63
doc/mod/notification-email.md
Normal file
63
doc/mod/notification-email.md
Normal file
|
|
@ -0,0 +1,63 @@
|
|||
Send notifications via e-mail
|
||||
=============================
|
||||
|
||||
[◀ Go back to main README](../../README.md)
|
||||
|
||||
> ℹ️️ **Info**: This module can not be used on its own but requires the base
|
||||
> installation. See [main README](../../README.md) for details.
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
This module adds support for sending notifications via e-mail. A queue is
|
||||
used to make sure notifications are not lost on failure but sent later.
|
||||
|
||||
Requirements and installation
|
||||
-----------------------------
|
||||
|
||||
Just install the module:
|
||||
|
||||
$ScriptInstallUpdate mod/notification-email;
|
||||
|
||||
Also you need a valid e-mail account with smtp login credentials.
|
||||
|
||||
Configuration
|
||||
-------------
|
||||
|
||||
Set up your device's
|
||||
[e-mail settings](https://wiki.mikrotik.com/wiki/Manual:Tools/email).
|
||||
|
||||
Then edit `global-config-overlay`, add `EmailGeneralTo` with a valid
|
||||
recipient address. Finally reload the configuration.
|
||||
|
||||
### Sending to several recipients
|
||||
|
||||
Sending notifications to several recipients is possible as well. Add
|
||||
`EmailGeneralCc` on top, which can have a single mail address or a comma
|
||||
separated list.
|
||||
|
||||
Usage and invocation
|
||||
--------------------
|
||||
|
||||
There's nothing special to do. Every script or function sending a notification
|
||||
will now send it to your e-mail account.
|
||||
|
||||
But of course you can send notifications directly or use a function in your
|
||||
own scripts. Give it a try:
|
||||
|
||||
$SendEMail "Subject..." "Body..."
|
||||
|
||||
Alternatively this sends a notification with all available and configured
|
||||
methods:
|
||||
|
||||
$SendNotification "Subject..." "Body..."
|
||||
|
||||
See also
|
||||
--------
|
||||
|
||||
* [Send notifications via Matrix](notification-matrix.md)
|
||||
* [Send notifications via Telegram](notification-telegram.md)
|
||||
|
||||
---
|
||||
[◀ Go back to main README](../../README.md)
|
||||
[▲ Go back to top](#top)
|
||||
|
|
@ -103,6 +103,7 @@ methods:
|
|||
See also
|
||||
--------
|
||||
|
||||
* [Send notifications via e-mail](notification-email.md)
|
||||
* [Send notifications via Telegram](notification-telegram.md)
|
||||
|
||||
---
|
||||
|
|
|
|||
|
|
@ -66,6 +66,7 @@ methods:
|
|||
See also
|
||||
--------
|
||||
|
||||
* [Send notifications via e-mail](notification-email.md)
|
||||
* [Send notifications via Matrix](notification-matrix.md)
|
||||
|
||||
---
|
||||
|
|
|
|||
|
|
@ -88,7 +88,8 @@ powered off, but accessibility is of interest.
|
|||
|
||||
Go and get your coffee ☕️ before sending the print job.
|
||||
|
||||
Also notification settings are required for e-mail,
|
||||
Also notification settings are required for
|
||||
[e-mail](mod/notification-email.md),
|
||||
[matrix](mod/notification-matrix.md) and/or
|
||||
[telegram](mod/notification-telegram.md).
|
||||
|
||||
|
|
|
|||
|
|
@ -31,10 +31,11 @@ Just install the script:
|
|||
Configuration
|
||||
-------------
|
||||
|
||||
Notification settings are required for e-mail,
|
||||
Notification settings are required for
|
||||
[e-mail](mod/notification-email.md),
|
||||
[matrix](mod/notification-matrix.md) and/or
|
||||
[telegram](mod/notification-telegram.md). Also you have to enable receiving
|
||||
of SMS:
|
||||
[telegram](mod/notification-telegram.md).
|
||||
Also you have to enable receiving of SMS:
|
||||
|
||||
/tool/sms/set receive-enabled=yes;
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue