aboutsummaryrefslogtreecommitdiffstats
path: root/doc/mod
diff options
context:
space:
mode:
authorGravatar Christian Hesse <mail@eworm.de>2023-06-08 22:31:26 +0200
committerGravatar Christian Hesse <mail@eworm.de>2023-06-11 22:45:30 +0200
commita4354d762f6b2fa8959124307a2eb841d5b00391 (patch)
tree4a2e6c4d7a8ada591de0e5cc3fca868ef81c46e3 /doc/mod
parent0b8588e6e812a270ac55bd82870e99a0fee01b07 (diff)
parent9a1f2deb57d0af76d8118035de91e313dfbe32e1 (diff)
Merge branch 'doc-copy-hint' into next
Diffstat (limited to 'doc/mod')
-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
4 files changed, 16 insertions, 0 deletions
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.