diff --git a/README.md b/README.md index 30053dc..8b02861 100644 --- a/README.md +++ b/README.md @@ -11,11 +11,41 @@ Other Icinga and Prometheus integrations we provide: ## Installation -The `alertmanager-icinga-bridge` is available as an executable in the GitHub Releases and as a container image `ghcr.io/netways/alertmanager-icinga-bridge`. +The `alertmanager-icinga-bridge` is available as an executable in the GitHub Releases, a container image and Linux repositories. -* Install and start the `alertmanager-icinga-bridge` executable -* Create an Icinga host and API user for Alertmanager-Icinga-Bridge -* Create an Icinga service template for the managed services +1. Install and start the `alertmanager-icinga-bridge` +2. Create an Icinga host and API user for Alertmanager-Icinga-Bridge +3. Create an Icinga service template for the managed services + +### Container + +A container image is available at: + +``` +ghcr.io/netways/alertmanager-icinga-bridge +``` + +### Packages + +NETWAYS provides this tool via [https://packages.netways.de](https://packages.netways.de/). + +To install this module, follow the setup instructions for the **extras** repository. + +**RHEL or compatible:** + +`dnf install netways-alertmanager-icinga-bridge` + +**Ubuntu/Debian:** + +`apt install netways-alertmanager-icinga-bridge` + +## Usage + +When started, Alertmanager-Icinga-Bridge listens to HTTP requests on the following paths: + +* `/webhook` Endpoint to accept alerts from Alertmanager. +* `/healthz` returns HTTP 200 with `ok` as its payload as long as the webhook + serving loop is operational. Example: @@ -29,14 +59,6 @@ alertmanager-icinga-bridge \ --bearer-token alertmanager-example-token ``` -## Usage - -When started, Alertmanager-Icinga-Bridge listens to HTTP requests on the following paths: - -* `/webhook` Endpoint to accept alerts from Alertmanager. -* `/healthz` returns HTTP 200 with `ok` as its payload as long as the webhook - serving loop is operational. - ## Configuration ```