jan/icinga2-matrix-notification
1
0
Fork 0
Code Issues Pull requests Projects Releases 2 Packages Wiki Activity Actions

Improve documentation

Browse source
This commit is contained in:
Jan Dittberner 2024-09-26 17:32:27 +02:00
parent 9f3326d611
commit baadf876dc
1 changed files with 37 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

37
README.md
View file

@ -9,6 +9,43 @@ implementation](https://github.com/linuxmail/icinga2-matrix_notification) which
has been built on the [E-Mail notifications by has been built on the [E-Mail notifications by
sysadmama](https://github.com/sysadmama). sysadmama](https://github.com/sysadmama).
## Building the binaries
You can build binaries via `go build` or using [Goreleaser](https://goreleaser.com/intro/).
```shell
go build ./cmd/matrix-host-notification
go build ./cmd/matrix-service-notification
```
```shell
goreleaser build
```
You may have to add the `--snapshot` and `--clean` command line flags to `goreleaser` if
you are not building a tagged version
or have local modifications.
## Code quality checks
The repository contains a configuration for [golangci-lint](https://golangci-lint.run/). You can
run the linting via
```shell
golangci-lint run
```
## Usage
Copy the notification command binaries to the Icinga 2 systems you want to
send notifications from.
Use the configuration examples as a base for your own NotificationCommand and
Notification object definitions. See
[Notification](https://icinga.com/docs/icinga-2/latest/doc/09-object-types/#notification) and
[NotificationCommand](https://icinga.com/docs/icinga-2/latest/doc/09-object-types/#notificationcommand)
in the Icinga 2 documentation for reference.
## License ## License
Icinga2 Matrix notifications Icinga2 Matrix notifications