aboutsummaryrefslogtreecommitdiffstats
path: root/doc/log-forward.md
diff options
context:
space:
mode:
authorGravatar Christian Hesse <mail@eworm.de>2020-07-15 12:22:55 +0200
committerGravatar Christian Hesse <mail@eworm.de>2020-07-15 12:41:29 +0200
commit6bce0a4b6a3d1ee48a1e4b4f40652ae490fb288c (patch)
tree5cff4a2b93eb6d0d305cd8f824cf6d9d63c3c206 /doc/log-forward.md
parent9740b1f26993bafe09834e19a0275036e2f5c22a (diff)
add 'log-forward', drop 'early-errors'change-23
Diffstat (limited to 'doc/log-forward.md')
-rw-r--r--doc/log-forward.md42
1 files changed, 42 insertions, 0 deletions
diff --git a/doc/log-forward.md b/doc/log-forward.md
new file mode 100644
index 0000000..bc7213a
--- /dev/null
+++ b/doc/log-forward.md
@@ -0,0 +1,42 @@
+Forward log messages via notification
+=====================================
+
+[◀ Go back to main README](../README.md)
+
+Description
+-----------
+
+RouterOS supports sending log messages via e-mail or to a syslog server.
+This has some limitation, however:
+
+* does not work early after boot if network connectivity is not
+ yet established
+* lots of messages generate a flood of mails
+* Telegram is not supported
+
+The script is intended to be run periodically. It collects log messages
+and forwards them via notification.
+
+Requirements and installation
+-----------------------------
+
+Just install the script:
+
+ $ScriptInstallUpdate log-forward;
+
+... and add a scheduler:
+
+ / system scheduler add interval=1m name=log-forward on-event="/ system script run log-forward;" start-time=startup;
+
+Configuration
+-------------
+
+The configuration goes to `global-config-overlay`, there is just one parameters:
+
+* `LogForwardFilter`: define topics *not* to be forwarded
+
+Also notification settings are required for e-mail and telegram.
+
+---
+[◀ Go back to main README](../README.md)
+[▲ Go back to top](#top)