Document Notification Source

Briefly describe the required configuration for Icinga Notifications
Source next to mentioning it in the About section.

Author: oxzi

config.example.yml

@@ -146,8 +146,8 @@ redis:
 #   # URL to the API root.
 #   api-base-url: http://localhost:5680
 #
-#   # Source or username to authenticate against the /process-event API.
-#   username: source-2
+#   Username to authenticate against the Icinga Notifications API.
+#   username: icingadb
 #
 #   # Password for the defined user.
 #   password: insecureinsecure

doc/01-About.md

@@ -34,6 +34,10 @@ Icinga DB Web also connects to the Icinga 2 API with its Command Transport to ac
 
 These are the components of Icinga DB embedded into an Icinga setup with Icinga 2 and Icinga Web 2.
 
+Since the Icinga DB daemon always receives the latest information from Redis®, it is an ideal candidate to distribute information further.
+In addition to inserting data into a relational database, Icinga DB can also forward events to [Icinga Notifications](https://icinga.com/docs/icinga-notifications/),
+as described in the [configuration section](03-Configuration.md#notifications-source-configuration).
+
 ## Installation
 
 To install Icinga DB see [Installation](02-Installation.md).

doc/03-Configuration.md

@@ -146,7 +146,7 @@ ICINGADB_LOGGING_OPTIONS=database:error,high-availability:debug
 | runtime-updates   | Runtime updates of config objects after the initial config synchronization.     |
 | telemetry         | Reporting of Icinga DB status to Icinga 2 via Redis® (for monitoring purposes). |
 
-## Retention
+## Retention Configuration
 
 By default, no historical data is deleted, which means that the longer the data is retained,
 the more disk space is required to store it. History retention is an optional feature that allows to
@@ -174,6 +174,20 @@ ICINGADB_RETENTION_OPTIONS=comment:356
 | count        | **Optional.** Number of old historical data a single query can delete in a `"DELETE FROM ... LIMIT count"` manner. Defaults to `5000`.                                                                        |
 | options      | **Optional.** Map of history category to number of days to retain its data. Available categories are `acknowledgement`, `comment`, `downtime`, `flapping`, `notification` and `state`.                        |
 
+## Notifications Source Configuration
+
+Icinga DB can act as an event source for [Icinga Notifications](https://icinga.com/docs/icinga-notifications/).
+If configured, Icinga DB will submit events to the Icinga Notifications API.
+
+For YAML configuration, the options are part of the `notifications-source` dictionary.
+For environment variables, each option is prefixed with `ICINGADB_NOTIFICATIONS_SOURCE_`.
+
+| Option       | Description                                                                       |
+|--------------|-----------------------------------------------------------------------------------|
+| api-base-url | **Optional.** Icinga Notifications API base URL, such as `http://localhost:5680`. |
+| username     | **Optional.** Icinga Notifications API user for this source.                      |
+| password     | **Optional.** Icinga Notifications API user password.                             |
+
 ## Appendix
 
 ### Duration String