From 5f28e928a1748450907bef4adbd686a42ea6838d Mon Sep 17 00:00:00 2001 From: Christian Hesse Date: Wed, 7 Jun 2023 14:11:06 +0200 Subject: doc/backup-cloud: hint to copy from global-config --- doc/backup-cloud.md | 4 ++++ 1 file changed, 4 insertions(+) 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 -- cgit v1.2.3-54-g00ecf From 083fa82b13ac955f12fdfe05cd2817777e4c6ad9 Mon Sep 17 00:00:00 2001 From: Christian Hesse Date: Wed, 7 Jun 2023 14:11:15 +0200 Subject: doc/backup-email: hint to copy from global-config --- doc/backup-email.md | 4 ++++ 1 file changed, 4 insertions(+) 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 -------------------- -- cgit v1.2.3-54-g00ecf From a65ea3fc2675dc5f4376709d51b26a625edbe5f0 Mon Sep 17 00:00:00 2001 From: Christian Hesse Date: Wed, 7 Jun 2023 14:11:25 +0200 Subject: doc/backup-upload: hint to copy from global-config --- doc/backup-upload.md | 4 ++++ 1 file changed, 4 insertions(+) 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 -- cgit v1.2.3-54-g00ecf From e96b2e485344d3447367a31400de0dd856759861 Mon Sep 17 00:00:00 2001 From: Christian Hesse Date: Wed, 7 Jun 2023 14:11:40 +0200 Subject: doc/certificate-renew-issued: hint to copy from global-config --- doc/certificate-renew-issued.md | 4 ++++ 1 file changed, 4 insertions(+) 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 -------------------- -- cgit v1.2.3-54-g00ecf From 2ba93f61ac5616325709855a5337eb8c53dc2a72 Mon Sep 17 00:00:00 2001 From: Christian Hesse Date: Wed, 7 Jun 2023 13:34:50 +0200 Subject: doc/check-certificates: hint to copy from global-config --- doc/check-certificates.md | 4 ++++ 1 file changed, 4 insertions(+) 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. -- cgit v1.2.3-54-g00ecf From d4e225f1b70d3f8fd3abb4872e019ffdc3666b3e Mon Sep 17 00:00:00 2001 From: Christian Hesse Date: Wed, 7 Jun 2023 14:12:01 +0200 Subject: doc/check-health: hint to copy from global-config --- doc/check-health.md | 4 ++++ 1 file changed, 4 insertions(+) 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 -- cgit v1.2.3-54-g00ecf From dea07a7f0b79bd3d15aee7db8c4bbe423a1bc93f Mon Sep 17 00:00:00 2001 From: Christian Hesse Date: Wed, 7 Jun 2023 14:12:12 +0200 Subject: doc/check-routeros-update: hint to copy from global-config --- doc/check-routeros-update.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) 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), -- cgit v1.2.3-54-g00ecf From 87318fddde2cbe4897467c502748bad33d081f69 Mon Sep 17 00:00:00 2001 From: Christian Hesse Date: Wed, 7 Jun 2023 14:12:36 +0200 Subject: doc/daily-psk: hint to copy from global-config --- doc/daily-psk.md | 4 ++++ 1 file changed, 4 insertions(+) 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"; -- cgit v1.2.3-54-g00ecf From a77e0bf0d5c80a7c85cec0aad26590abb71041e3 Mon Sep 17 00:00:00 2001 From: Christian Hesse Date: Wed, 7 Jun 2023 14:12:46 +0200 Subject: doc/dhcp-to-dns: hint to copy from global-config --- doc/dhcp-to-dns.md | 4 ++++ 1 file changed, 4 insertions(+) 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 -- cgit v1.2.3-54-g00ecf From 8fa04fec15735ca3edb9ed8e782b0a5109628001 Mon Sep 17 00:00:00 2001 From: Christian Hesse Date: Wed, 7 Jun 2023 14:12:57 +0200 Subject: doc/gps-track: hint to copy from global-config --- doc/gps-track.md | 4 ++++ 1 file changed, 4 insertions(+) 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. -- cgit v1.2.3-54-g00ecf From 4ab1a88a92316fcb759cd0a4fcb97589d4316491 Mon Sep 17 00:00:00 2001 From: Christian Hesse Date: Wed, 7 Jun 2023 14:13:13 +0200 Subject: doc/ipsec-to-dns: hint to copy from global-config --- doc/ipsec-to-dns.md | 4 ++++ 1 file changed, 4 insertions(+) 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 -------- -- cgit v1.2.3-54-g00ecf From 601404a5db29b7d2b25a1e8e8d27f65e909b6d1d Mon Sep 17 00:00:00 2001 From: Christian Hesse Date: Wed, 7 Jun 2023 14:13:25 +0200 Subject: doc/log-forward: hint to copy from global-config --- doc/log-forward.md | 4 ++++ 1 file changed, 4 insertions(+) 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` -- cgit v1.2.3-54-g00ecf From 3fafed250e2895003e50eae6b80a1df0c441dfa9 Mon Sep 17 00:00:00 2001 From: Christian Hesse Date: Wed, 7 Jun 2023 14:13:37 +0200 Subject: doc/mode-button: hint to copy from global-config --- doc/mode-button.md | 4 ++++ 1 file changed, 4 insertions(+) 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 -------------------- -- cgit v1.2.3-54-g00ecf From b93126bc469ca8c285e693246015a721d0d78a3a Mon Sep 17 00:00:00 2001 From: Christian Hesse Date: Wed, 7 Jun 2023 14:13:46 +0200 Subject: doc/sms-action: hint to copy from global-config --- doc/sms-action.md | 4 ++++ 1 file changed, 4 insertions(+) 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; -- cgit v1.2.3-54-g00ecf From 5c27024bc65dd47cf8d118bdf990be2e6ad584aa Mon Sep 17 00:00:00 2001 From: Christian Hesse Date: Wed, 7 Jun 2023 14:13:54 +0200 Subject: doc/sms-forward: hint to copy from global-config --- doc/sms-forward.md | 4 ++++ 1 file changed, 4 insertions(+) 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 -- cgit v1.2.3-54-g00ecf From c8497d05c5ae2ec3779000530eb937cd2a785cae Mon Sep 17 00:00:00 2001 From: Christian Hesse Date: Wed, 7 Jun 2023 14:14:04 +0200 Subject: doc/telegram-chat: hint to copy from global-config --- doc/telegram-chat.md | 4 ++++ 1 file changed, 4 insertions(+) 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 -------------------- -- cgit v1.2.3-54-g00ecf From a0dc721ea324b9e09ee0c5d57c75b73b17e9e8e9 Mon Sep 17 00:00:00 2001 From: Christian Hesse Date: Wed, 7 Jun 2023 14:15:44 +0200 Subject: doc/mod/scriptrunonce: hint to copy from global-config --- doc/mod/scriptrunonce.md | 4 ++++ 1 file changed, 4 insertions(+) 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. -- cgit v1.2.3-54-g00ecf From 9ac7cf5fc02789f97eb57659dbcdc511cad41c9d Mon Sep 17 00:00:00 2001 From: Christian Hesse Date: Wed, 7 Jun 2023 14:15:55 +0200 Subject: doc/mod/notification-email: hint to copy from global-config --- doc/mod/notification-email.md | 4 ++++ 1 file changed, 4 insertions(+) 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 -- cgit v1.2.3-54-g00ecf From 9ebebcfa52fdd781ca4b4bcc4bb8e1402ee3d771 Mon Sep 17 00:00:00 2001 From: Christian Hesse Date: Wed, 7 Jun 2023 14:16:08 +0200 Subject: doc/mod/notification-matrix: hint to copy from global-config --- doc/mod/notification-matrix.md | 4 ++++ 1 file changed, 4 insertions(+) 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 -- cgit v1.2.3-54-g00ecf From 9a1f2deb57d0af76d8118035de91e313dfbe32e1 Mon Sep 17 00:00:00 2001 From: Christian Hesse Date: Wed, 7 Jun 2023 14:16:19 +0200 Subject: doc/mod/notification-telegram: hint to copy from global-config --- doc/mod/notification-telegram.md | 4 ++++ 1 file changed, 4 insertions(+) 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 -- cgit v1.2.3-54-g00ecf