summaryrefslogtreecommitdiffstats
path: root/doc/03-Configuration.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 12:44:03 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 12:44:03 +0000
commite865f590071a1dab0734ccd7f3ab8f003cfb4cde (patch)
tree367fc1ef06004119d3941460a22c4f83b1ca4d7d /doc/03-Configuration.md
parentInitial commit. (diff)
downloadicingaweb2-module-generictts-upstream.tar.xz
icingaweb2-module-generictts-upstream.zip
Adding upstream version 2.1.0.upstream/2.1.0upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/03-Configuration.md')
-rw-r--r--doc/03-Configuration.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/doc/03-Configuration.md b/doc/03-Configuration.md
new file mode 100644
index 0000000..84e915c
--- /dev/null
+++ b/doc/03-Configuration.md
@@ -0,0 +1,25 @@
+# Configuration
+
+After enabling `generictts`,
+you can access its configuration in Icinga Web via the module's configuration tab.
+But you can also change its configuration manually.
+`generictts` maintains a configuration file that is normally located under the following path:
+
+```
+/etc/icingaweb2/modules/generictts/config.ini
+```
+
+## Example Configuration
+
+You need to understand regular expressions for the configuration.
+A pattern has to be specified that captures a ticket reference for use in a link to your ticket system.
+
+In the following example, every time we encounter an acknowledgement, downtime, or comment
+that contains a hash `#` followed by digits, that number is stored in the capturing group `$1`
+and replaced with a link that references that specific ticket in your ticket system.
+
+```ini
+[my-ticket-system]
+pattern = "/#([0-9]+)/"
+url = "https://my.ticket.system/tickets/id=$1"
+```