owncast-ntfy

command module
v0.1.0 Latest Latest
Warning

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

Go to latest
Published: Nov 3, 2024 License: Apache-2.0 Imports: 14 Imported by: 0

README

Owncast Webhook Ntfy integration

Integration between https://ntfy.sh/ and Owncast Webhook.

What's this?

It is a small simple http server that takes a Owncast webhook and re-formats it for ntfy format.

How to use

Binary

Download the release binary and run it as a server

owncast-ntfy -ntfy-url "https://ntfy.sh/mytopic"

This will create an http (no https) server in port 8080 that will accept POST request, re-format them and send them to the ntfy url. You can use custom ntfy servers if you want.

Options

See owncast-ntfy -h for all options.

Usage of owncast-ntfy:
  -allow-insecure
        Allow insecure connections to ntfy-url
  -markdown
    	Use Markdown message formatting
  -basic-auth string
        Basic auth used for ntfy, e.g.: user:pass     
  -ntfy-url string
        The ntfy url including the topic. e.g.: https://ntfy.sh/mytopic
  -port int
        The port to listen on (default 8080)   

No https?

This webhook is suppose to run next to your owncast instance and only accepts local request. You should not expose this server to the internet.

License

Originally licensed under Apache License 2.0

Now AGPL-v3.0

Credits

Original code from grafana-alerting-ntfy-webhook-integration, licensed under Apache License 2.0

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

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