aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--doc/backup-cloud.md4
-rw-r--r--doc/backup-email.md4
-rw-r--r--doc/backup-upload.md4
-rw-r--r--doc/certificate-renew-issued.md4
-rw-r--r--doc/check-certificates.md4
-rw-r--r--doc/check-health.md4
-rw-r--r--doc/check-routeros-update.md5
-rw-r--r--doc/daily-psk.md4
-rw-r--r--doc/dhcp-to-dns.md4
-rw-r--r--doc/gps-track.md4
-rw-r--r--doc/ipsec-to-dns.md4
-rw-r--r--doc/log-forward.md4
-rw-r--r--doc/mod/notification-email.md4
-rw-r--r--doc/mod/notification-matrix.md4
-rw-r--r--doc/mod/notification-telegram.md4
-rw-r--r--doc/mod/scriptrunonce.md4
-rw-r--r--doc/mode-button.md4
-rw-r--r--doc/sms-action.md4
-rw-r--r--doc/sms-forward.md4
-rw-r--r--doc/telegram-chat.md4
20 files changed, 79 insertions, 2 deletions
diff --git a/doc/backup-cloud.md b/doc/backup-cloud.md
index 511fad3..b612fc4 100644
--- a/doc/backup-cloud.md
+++ b/doc/backup-cloud.md
@@ -36,6 +36,10 @@ 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
+> ℹ️ **Info**: Copy relevant configuration from
+> [`global-config`](../global-config.rsc) (the one without `-overlay`) to
+> your local `global-config-overlay` and modify it to your specific needs.
+
Also notification settings are required for
[e-mail](mod/notification-email.md),
[matrix](mod/notification-matrix.md) and/or
diff --git a/doc/backup-email.md b/doc/backup-email.md
index a8ec760..67564e7 100644
--- a/doc/backup-email.md
+++ b/doc/backup-email.md
@@ -33,6 +33,10 @@ 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
+> ℹ️ **Info**: Copy relevant configuration from
+> [`global-config`](../global-config.rsc) (the one without `-overlay`) to
+> your local `global-config-overlay` and modify it to your specific needs.
+
Usage and invocation
--------------------
diff --git a/doc/backup-upload.md b/doc/backup-upload.md
index f2bf4de..f9aaa29 100644
--- a/doc/backup-upload.md
+++ b/doc/backup-upload.md
@@ -42,6 +42,10 @@ The configuration goes to `global-config-overlay`, these are the parameters:
* `BackupUploadUser`: username for server authentication
* `BackupUploadPass`: password for server authentication
+> ℹ️ **Info**: Copy relevant configuration from
+> [`global-config`](../global-config.rsc) (the one without `-overlay`) to
+> your local `global-config-overlay` and modify it to your specific needs.
+
Also notification settings are required for
[e-mail](mod/notification-email.md),
[matrix](mod/notification-matrix.md) and/or
diff --git a/doc/certificate-renew-issued.md b/doc/certificate-renew-issued.md
index 72f7fc5..bb8e18c 100644
--- a/doc/certificate-renew-issued.md
+++ b/doc/certificate-renew-issued.md
@@ -28,6 +28,10 @@ parameter:
* `CertRenewPass`: an array holding individual passphrases for certificates
+> ℹ️ **Info**: Copy relevant configuration from
+> [`global-config`](../global-config.rsc) (the one without `-overlay`) to
+> your local `global-config-overlay` and modify it to your specific needs.
+
Usage and invocation
--------------------
diff --git a/doc/check-certificates.md b/doc/check-certificates.md
index 52f5e51..58151f3 100644
--- a/doc/check-certificates.md
+++ b/doc/check-certificates.md
@@ -34,6 +34,10 @@ in `global-config-overlay`, these are the parameters:
* `CertRenewUrl`: the url to download certificates from
* `CertWarnTime`: on what remaining time to warn via notification
+> ℹ️ **Info**: Copy relevant configuration from
+> [`global-config`](../global-config.rsc) (the one without `-overlay`) to
+> your local `global-config-overlay` and modify it to your specific needs.
+
Certificates on the web server should be named by their common name, like
`CN.pem` (`PEM` format) or`CN.p12` (`PKCS#12` format). Alternatively any
subject alternative name (aka *Subject Alt Name* or *SAN*) can be used.
diff --git a/doc/check-health.md b/doc/check-health.md
index f0e5c11..3f4c70f 100644
--- a/doc/check-health.md
+++ b/doc/check-health.md
@@ -74,6 +74,10 @@ 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
+> ℹ️ **Info**: Copy relevant configuration from
+> [`global-config`](../global-config.rsc) (the one without `-overlay`) to
+> your local `global-config-overlay` and modify it to your specific needs.
+
Also notification settings are required for
[e-mail](mod/notification-email.md),
[matrix](mod/notification-matrix.md) and/or
diff --git a/doc/check-routeros-update.md b/doc/check-routeros-update.md
index fefac5e..186fb86 100644
--- a/doc/check-routeros-update.md
+++ b/doc/check-routeros-update.md
@@ -58,8 +58,9 @@ The configuration goes to `global-config-overlay`, these are the parameters:
(`long-term`, `stable` or `testing`) is appended
* `SafeUpdateAll`: install **all** updates automatically
-> ℹ️ **Info**: Installing **all** updates automatically requires extra
-> confirmation. See `global-config` for details.
+> ℹ️ **Info**: Copy relevant configuration from
+> [`global-config`](../global-config.rsc) (the one without `-overlay`) to
+> your local `global-config-overlay` and modify it to your specific needs.
Also notification settings are required for
[e-mail](mod/notification-email.md),
diff --git a/doc/daily-psk.md b/doc/daily-psk.md
index 1510ab3..9a5e558 100644
--- a/doc/daily-psk.md
+++ b/doc/daily-psk.md
@@ -47,6 +47,10 @@ The configuration goes to `global-config-overlay`, these are the parameters:
* `DailyPskMatchComment`: pattern to match the wireless access list comment
* `DailyPskSecrets`: an array with pseudo random strings
+> ℹ️ **Info**: Copy relevant configuration from
+> [`global-config`](../global-config.rsc) (the one without `-overlay`) to
+> your local `global-config-overlay` and modify it to your specific needs.
+
Then add an access list entry. For CAPsMAN:
/caps-man/access-list/add comment="Daily PSK" ssid-regexp="-guest\$" private-passphrase="ToBeChangedDaily";
diff --git a/doc/dhcp-to-dns.md b/doc/dhcp-to-dns.md
index 0c443a0..772704e 100644
--- a/doc/dhcp-to-dns.md
+++ b/doc/dhcp-to-dns.md
@@ -56,6 +56,10 @@ If no domain is found in dhcp server's network definition a fallback from
* `Domain`: the domain used for dns records
+> ℹ️ **Info**: Copy relevant configuration from
+> [`global-config`](../global-config.rsc) (the one without `-overlay`) to
+> your local `global-config-overlay` and modify it to your specific needs.
+
### Host name from DHCP lease comment
Overwriting the host name from dhcp lease comment is supported, just add
diff --git a/doc/gps-track.md b/doc/gps-track.md
index f5d9901..721b075 100644
--- a/doc/gps-track.md
+++ b/doc/gps-track.md
@@ -32,6 +32,10 @@ The configuration goes to `global-config-overlay`, the only parameter is:
* `GpsTrackUrl`: the url to send json data to
+> ℹ️ **Info**: Copy relevant configuration from
+> [`global-config`](../global-config.rsc) (the one without `-overlay`) to
+> your local `global-config-overlay` and modify it to your specific needs.
+
The configured coordinate format (see `/system/gps`) defines the format
sent to the server.
diff --git a/doc/ipsec-to-dns.md b/doc/ipsec-to-dns.md
index 5825def..04500a3 100644
--- a/doc/ipsec-to-dns.md
+++ b/doc/ipsec-to-dns.md
@@ -36,6 +36,10 @@ The configuration goes to `global-config-overlay`, these are the parameters:
* `HostNameInZone`: whether or not to add the ipsec/dns server's hostname
* `PrefixInZone`: whether or not to add prefix `ipsec`
+> ℹ️ **Info**: Copy relevant configuration from
+> [`global-config`](../global-config.rsc) (the one without `-overlay`) to
+> your local `global-config-overlay` and modify it to your specific needs.
+
See also
--------
diff --git a/doc/log-forward.md b/doc/log-forward.md
index 6faa27e..43ae897 100644
--- a/doc/log-forward.md
+++ b/doc/log-forward.md
@@ -54,6 +54,10 @@ The configuration goes to `global-config-overlay`, these are the parameters:
* `LogForwardIncludeMessage`: define message text to be forwarded (even if
filter matches)
+> ℹ️ **Info**: Copy relevant configuration from
+> [`global-config`](../global-config.rsc) (the one without `-overlay`) to
+> your local `global-config-overlay` and modify it to your specific needs.
+
These patterns are matched as
[regular expressions](https://wiki.mikrotik.com/wiki/Manual:Regular_Expressions).
To forward **all** (ignoring severity) log messages with topics `account`
diff --git a/doc/mod/notification-email.md b/doc/mod/notification-email.md
index 2186777..e4ceda2 100644
--- a/doc/mod/notification-email.md
+++ b/doc/mod/notification-email.md
@@ -32,6 +32,10 @@ the ntp client.
Then edit `global-config-overlay`, add `EmailGeneralTo` with a valid
recipient address. Finally reload the configuration.
+> ℹ️ **Info**: Copy relevant configuration from
+> [`global-config`](../../global-config.rsc) (the one without `-overlay`) to
+> your local `global-config-overlay` and modify it to your specific needs.
+
### Sending to several recipients
Sending notifications to several recipients is possible as well. Add
diff --git a/doc/mod/notification-matrix.md b/doc/mod/notification-matrix.md
index 639fa98..070ed9f 100644
--- a/doc/mod/notification-matrix.md
+++ b/doc/mod/notification-matrix.md
@@ -31,6 +31,10 @@ Edit `global-config-overlay`, add `MatrixHomeServer`, `MatrixAccessToken` and
`MatrixRoom` - see below on hints how to retrieve this information. Then
reload the configuration.
+> ℹ️ **Info**: Copy relevant configuration from
+> [`global-config`](../../global-config.rsc) (the one without `-overlay`) to
+> your local `global-config-overlay` and modify it to your specific needs.
+
### Home server
Matrix user accounts are identified by a unique user id in the form of
diff --git a/doc/mod/notification-telegram.md b/doc/mod/notification-telegram.md
index 482285a..40e6fb1 100644
--- a/doc/mod/notification-telegram.md
+++ b/doc/mod/notification-telegram.md
@@ -41,6 +41,10 @@ Finally edit `global-config-overlay`, add `TelegramTokenId` with the token
from *BotFather* and `TelegramChatId` with your id from *GetIDs Bot*. Then
reload the configuration.
+> ℹ️ **Info**: Copy relevant configuration from
+> [`global-config`](../../global-config.rsc) (the one without `-overlay`) to
+> your local `global-config-overlay` and modify it to your specific needs.
+
### Notifications to a group
Sending notifications to a group is possible as well. Add your bot and the
diff --git a/doc/mod/scriptrunonce.md b/doc/mod/scriptrunonce.md
index 20760fb..895c20c 100644
--- a/doc/mod/scriptrunonce.md
+++ b/doc/mod/scriptrunonce.md
@@ -27,6 +27,10 @@ The optional configuration goes to `global-config-overlay`.
* `ScriptRunOnceBaseUrl`: base url, prepended to parameter
* `ScriptRunOnceUrlSuffix`: url suffix, appended to parameter
+> ℹ️ **Info**: Copy relevant configuration from
+> [`global-config`](../../global-config.rsc) (the one without `-overlay`) to
+> your local `global-config-overlay` and modify it to your specific needs.
+
If the parameter passed to the function is not a complete URL (starting
with protocol `ftp://`, `http://`, `https://` or `sftp://`) the base-url is
prepended, and file extension `.rsc` and url-suffix are appended.
diff --git a/doc/mode-button.md b/doc/mode-button.md
index 50b1722..6374b83 100644
--- a/doc/mode-button.md
+++ b/doc/mode-button.md
@@ -54,6 +54,10 @@ The configuration goes to `global-config-overlay`, these are the parameters:
* `ModeButton`: an array with defined actions
* `ModeButtonLED`: led to give visual feedback
+> ℹ️ **Info**: Copy relevant configuration from
+> [`global-config`](../global-config.rsc) (the one without `-overlay`) to
+> your local `global-config-overlay` and modify it to your specific needs.
+
Usage and invocation
--------------------
diff --git a/doc/sms-action.md b/doc/sms-action.md
index e72aa11..3391902 100644
--- a/doc/sms-action.md
+++ b/doc/sms-action.md
@@ -28,6 +28,10 @@ The configuration goes to `global-config-overlay`, this is the only parameter:
* `SmsAction`: an array with pre-defined actions
+> ℹ️ **Info**: Copy relevant configuration from
+> [`global-config`](../global-config.rsc) (the one without `-overlay`) to
+> your local `global-config-overlay` and modify it to your specific needs.
+
Then enable SMS actions:
/tool/sms/set allowed-number=+491234567890 receive-enabled=yes secret=s3cr3t;
diff --git a/doc/sms-forward.md b/doc/sms-forward.md
index bfab38d..74a08e6 100644
--- a/doc/sms-forward.md
+++ b/doc/sms-forward.md
@@ -44,6 +44,10 @@ The configuration goes to `global-config-overlay`, this is the only parameter:
(which is matched against the sending phone number or name) and `command`.
For `match` and `allowed-number` regular expressions are supported.
+> ℹ️ **Info**: Copy relevant configuration from
+> [`global-config`](../global-config.rsc) (the one without `-overlay`) to
+> your local `global-config-overlay` and modify it to your specific needs.
+
Notification settings are required for
[e-mail](mod/notification-email.md),
[matrix](mod/notification-matrix.md) and/or
diff --git a/doc/telegram-chat.md b/doc/telegram-chat.md
index c3ef7fc..391042d 100644
--- a/doc/telegram-chat.md
+++ b/doc/telegram-chat.md
@@ -39,6 +39,10 @@ parameters:
* `TelegramChatIdsTrusted`: an array with trusted chat ids or user names
* `TelegramChatGroups`: define the groups a device should belong to
+> ℹ️ **Info**: Copy relevant configuration from
+> [`global-config`](../global-config.rsc) (the one without `-overlay`) to
+> your local `global-config-overlay` and modify it to your specific needs.
+
Usage and invocation
--------------------