Merge branch 'doc-copy-hint' into next

This commit is contained in:
Christian Hesse 2023-06-08 22:31:26 +02:00
commit a4354d762f
20 changed files with 79 additions and 2 deletions

View file

@ -36,6 +36,10 @@ The configuration goes to `global-config-overlay`, these are the parameters:
* `BackupPassword`: password to encrypt the backup with * `BackupPassword`: password to encrypt the backup with
* `BackupRandomDelay`: delay up to amount of seconds when run from scheduler * `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 Also notification settings are required for
[e-mail](mod/notification-email.md), [e-mail](mod/notification-email.md),
[matrix](mod/notification-matrix.md) and/or [matrix](mod/notification-matrix.md) and/or

View file

@ -33,6 +33,10 @@ The configuration goes to `global-config-overlay`, these are the parameters:
* `BackupPassword`: password to encrypt the backup with * `BackupPassword`: password to encrypt the backup with
* `BackupRandomDelay`: delay up to amount of seconds when run from scheduler * `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 Usage and invocation
-------------------- --------------------

View file

@ -42,6 +42,10 @@ The configuration goes to `global-config-overlay`, these are the parameters:
* `BackupUploadUser`: username for server authentication * `BackupUploadUser`: username for server authentication
* `BackupUploadPass`: password 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 Also notification settings are required for
[e-mail](mod/notification-email.md), [e-mail](mod/notification-email.md),
[matrix](mod/notification-matrix.md) and/or [matrix](mod/notification-matrix.md) and/or

View file

@ -28,6 +28,10 @@ parameter:
* `CertRenewPass`: an array holding individual passphrases for certificates * `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 Usage and invocation
-------------------- --------------------

View file

@ -34,6 +34,10 @@ in `global-config-overlay`, these are the parameters:
* `CertRenewUrl`: the url to download certificates from * `CertRenewUrl`: the url to download certificates from
* `CertWarnTime`: on what remaining time to warn via notification * `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 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 `CN.pem` (`PEM` format) or`CN.p12` (`PKCS#12` format). Alternatively any
subject alternative name (aka *Subject Alt Name* or *SAN*) can be used. subject alternative name (aka *Subject Alt Name* or *SAN*) can be used.

View file

@ -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 * `CheckHealthVoltageLow`: value (in volt*10) giving a hard lower limit
* `CheckHealthVoltagePercent`: percentage value to trigger voltage jumps * `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 Also notification settings are required for
[e-mail](mod/notification-email.md), [e-mail](mod/notification-email.md),
[matrix](mod/notification-matrix.md) and/or [matrix](mod/notification-matrix.md) and/or

View file

@ -58,8 +58,9 @@ The configuration goes to `global-config-overlay`, these are the parameters:
(`long-term`, `stable` or `testing`) is appended (`long-term`, `stable` or `testing`) is appended
* `SafeUpdateAll`: install **all** updates automatically * `SafeUpdateAll`: install **all** updates automatically
> **Info**: Installing **all** updates automatically requires extra > **Info**: Copy relevant configuration from
> confirmation. See `global-config` for details. > [`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 Also notification settings are required for
[e-mail](mod/notification-email.md), [e-mail](mod/notification-email.md),

View file

@ -47,6 +47,10 @@ The configuration goes to `global-config-overlay`, these are the parameters:
* `DailyPskMatchComment`: pattern to match the wireless access list comment * `DailyPskMatchComment`: pattern to match the wireless access list comment
* `DailyPskSecrets`: an array with pseudo random strings * `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: Then add an access list entry. For CAPsMAN:
/caps-man/access-list/add comment="Daily PSK" ssid-regexp="-guest\$" private-passphrase="ToBeChangedDaily"; /caps-man/access-list/add comment="Daily PSK" ssid-regexp="-guest\$" private-passphrase="ToBeChangedDaily";

View file

@ -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 * `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 ### Host name from DHCP lease comment
Overwriting the host name from dhcp lease comment is supported, just add Overwriting the host name from dhcp lease comment is supported, just add

View file

@ -32,6 +32,10 @@ The configuration goes to `global-config-overlay`, the only parameter is:
* `GpsTrackUrl`: the url to send json data to * `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 The configured coordinate format (see `/system/gps`) defines the format
sent to the server. sent to the server.

View file

@ -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 * `HostNameInZone`: whether or not to add the ipsec/dns server's hostname
* `PrefixInZone`: whether or not to add prefix `ipsec` * `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 See also
-------- --------

View file

@ -54,6 +54,10 @@ The configuration goes to `global-config-overlay`, these are the parameters:
* `LogForwardIncludeMessage`: define message text to be forwarded (even if * `LogForwardIncludeMessage`: define message text to be forwarded (even if
filter matches) 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 These patterns are matched as
[regular expressions](https://wiki.mikrotik.com/wiki/Manual:Regular_Expressions). [regular expressions](https://wiki.mikrotik.com/wiki/Manual:Regular_Expressions).
To forward **all** (ignoring severity) log messages with topics `account` To forward **all** (ignoring severity) log messages with topics `account`

View file

@ -32,6 +32,10 @@ the ntp client.
Then edit `global-config-overlay`, add `EmailGeneralTo` with a valid Then edit `global-config-overlay`, add `EmailGeneralTo` with a valid
recipient address. Finally reload the configuration. 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 to several recipients
Sending notifications to several recipients is possible as well. Add Sending notifications to several recipients is possible as well. Add

View file

@ -31,6 +31,10 @@ Edit `global-config-overlay`, add `MatrixHomeServer`, `MatrixAccessToken` and
`MatrixRoom` - see below on hints how to retrieve this information. Then `MatrixRoom` - see below on hints how to retrieve this information. Then
reload the configuration. 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 ### Home server
Matrix user accounts are identified by a unique user id in the form of Matrix user accounts are identified by a unique user id in the form of

View file

@ -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 from *BotFather* and `TelegramChatId` with your id from *GetIDs Bot*. Then
reload the configuration. 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 ### Notifications to a group
Sending notifications to a group is possible as well. Add your bot and the Sending notifications to a group is possible as well. Add your bot and the

View file

@ -27,6 +27,10 @@ The optional configuration goes to `global-config-overlay`.
* `ScriptRunOnceBaseUrl`: base url, prepended to parameter * `ScriptRunOnceBaseUrl`: base url, prepended to parameter
* `ScriptRunOnceUrlSuffix`: url suffix, appended 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 If the parameter passed to the function is not a complete URL (starting
with protocol `ftp://`, `http://`, `https://` or `sftp://`) the base-url is with protocol `ftp://`, `http://`, `https://` or `sftp://`) the base-url is
prepended, and file extension `.rsc` and url-suffix are appended. prepended, and file extension `.rsc` and url-suffix are appended.

View file

@ -54,6 +54,10 @@ The configuration goes to `global-config-overlay`, these are the parameters:
* `ModeButton`: an array with defined actions * `ModeButton`: an array with defined actions
* `ModeButtonLED`: led to give visual feedback * `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 Usage and invocation
-------------------- --------------------

View file

@ -28,6 +28,10 @@ The configuration goes to `global-config-overlay`, this is the only parameter:
* `SmsAction`: an array with pre-defined actions * `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: Then enable SMS actions:
/tool/sms/set allowed-number=+491234567890 receive-enabled=yes secret=s3cr3t; /tool/sms/set allowed-number=+491234567890 receive-enabled=yes secret=s3cr3t;

View file

@ -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`. (which is matched against the sending phone number or name) and `command`.
For `match` and `allowed-number` regular expressions are supported. 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 Notification settings are required for
[e-mail](mod/notification-email.md), [e-mail](mod/notification-email.md),
[matrix](mod/notification-matrix.md) and/or [matrix](mod/notification-matrix.md) and/or

View file

@ -39,6 +39,10 @@ parameters:
* `TelegramChatIdsTrusted`: an array with trusted chat ids or user names * `TelegramChatIdsTrusted`: an array with trusted chat ids or user names
* `TelegramChatGroups`: define the groups a device should belong to * `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 Usage and invocation
-------------------- --------------------