Send push notifications to your phone or desktop using PUT/POST
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Go to file
binwiederhier 2624897efe
Merge branch 'main' of github.com:binwiederhier/ntfy
2 days ago
.github Update FUNDING.yml 4 days ago
assets Styling 1 year ago
auth Reduce bcrypt cost to 10 12 months ago
client `ntfy pub`: use `default-user` and `default-password` from `client.yml` 4 months ago
cmd Remove --env-topic flag from "ntfy publish" (as per deprecation) 2 months ago
docs Add Shoutrrr integration 2 days ago
examples Revert "Update branch to fit main" 3 months ago
log Replace interface{} 4 months ago
scripts Allow for existing user or group 4 weeks ago
server Health API endpoint 1 month ago
test Do not print ugly WS error; tests 1 year ago
tools/fbsend Upgrade Firebase Admin SDK version 8 months ago
util Fix race condition making it possible for batches to be >batchSize 2 months ago
web Added Portuguese 1 week ago
.gitignore Changelog 8 months ago
.gitpod.yml Add Gitpod configuration for quick setup of development environments 2 months ago
.goreleaser.yml Remove upx step from builds 2 weeks ago
CODE_OF_CONDUCT.md Code of Conduct 2 months ago
Dockerfile Use health endpoint 1 month ago
LICENSE Update LICENSE 1 year ago
LICENSE.GPLv2 Update LICENSE.GPLv2 1 year ago
Makefile Remove upx references 4 days ago
README.md Thanks to @billycao for your sponsorship 3 days ago
docker-compose.yml add tzdata to image and use env for docker timezone 8 months ago
go.mod Downgrade smtp lib 3 weeks ago
go.sum Remove upx references 4 days ago
main.go Remove urfave/cli workaround 11 months ago
mkdocs.yml Known issues 1 month ago
requirements.txt Try it a better way 10 months ago

README.md

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 Reddit Healthcheck Gitpod

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:

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. For larger features/ideas, please reach out on Discord/Matrix first to see if I'd accept them. 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.

Translation status

Sponsors

I have just very recently started accepting donations via GitHub Sponsors, and Liberapay. 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 JetBrains for providing their awesome IntelliJ IDEA to me for free, and DigitalOcean (referral link) for supporting the project:

Code of Conduct

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 complete Code of Conduct.

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: