summaryrefslogtreecommitdiffstats
path: root/doc/02-Installation.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-14 13:21:16 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-14 13:21:16 +0000
commit2e582fe0b8b6a8e67982ddb84935db1bd3b401fe (patch)
treedd511b321f308264952cffb005a4288ea4e478e6 /doc/02-Installation.md
parentInitial commit. (diff)
downloadicingaweb2-module-graphite-2e582fe0b8b6a8e67982ddb84935db1bd3b401fe.tar.xz
icingaweb2-module-graphite-2e582fe0b8b6a8e67982ddb84935db1bd3b401fe.zip
Adding upstream version 1.2.2.upstream/1.2.2
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/02-Installation.md')
-rw-r--r--doc/02-Installation.md48
1 files changed, 48 insertions, 0 deletions
diff --git a/doc/02-Installation.md b/doc/02-Installation.md
new file mode 100644
index 0000000..6850ecd
--- /dev/null
+++ b/doc/02-Installation.md
@@ -0,0 +1,48 @@
+<!-- {% if index %} -->
+# Installing Icinga Web Graphite Integration
+
+It is recommended to use prebuilt packages
+for all supported platforms from our official release repository.
+Of course [Icinga Web](https://icinga.com/docs/icinga-web) itself
+is required to run its Graphite integration.
+The latter uses Graphite Web, so that is required as well.
+If they are not already set up, it is best to do this first.
+
+The following steps will guide you through installing
+and setting up Icinga Web Graphite 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-graphite` package
+or install [from source](02-Installation.md.d/From-Source.md).
+<!-- {% endif %} --><!-- {# end if not icingaDocs #} -->
+
+## Prepare Icinga 2
+
+Enable the graphite feature:
+
+```
+# icinga2 feature enable graphite
+```
+
+Adjust its configuration in `/etc/icinga2/features-enabled/graphite.conf`:
+
+```
+object GraphiteWriter "graphite" {
+ host = "192.0.2.42"
+ port = 2003
+ enable_send_thresholds = true
+}
+```
+
+And then restart Icinga2. Enabling thresholds is not a hard requirement.
+However, some templates look better if they are able to render a max
+value or similar.
+
+## Configuring the Icinga Web Graphite Integration
+
+For required additional steps see the [Configuration](03-Configuration.md) chapter.
+<!-- {% endif %} --><!-- {# end else if index #} -->