Adding upstream version 2.1.0.upstream/2.1.0upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

4 files changed, 70 insertions, 0 deletions

diff --git a/doc/01-About.md b/doc/01-About.md
new file mode 100644
index 0000000..6c47e80
--- /dev/null
+++ b/doc/01-About.md
@@ -0,0 +1,15 @@
+# Icinga Web GenericTTS Integration
+
+With the Icinga Web GenericTTS integration, you can replace ticket patterns in acknowledgements,
+downtimes, and comments with links to your trouble ticket systems.
+To do this, you configure one or more unique regular expressions to link to them.
+
+## Installation
+
+To install Icinga Web GenericTTS Integration see [Installation](02-Installation.md).
+
+## License
+
+Icinga Web GenericTTS Integration
+and the Icinga Web GenericTTS Integration documentation are licensed under the terms of the
+GNU General Public License Version 2.
diff --git a/doc/02-Installation.md b/doc/02-Installation.md
new file mode 100644
index 0000000..bf720e2
--- /dev/null
+++ b/doc/02-Installation.md
@@ -0,0 +1,20 @@
+<!-- {% if index %} -->
+# Installing Icinga Web GenericTTS Integration
+
+The recommended way to install Icinga Web GenericTTS Integration
+and its dependencies is to use prebuilt packages for
+all supported platforms from our official release repository.
+Please note that [Icinga Web](https://icinga.com/docs/icinga-web) is required to run Icinga Web GenericTTS Integration
+and if it is not already set up, it is best to do this first.
+
+The following steps will guide you through installing and setting up Icinga Web GenericTTS Integration.
+<!-- {% else %} -->
+<!-- {% if not icingaDocs %} -->
+
+## Installing the Package
+
+If the [repository](https://packages.icinga.com) is not configured yet, please add it first.
+Then use your distribution's package manager to install the `icinga-generictts` package
+or install [from source](02-Installation.md.d/From-Source.md).
+<!-- {% endif %} -->
+<!-- {% endif %} --><!-- {# end else if index #} -->
diff --git a/doc/02-Installation.md.d/From-Source.md b/doc/02-Installation.md.d/From-Source.md
new file mode 100644
index 0000000..9f38577
--- /dev/null
+++ b/doc/02-Installation.md.d/From-Source.md
@@ -0,0 +1,10 @@
+# Installing Icinga Web GenericTTS Integration from Source
+
+Please see the Icinga Web documentation on
+[how to install modules](https://icinga.com/docs/icinga-web-2/latest/doc/08-Modules/#installation) from source.
+Make sure you use `generictts` as the module name. The following requirements must also be met.
+
+## Requirements
+
+* [Icinga Web](https://icinga.com/docs/icinga-web/latest/)
+<!-- {% include "02-Installation.md" %} -->
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"
+```