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
Philipp C. Heckel 130039f5c8
Merge pull request #1071 from truroshan/traccar-example-add-info
2 days ago
.github Remove Rate-Topics 3 weeks ago
assets Styling 2 years ago
client Avoid panic if user.Current() fails; add logging to "ntfy subscribe" to help figure out what's wrong 3 weeks ago
cmd REvert parallel tests 5 days ago
docs Update traccar examples 2 days ago
examples Add JS websocket example 4 months ago
log Change mod path 4 months ago
scripts Fixing docs links 5 months ago
server Fix linter 4 days ago
test Simplify(?) templating cases 1 week ago
tools Profiling support 1 year ago
user Add comments and another test to ACL fix 4 months ago
util Tests 6 days ago
web Bump 3 days ago
.dockerignore Add a way to use Docker for building everything 10 months ago
.git-blame-ignore-revs Add eslint commits to .git-blame-ignore-revs 10 months ago
.gitignore Build docs in venv 4 months ago
.gitpod.yml Add Gitpod configuration for quick setup of development environments 1 year ago
.goreleaser.yml Re-add tzdata to amd64 6 months ago
CODE_OF_CONDUCT.md Code of Conduct 1 year ago
Dockerfile Revert Docker user fix 3 weeks ago
Dockerfile-arm Revert Docker user fix 3 weeks ago
Dockerfile-build Revert Docker user fix 3 weeks ago
LICENSE Update LICENSE 2 years ago
LICENSE.GPLv2 Update LICENSE.GPLv2 2 years ago
Makefile Fix mkdocs call 4 months ago
README.md Thank you @jceloria for your donation 4 days ago
SECURITY.md Create SECURITY.md 1 year ago
docker-compose.yml add tzdata to image and use env for docker timezone 2 years ago
go.mod Bump 3 days ago
go.sum Bump 3 days ago
main.go Change mod path 4 months ago
mkdocs.yml Merge branch 'main' into Tom-Hubrecht/main 3 weeks ago
requirements.txt Remove dependence on mkdocs-simple-hooks 2 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 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).

Contributing

I welcome any 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 who have sponsored ntfy in the past, or are still sponsoring ntfy:

I'd also like to thank JetBrains for their awesome IntelliJ IDEA, 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: