Send push notifications to your phone or desktop using PUT/POST https://ntfy.sh/

binwiederhier 346d8d7967 Works 1 year ago
.github b62204054f Update 1_bug_report.md 1 year ago
assets 317621c696 Styling 3 years ago
client 70aa384bc3 Docs for access tokens 1 year ago
cmd 94f6d2d5b5 Rename flag 1 year ago
docs 94f6d2d5b5 Rename flag 1 year ago
examples 9155c49571 Revert "Update branch to fit main" 2 years ago
log 1ce92714c4 Add `visitor_seen` to the log context 1 year ago
scripts 5a24e30820 Allow for existing user or group 1 year ago
server 346d8d7967 Works 1 year ago
test 707c58a120 Do not print ugly WS error; tests 2 years ago
tools 1f38a4a531 Upgrade Firebase Admin SDK version 2 years ago
user bfc3983d06 Only set rate visitor if allowed 1 year ago
util 1ce92714c4 Add `visitor_seen` to the log context 1 year ago
web 250637cf92 Added Danish 1 year ago
.gitignore 98b56c2f06 Changelog 2 years ago
.gitpod.yml 265af01f9c Add Gitpod configuration for quick setup of development environments 1 year ago
.goreleaser.yml 1fd166d5c7 Remove upx step from builds 1 year ago
CODE_OF_CONDUCT.md 0646f48ca6 Code of Conduct 1 year ago
Dockerfile 8cc00a6ac6 refined dockerfile 1 year ago
LICENSE dadb6419ee Update LICENSE 3 years ago
LICENSE.GPLv2 3daa590732 Update LICENSE.GPLv2 3 years ago
Makefile dc77efc31a Fix linting 1 year ago
README.md ecff7258ba Release log 1 year ago
SECURITY.md 9334a94886 Create SECURITY.md 1 year ago
docker-compose.yml ae3163c5b1 add tzdata to image and use env for docker timezone 2 years ago
go.mod 983afb2b45 Fix some iffy tests with waitFor function 1 year ago
go.sum 64b3c3c2fa Bump version 1 year ago
main.go f4e8ebc053 Remove urfave/cli workaround 2 years ago
mkdocs.yml 4093a8ea5b Add sponsorship bar to docs 1 year ago
requirements.txt 5a99fe8ba2 Try it a better way 2 years 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 (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.

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: