parra/ntfy

mirror of https://github.com/binwiederhier/ntfy.git synced 2024-12-22 17:52:30 +01:00

Send push notifications to your phone or desktop using PUT/POST https://ntfy.sh

curl notifications ntfy ntfysh pubsub push-notifications rest-api

Find a file

Philipp Heckel c3b97365ce Text field for mobile		2021-10-23 23:30:10 -04:00
cmd	Makefile, Dockerfile, GoReleaser, config.yml, systemd service	2021-10-23 21:29:45 -04:00
config	Rate limiting, docs	2021-10-23 22:49:50 -04:00
scripts	Makefile, Dockerfile, GoReleaser, config.yml, systemd service	2021-10-23 21:29:45 -04:00
server	Text field for mobile	2021-10-23 23:30:10 -04:00
.gitignore	Makefile, Dockerfile, GoReleaser, config.yml, systemd service	2021-10-23 21:29:45 -04:00
.goreleaser.yml	Makefile, Dockerfile, GoReleaser, config.yml, systemd service	2021-10-23 21:29:45 -04:00
Dockerfile	Makefile, Dockerfile, GoReleaser, config.yml, systemd service	2021-10-23 21:29:45 -04:00
go.mod	Rate limiting, docs	2021-10-23 22:49:50 -04:00
go.sum	Rate limiting, docs	2021-10-23 22:49:50 -04:00
LICENSE	Initial commit	2021-10-22 18:54:02 -04:00
main.go	Makefile, Dockerfile, GoReleaser, config.yml, systemd service	2021-10-23 21:29:45 -04:00
Makefile	Makefile, Dockerfile, GoReleaser, config.yml, systemd service	2021-10-23 21:29:45 -04:00
README.md	Rate limiting, docs	2021-10-23 22:49:50 -04:00

README.md

ntfy

ntfy (pronounce: notify) is a super simple pub-sub notification service. It allows you to send desktop and (soon) phone notifications via scripts. I run a free version of it on ntfy.sh. No signups or cost.

Usage

Topics are created on the fly by subscribing to them. You can create and subscribe to a topic either in a web UI, or in your own app by subscribing to an SSE/EventSource, or a JSON or raw feed.

Because there is no sign-up, the topic is essentially a password, so pick something that's not easily guessable.

Here's how you can create a topic mytopic, subscribe to it topic and wait for events. This is using curl, but you can use any library that can do HTTP GETs:

# Subscribe to "mytopic" and output one message per line (\n are replaced with a space)
curl -s ntfy.sh/mytopic/raw

# Subscribe to "mytopic" and output one JSON message per line
curl -s ntfy.sh/mytopic/json

# Subscribe to "mytopic" and output an SSE stream (supported via JS/EventSource)
curl -s ntfy.sh/mytopic/sse

You can easily script it to execute any command when a message arrives. This sends desktop notifications (just like the web UI, but without it):

while read msg; do 
  notify-send "$msg"
done < <(stdbuf -i0 -o0 curl -s ntfy.sh/mytopic/raw)

Publish messages

Publishing messages can be done via PUT or POST using. Here's an example using curl:

curl -d "long process is done" ntfy.sh/mytopic

Messages published to a non-existing topic or a topic without subscribers will not be delivered later. There is (currently) no buffering of any kind. If you're not listening, the message won't be delivered.

FAQ

Isn't this like ...?

Probably. I didn't do a whole lot of research before making this.

Can I use this in my app?

Yes. As long as you don't abuse it, it'll be available and free of charge.

What are the uptime guarantees?

Best effort.

Why is the web UI so ugly?

I don't particularly like JS or dealing with CSS. I'll make it pretty after it's functional.

Will you know what topics exist, can you spy on me?

If you don't trust me or your messages are sensitive, run your ntfy on your own server. That said, the logs do not contain any topic names

TODO

add HTTPS

Contributing

I welcome any and all contributions. Just create a PR or an issue.

License

Made with ❤️ by Philipp C. Heckel, distributed under the Apache License 2.0.