ntfy README

The project's README from github.com/binwiederhier/ntfy. As one markdown file: README.md.

Special thanks to:

Warp sponsorship

Warp, built for coding with multiple AI agents.

Available for MacOS, Linux, & Windows


ntfy

ntfy.sh | Send push notifications to your phone or desktop via PUT/POST

Release Go Reference Tests Go Report Card codecov Discord Matrix Matrix space Healthcheck Gitpod

ntfy (pronounced "notify") is a simple HTTP-based pub-sub notification service. With ntfy, you can send notifications to your phone or desktop via scripts from any computer, without having to sign up or pay any fees. If you'd like to run your own instance of the service, you can easily do so since ntfy is open source.

You can access the free version of ntfy at ntfy.sh. There is also an open-source Android app available on Google Play or F-Droid, as well as an open source iOS app available on the App Store.

ntfy Pro 💸 🎉

I now offer paid plans for ntfy.sh if you don't want to self-host, or you want to support the development of ntfy (→ Purchase via web app). You can buy a plan for as low as $5/month. You can also donate via GitHub Sponsors, and Liberapay. I would be very humbled by your sponsorship. ❤️

Documentation

Getting started | Android/iOS | API | Install / Self-hosting | Building

Chat/forum

There are a few ways to get in touch with me and/or the rest of the community. Feel free to use any of these methods. Whatever works best for you:

Announcements/beta testers

For announcements of new releases and cutting-edge beta versions, please subscribe to the ntfy.sh/announcements topic. If you'd like to test the iOS app, join TestFlight. For Android betas, join Discord/Matrix (I'll eventually make a testing channel in Google Play).

Sponsors

If you'd like to support the ntfy maintainers, please consider donating to GitHub Sponsors or and Liberapay. We would be humbled if you helped carry the server and developer account costs. Even small donations are very much appreciated.

Thank you to our commercial sponsors, who help keep the service running and the development going:

And a big fat Thank You to the individuals who have sponsored ntfy in the past, or are still sponsoring ntfy:

<img src="https://gith

ntfy (binwiederhier/ntfy)

Searching Database…

34.9K ·GitHub
What is this?ntfy is a simple HTTP-based pub-sub notification service that lets you send push notifications to your phone or desktop with a single PUT or POST request, without signing up or paying anything.
Is this a hosted service or something I run myself?Both: you can use the free public instance at ntfy.sh right away, or self-host your own server since the whole project is open source.
How do I send my first notification?Pick any topic name and send a PUT or POST request to it (for example with curl against ntfy.sh/your-topic), or self-host your own server using the provided Docker image and Compose file.
Do I need to create an account to use ntfy.sh?No account or API key is required — you can start publishing and subscribing to topics on the free public service immediately; you just need the official Android/iOS app or a browser to receive messages.
Is the free ntfy.sh service enough, or do I need Pro?The free service works without any account, but the author also offers paid Pro plans starting at $5/month for people who don't want to self-host or want to support development.
Which apps can actually receive these notifications?There are official open-source apps for Android (Google Play or F-Droid) and iOS (App Store), in addition to self-hosting the server itself.
What does the free public service cost compared to Pro?ntfy.sh itself is free with no signup, while Pro is an optional paid tier starting at $5/month for people who want extra support or don't want to self-host.
What is the server written in?The server is implemented in Go, and the project ships official Docker images and Docker Compose files for self-hosting.
Can I test ntfy without installing any app?Yes, you can publish and read messages straight from the command line with a tool like curl against any topic on ntfy.sh before installing a mobile app.
Size
42.7 MB
Stars
34.9K
Age
4y
Commits · 90 Days