ntfy/README.md

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

ntfy (pronounce: notify) is a simple HTTP-based pub-sub notification service. It allows you to send notifications to your phone or desktop via scripts from any computer, entirely without signup or cost. It's also open source (as you can plainly see) if you want to run your own.

I run a free version of it at ntfy.sh. There's also an open source Android app (see Google Play or F-Droid), and an open source iOS app (see App Store).

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:

• Discord server - direct chat with the community
• Matrix room #ntfy (+ Matrix space) - same chat, bridged from Discord
• Reddit r/ntfy - asynchronous forum (new as of October 2022)
• GitHub issues - questions, features, bugs
• Email - reach me directly (I usually prefer the other methods)

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).

Contributing

I welcome any and all contributions. Just create a PR or an issue. To contribute code, check out the build instructions for the server and the Android app. Or, if you'd like to help translate 🇩🇪 🇺🇸 🇧🇬, you can start immediately in Hosted Weblate.

Sponsors

I have just very recently started accepting donations via GitHub Sponsors. I would be humbled if you helped me carry the server and developer account costs. Even small donations are very much appreciated. A big fat Thank You to the folks already sponsoring ntfy:

I'd also like to thank DigitalOcean for supporting the project with $60/yr:

License

Made with ❤️ by Philipp C. Heckel.
The project is dual licensed under the Apache License 2.0 and the GPLv2 License.

Third party libraries and resources:

• github.com/urfave/cli (MIT) is used to drive the CLI
• Mixkit sounds (Mixkit Free License) are used as notification sounds
• Sounds from notificationsounds.com (Creative Commons Attribution) are used as notification sounds
• Roboto Font (Apache 2.0) is used as a font in everything web
• React (MIT) is used for the web app
• Material UI components (MIT) are used in the web app
• MUI dashboard template (MIT) was used as a basis for the web app
• Dexie.js (Apache 2.0) is used for web app persistence in IndexedDB
• GoReleaser (MIT) is used to create releases
• go-smtp (MIT) is used to receive e-mails
• stretchr/testify (MIT) is used for unit and integration tests
• github.com/mattn/go-sqlite3 (MIT) is used to provide the persistent message cache
• Firebase Admin SDK (Apache 2.0) is used to send FCM messages
• github/gemoji (MIT) is used for emoji support (specifically the emoji.json file)
• Lightbox with vanilla JS as a lightbox on the landing page
• HTTP middleware for gzip compression (MIT) is used for serving static files
• Regex for auto-linking (MIT) is used to highlight links (the library is not used)
• Statically linking go-sqlite3
• Linked tabs in mkdocs