Skip to content

Commit 89846ac

Browse files
committed
README.md: document Event Stream usage
1 parent 78ed1f9 commit 89846ac

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,17 +28,21 @@ Additionally, it also requires you to manually insert items into the **source**
2828
INSERT INTO source (id, type, name) VALUES (1, 'icinga2', 'Icinga 2')
2929
```
3030

31+
Currently, there are two ways how notifications get communicated between Icinga 2 and Icinga Notifications.
32+
Please select only one, whereby the first is recommended:
33+
34+
* Icinga Notifications can pull those from the Icinga 2 API when being configured in the YAML configuration file.
35+
For each `source`, as inserted in the database above, an `icinga2-apis` endpoint must be defined.
36+
* Otherwise, Icinga 2 can push the notifications to the Icinga Notification daemon.
37+
Therefore, you need to copy the [Icinga 2 config](icinga2.conf) to `/etc/icinga2/features-enabled` on your master node(s) and restart the Icinga 2 service.
38+
At the top of this file, you will find multiple configurations options that can be set in `/etc/icinga2/constants.conf`.
39+
There are also Icinga2 `EventCommand` definitions in this file that will automatically match all your **checkables**, which may not work properly if the configuration already uses event commands for something else.
40+
3141
Then, you can launch the daemon with the following command.
3242
```go
3343
go run ./cmd/icinga-notifications-daemon --config config.yml
3444
```
3545

36-
Last but not least, in order for the daemon to receive events from Icinga 2, you need to copy the [Icinga 2 config](icinga2.conf)
37-
to `/etc/icinga2/features-enabled` on your master node(s) and restart the Icinga 2 service. At the top of this file,
38-
you will find multiple configurations options that can be set in `/etc/icinga2/constants.conf`. There are also Icinga2
39-
`EventCommand` definitions in this file that will automatically match all your **checkables**, which may not work
40-
properly if the configuration already uses event commands for something else.
41-
4246
## License
4347

4448
Icinga Notifications is licensed under the terms of the [GNU General Public License Version 2](LICENSE).

0 commit comments

Comments
 (0)