binwiederhier

ntfy: Send Push Notifications with HTTP Requests

ntfy is an HTTP-based publish-subscribe notification service for sending messages to phones and desktops. Publish from scripts with PUT or POST, use the hosted service, or run your own instance.

Stars
34.6k
Forks
1.6k
Stars, last 8 days
+166

Our take

Health score

77/100

How it is scored
Activity
80
Community
69
Issues
86
Pull requests
71

+166 stars in the last 8 days

  • Closes issues faster than 83% of the projects we track
  • More contributors than 77% of the projects we track

Overview

ntfy provides a simple way for scripts and applications to deliver notifications to subscribed devices. A publisher sends an HTTP request to a topic, and subscribers can receive its messages on phones or desktops without building a notification delivery system from scratch.

Use the hosted service at ntfy.sh for convenience, or self-host the open-source server when you want to run the service yourself. Android and iOS apps are available, alongside a web app and an API documented at ntfy.sh/docs.

Key Features

  • Publish messages using HTTP PUT or POST requests.
  • Use a topic-based publish-subscribe model to route notifications.
  • Send notifications from scripts and other computers.
  • Receive notifications on Android, iOS, and desktop through the web app.
  • Choose the hosted ntfy.sh service or install a self-hosted instance.
  • Access an HTTP publishing API and documentation for setup and use.

Use Cases

  • System administrators can send alerts from maintenance or monitoring scripts to a phone or desktop.
  • Developers can notify themselves when a long-running script or task finishes.
  • Individuals can connect simple automations to a notification endpoint without implementing a delivery backend.
  • Teams or privacy-conscious users can self-host the service rather than rely on the public hosted instance.

Getting Started

Send a message to a topic with curl:

curl -d "Backup finished" ntfy.sh/mytopic

See the README and documentation for subscribing, mobile apps, and self-hosting instructions.

Considerations

  • Topics are the basis for publishing and subscribing, so choose topic names and access arrangements with your deployment in mind.
  • The README describes the public hosted service as usable without signup or fees, and also offers paid ntfy.sh plans. Self-hosting is available for users who want to operate their own instance.
  • The repository's README describes the project as dual licensed under Apache License 2.0 and GPLv2; check the license files for applicable terms.
  • The project includes separate Android and iOS apps. Consult their respective repositories and the documentation for platform-specific details.

Found this useful?

Share it with someone who would like ntfy.

Comparisons