ntfy-bridge/README.md
Bastien Riviere c1f23220fa
All checks were successful
Go / build (push) Successful in 26s
docs: add README instructions
2023-09-11 19:58:02 +02:00

1.4 KiB

ntfy-bridge

Bridge for various implementations to publish to ntfy.

Installation

Using go:

go install forge.babariviere.com/babariviere/ntfy-bridge@latest

Or using docker:

docker pull forge.babariviere.com/babariviere/ntfy-bridge:latest

Binaries are also avaiable in the release section.

Usage

First, you need to create a configuration file. A sample one is provided here.

For now, we have these handler types:

  • flux: handle notification from Flux
  • discord_embed: handle preformated notification from discord embeds (see embed object)
  • alertmanager: handle notification from alertmanager using webhook_config

Once you have created your config file, you can either put it in these directories:

  • /etc/ntfy-bridge/config.scfg
  • $HOME/.ntfy-bridge/config.scfg
  • $HOME/.config/ntfy-bridge/config.scfg
  • config.scfg (current directory)

Then, you can simply run the binary with either the native binary:

./ntfy-bridge

Or via docker:

docker run -v config.scfg:/etc/ntfy-bridge/config.scfg -p 8080 forge.babariviere.com/babariviere/ntfy-bridge:latest

Sample config for kubernetes can be found in ./k8s/ directory.