babariviere/ntfy-bridge
1
0
Fork 0
Code Issues 1 Pull requests Packages Projects Releases 10 Wiki Activity
Bridge for various implementations to publish to ntfy.
51 commits 1 branch 10 tags 86 KiB
Go 88.7%
Nix 7.9%
Dockerfile 3.4%
Go to file
Renovate Bot ff43a5df3b fix(deps): update git.sr.ht/~emersion/go-scfg digest to 2ae16e7
2024-04-11 09:03:59 +00:00
.forgejo/workflows chore(deps): update actions/setup-go action to v5 2023-12-06 16:00:58 +00:00
bridge style: run formatter 2023-09-11 20:01:26 +02:00
config feat: add alertmanager handler 2023-09-11 18:56:14 +02:00
k8s feat: add alertmanager handler 2023-09-11 18:56:14 +02:00
release chore(deps): update alpine docker tag to v3.19 2023-12-08 02:02:26 +00:00
.dockerignore chore: update dockerignore to remove direnv 2023-09-11 17:59:28 +02:00
.envrc Initial commit 2023-08-31 18:33:09 +02:00
.gitignore chore: add goreleaser 2023-09-01 19:18:38 +02:00
.goreleaser.yaml chore: configure goreleaser manifest 2023-09-01 22:10:31 +02:00
config.example.scfg feat: add discord_embed handler 2023-09-03 17:09:00 +02:00
Dockerfile chore(deps): update golang docker tag to v1.22 2024-02-07 03:02:15 +00:00
flake.lock Initial commit 2023-08-31 18:33:09 +02:00
flake.nix feat: setup skaffold 2023-09-03 13:04:34 +02:00
go.mod fix(deps): update git.sr.ht/~emersion/go-scfg digest to 2ae16e7 2024-04-11 09:03:59 +00:00
go.sum fix(deps): update git.sr.ht/~emersion/go-scfg digest to 2ae16e7 2024-04-11 09:03:59 +00:00
LICENSE Initial commit 2023-08-31 18:33:09 +02:00
main.go feat: add alertmanager handler 2023-09-11 18:56:14 +02:00
README.md docs: add README instructions 2023-09-11 19:58:02 +02:00
renovate.json chore: configure renovate 2023-09-03 18:05:52 +02:00
skaffold.yaml chore: enable local build in skaffold 2023-09-03 14:58:47 +02:00

README.md

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.