Go to file
Philipp C. Heckel 130039f5c8
Merge pull request #1071 from truroshan/traccar-example-add-info
Update traccar examples
2024-03-27 12:21:24 -04:00
.github Remove Rate-Topics 2024-03-07 10:07:42 -05:00
assets Styling 2021-10-24 14:22:53 -04:00
client Avoid panic if user.Current() fails; add logging to "ntfy subscribe" to help figure out what's wrong 2024-03-07 15:56:20 -05:00
cmd Avoid panic if user.Current() fails; add logging to "ntfy subscribe" to help figure out what's wrong 2024-03-07 15:56:20 -05:00
docs Update traccar examples 2024-03-27 18:39:31 +05:30
examples Add JS websocket example 2023-11-15 09:28:35 -07:00
log Change mod path 2023-11-16 20:54:58 -05:00
scripts Fixing docs links 2023-10-29 12:32:08 -04:00
server Fix linter 2024-03-25 09:34:44 -04:00
test Simplify(?) templating cases 2024-03-20 21:33:54 -04:00
tools Profiling support 2023-03-28 14:41:16 -04:00
user Add comments and another test to ACL fix 2023-11-18 21:50:01 -05:00
util Tests 2024-03-22 22:01:41 -04:00
web Bump 2024-03-25 17:21:23 -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 Build docs in venv 2023-11-16 05:31:53 -05:00
.gitpod.yml Add Gitpod configuration for quick setup of development environments 2022-12-10 21:56:13 +00:00
.goreleaser.yml Re-add tzdata to amd64 2023-09-24 11:45:35 -04:00
CODE_OF_CONDUCT.md Code of Conduct 2022-12-12 15:06:04 -05:00
Dockerfile Revert Docker user fix 2024-03-07 16:59:42 -05:00
Dockerfile-arm Revert Docker user fix 2024-03-07 16:59:42 -05:00
Dockerfile-build Revert Docker user fix 2024-03-07 16:59:42 -05: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 Fix mkdocs call 2023-11-17 10:41:16 +08:00
README.md Thank you @jceloria for your donation 2024-03-25 09:42:09 -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 Bump 2024-03-25 17:21:23 -04:00
go.sum Bump 2024-03-25 17:21:23 -04:00
main.go Change mod path 2023-11-16 20:54:58 -05:00
mkdocs.yml Merge branch 'main' into Tom-Hubrecht/main 2024-03-07 10:22:39 -05:00
requirements.txt Remove dependence on mkdocs-simple-hooks 2024-02-05 13:29:55 +01: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 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: