Send push notifications to your phone or desktop using PUT/POST
 
 
 
 
 
Go to file
zhzy0077 6a10bac017 Update template server.yml 2023-09-08 13:21:55 +08:00
.github Bump Go version in pipelines 2023-06-30 08:45:28 -04:00
assets Styling 2021-10-24 14:22:53 -04:00
client fixes #829 2023-08-06 22:44:55 -06:00
cmd Update template server.yml 2023-09-08 13:21:55 +08:00
docs Update template server.yml 2023-09-08 13:21:55 +08:00
examples Troubleshooting docs page 2023-03-20 15:34:10 -04:00
log Self-review 2023-05-17 10:39:15 -04:00
scripts Make emojis in docs larger 2023-04-06 21:51:25 -04:00
server Update template server.yml 2023-09-08 13:21:55 +08:00
test Do not print ugly WS error; tests 2022-01-15 22:33:35 -05:00
tools Profiling support 2023-03-28 14:41:16 -04:00
user Release notes 2023-06-28 12:54:13 -04:00
util Newly created access tokens are now lowercase only 2023-06-14 11:20:29 -04:00
web Merge pull request #820 from nihalgonsalves/ng/display-external-images 2023-08-08 20:47:43 -04:00
.dockerignore Add a way to use Docker for building everything 2023-05-26 22:22:21 +02:00
.git-blame-ignore-revs Add eslint commits to .git-blame-ignore-revs 2023-05-24 12:58:49 +02:00
.gitignore Add PWA, service worker and Web Push 2023-06-07 20:38:20 +02:00
.gitpod.yml Add Gitpod configuration for quick setup of development environments 2022-12-10 21:56:13 +00:00
.goreleaser.yml Fix goreleaser 2023-06-30 09:30:36 -04:00
CODE_OF_CONDUCT.md Code of Conduct 2022-12-12 15:06:04 -05:00
Dockerfile refined dockerfile 2023-03-02 14:59:49 +01:00
Dockerfile-build chore(build): bump Dockerfile-build go version 2023-07-10 20:14:29 +02:00
LICENSE Update LICENSE 2021-12-05 12:51:08 -05:00
LICENSE.GPLv2 Update LICENSE.GPLv2 2021-12-05 12:52:20 -05:00
Makefile Add a way to use Docker for building everything 2023-05-26 22:22:21 +02:00
README.md Thank you @bmcgonag for your sponsorship 2023-08-05 21:13:48 -04:00
SECURITY.md Create SECURITY.md 2023-03-02 21:39:04 -05:00
docker-compose.yml add tzdata to image and use env for docker timezone 2022-06-02 13:35:49 -07:00
go.mod Thank you @darkmattercoder for your donation 2023-08-03 10:49:04 -04:00
go.sum Thank you @darkmattercoder for your donation 2023-08-03 10:49:04 -04:00
main.go Remove urfave/cli workaround 2022-03-16 14:50:00 -04:00
mkdocs.yml Cont'd docs 2023-06-24 22:08:57 -04:00
requirements.txt Built mkdocs plugin, set font to desired options 2023-03-12 15:32:25 -04:00

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 Lemmy 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 $3.33/month (if you use promo code MYTOPIC, limited time only). 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 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 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: