diff options
Diffstat (limited to '')
| -rw-r--r-- | doc/02-Installation.md | 20 | ||||
| -rw-r--r-- | doc/02-Installation.md.d/From-Source.md | 10 |
2 files changed, 30 insertions, 0 deletions
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" %} --> |