Repository files navigation

ntfy (pronounced "notify") is a simple HTTP-basedpub-subnotification service. With ntfy, you cansend 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 doso since ntfy is open source.

You can access the free version of ntfy atntfy.sh. There is also anopen-source Android appavailable onGoogle Play orF-Droid,as well as anopen source iOS app available on theApp Store.

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

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

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. Whateverworks best for you:

• Discord server - direct chat with the community
• Matrix room #ntfy (+Matrix space) - same chat, bridged from Discord
• GitHub issues - questions, features, bugs

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

I welcome any contributions. Just create a PR or an issue. For larger features/ideas, please reach outon Discord/Matrix first to see if I'd accept them. To contribute code, check out thebuild instructionsfor the server and the Android app. Or, if you'd like to help translate 🇩🇪 🇺🇸 🇧🇬, you can start immediately inHosted Weblate.

I have just very recently started accepting donations viaGitHub Sponsors,andLiberapay. I would be humbled if you helped me carry the server and developeraccount costs. Even small donations are very much appreciated. A big fatThank You to the folks who have sponsored ntfy in the past, or are still sponsoring ntfy:

I'd also like to thank JetBrains for their awesomeIntelliJ IDEA,andDigitalOcean (referral link) for supporting the project:

We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.

Please be sure to read the completeCode of Conduct.

Made with ❤️ byPhilipp C. Heckel.
The project is dual licensed under theApache License 2.0 and theGPLv2 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 theemoji.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
• webpush-go (MIT) is used to send web push notifications