ntfy-alertmanager

command module
v0.4.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 21, 2024 License: AGPL-3.0 Imports: 28 Imported by: 0

README

ntfy-alertmanager

builds.sr.ht status

A bridge between ntfy and Alertmanager.

Installation

Simply use go build or the docker image (Codeberg image mirror) with docker compose file. ntfy-alertmanager:latest is built from the latest tagged release while ntfy-alertmanager:dev is built from the master branch. On Arch Linux you can install the aur package as well.

Configuration

You can specify the configuration file location with the --config flag. By default the configuration file will be read from /etc/ntfy-alertmanager/config. The format of this file is scfg and there is an example configuration file in this repo. Furthermore you can take a look at my deployment.

ntfy-alertmanager has support for setting ntfy priority, tags, icon, action buttons (which can be used to e.g. create an Alertmanager silence or open the alert's Prometheus URL), email notifications and phone calls. Define a decreasing order of labels in the config file and map those labels to tags, priority, an icon, an email address or an alternative ntfy topic.

  • For priority and icon the first found value will be chosen. Settings for "resolved" alerts will take precedence.
  • Tags are added together.
Alertmanager config
receivers:
  - name: "ntfy"
    webhook_configs:
      - url: "http://127.0.0.1:8080"
        http_config:
          basic_auth:
            username: "webhookUser"
            password: "webhookPass"

Contributing

Report bugs on the issue tracker, send patches/ask questions on the mailing list or write to me directly on matrix @xenrox:xenrox.net. There is a mirror on Codeberg as well, where you can create issues or open pull requests.

Documentation

Overview

A bridge between ntfy and Alertmanager

Directories

Path Synopsis
Package cache includes a memory cache for ntfy-alertmanager.
Package cache includes a memory cache for ntfy-alertmanager.
Package config defines the configuration file.
Package config defines the configuration file.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL