2022-03-13 16:08:38 -04:00
2021-11-03 11:38:46 -04:00
2021-12-05 16:28:12 -05:00
# ntfy.sh | Send push notifications to your phone or desktop via PUT/POST
2021-11-26 17:09:41 -05:00
[](https://github.com/binwiederhier/ntfy/releases/latest)
2021-12-07 15:39:42 -05:00
[](https://pkg.go.dev/heckel.io/ntfy)
[](https://github.com/binwiederhier/ntfy/actions)
[](https://goreportcard.com/report/github.com/binwiederhier/ntfy)
[](https://codecov.io/gh/binwiederhier/ntfy)
2022-01-03 11:49:39 -05:00
[](https://discord.gg/cT7ECsZj9w)
[](https://matrix.to/#/#ntfy:matrix .org)
2021-12-09 13:53:47 -05:00
[](https://ntfy.statuspage.io/)
2021-10-22 21:26:01 -04:00
2021-11-20 16:02:05 -05:00
**ntfy** (pronounce: *notify* ) is a simple HTTP-based [pub-sub ](https://en.wikipedia.org/wiki/Publish%E2%80%93subscribe_pattern ) notification service.
2021-11-03 11:36:09 -04:00
It allows you to **send notifications to your phone or desktop via scripts** from any computer, entirely **without signup or cost** .
2021-11-03 11:33:34 -04:00
It's also open source (as you can plainly see) if you want to run your own.
2021-11-25 08:58:26 -05:00
I run a free version of it at ** [ntfy.sh ](https://ntfy.sh )**, and there's an [open source ](https://github.com/binwiederhier/ntfy-android ) [Android app ](https://play.google.com/store/apps/details?id=io.heckel.ntfy )
2021-11-03 11:33:34 -04:00
too.
2021-10-22 21:26:01 -04:00
2021-11-09 10:51:21 -05:00
< p >
2022-03-11 19:02:44 -08:00
< img src = "web/public/static/img/screenshot-curl.png" height = "180" >
< img src = "web/public/static/img/screenshot-web-detail.png" height = "180" >
< img src = "web/public/static/img/screenshot-phone-main.jpg" height = "180" >
< img src = "web/public/static/img/screenshot-phone-detail.jpg" height = "180" >
< img src = "web/public/static/img/screenshot-phone-notification.jpg" height = "180" >
2021-11-09 10:51:21 -05:00
< / p >
2021-12-05 16:28:12 -05:00
## **[Documentation](https://ntfy.sh/docs/)**
2021-10-22 21:26:01 -04:00
2021-12-05 16:28:12 -05:00
[Getting started ](https://ntfy.sh/docs/ ) |
[Android/iOS ](https://ntfy.sh/docs/subscribe/phone/ ) |
[API ](https://ntfy.sh/docs/publish/ ) |
[Install / Self-hosting ](https://ntfy.sh/docs/install/ ) |
[Building ](https://ntfy.sh/docs/develop/ )
2021-10-23 23:37:30 -04:00
2021-10-23 15:22:17 -04:00
## Contributing
2022-03-25 18:54:40 -04:00
I welcome any and all contributions. Just create a PR or an issue. To contribute code, check out
the [build instructions ](https://ntfy.sh/docs/develop/ ) for the server and the Android app.
2022-03-25 18:56:22 -04:00
Or, if you'd like to help translate 🇩🇪 🇺🇸 🇧🇬, you can start immediately in
2022-03-25 18:54:40 -04:00
[Hosted Weblate ](https://hosted.weblate.org/projects/ntfy/ ).
2021-10-23 15:22:17 -04:00
2022-03-28 11:07:05 -04:00
< a href = "https://hosted.weblate.org/engage/ntfy/" >
< img src = "https://hosted.weblate.org/widgets/ntfy/-/multi-blue.svg" alt = "Translation status" / >
< / a >
2021-11-26 17:09:41 -05:00
## Contact me
2022-01-03 11:49:39 -05:00
You can directly contact me ** [on Discord ](https://discord.gg/cT7ECsZj9w )** or [on Matrix ](https://matrix.to/#/#ntfy:matrix.org )
(bridged from Discord), or via the [GitHub issues ](https://github.com/binwiederhier/ntfy/issues ), or find more contact information
[on my website ](https://heckel.io/about ).
2021-11-26 17:09:41 -05:00
2021-10-23 15:22:17 -04:00
## License
2021-11-19 20:21:16 -05:00
Made with ❤️ by [Philipp C. Heckel ](https://heckel.io ).
The project is dual licensed under the [Apache License 2.0 ](LICENSE ) and the [GPLv2 License ](LICENSE.GPLv2 ).
2021-10-24 14:51:49 -04:00
Third party libraries and resources:
* [github.com/urfave/cli/v2 ](https://github.com/urfave/cli/v2 ) (MIT) is used to drive the CLI
2022-03-06 10:42:05 -05:00
* [Mixkit sounds ](https://mixkit.co/free-sound-effects/notification/ ) (Mixkit Free License) are used as notification sounds
* [Sounds from notificationsounds.com ](https://notificationsounds.com ) (Creative Commons Attribution) are used as notification sounds
* [Roboto Font ](https://fonts.google.com/specimen/Roboto ) (Apache 2.0) is used as a font in everything web
* [React ](https://reactjs.org/ ) (MIT) is used for the web app
* [Material UI components ](https://mui.com/ ) (MIT) are used in the web app
* [MUI dashboard template ](https://github.com/mui/material-ui/tree/master/docs/data/material/getting-started/templates/dashboard ) (MIT) was used as a basis for the web app
* [Dexie.js ](https://github.com/dexie/Dexie.js ) (Apache 2.0) is used for web app persistence in IndexedDB
2021-11-03 11:33:34 -04:00
* [GoReleaser ](https://goreleaser.com/ ) (MIT) is used to create releases
2021-12-28 17:36:12 +01:00
* [go-smtp ](https://github.com/emersion/go-smtp ) (MIT) is used to receive e-mails
* [stretchr/testify ](https://github.com/stretchr/testify ) (MIT) is used for unit and integration tests
2021-11-03 11:33:34 -04:00
* [github.com/mattn/go-sqlite3 ](https://github.com/mattn/go-sqlite3 ) (MIT) is used to provide the persistent message cache
* [Firebase Admin SDK ](https://github.com/firebase/firebase-admin-go ) (Apache 2.0) is used to send FCM messages
2021-11-29 09:34:43 -05:00
* [github/gemoji ](https://github.com/github/gemoji ) (MIT) is used for emoji support (specifically the [emoji.json ](https://raw.githubusercontent.com/github/gemoji/master/db/emoji.json ) file)
2022-03-06 10:42:05 -05:00
* [Lightbox with vanilla JS ](https://yossiabramov.com/blog/vanilla-js-lightbox ) as a lightbox on the landing page
2022-03-10 21:55:56 -05:00
* [HTTP middleware for gzip compression ](https://gist.github.com/CJEnright/bc2d8b8dc0c1389a9feeddb110f822d7 ) (MIT) is used for serving static files
2022-03-11 11:46:19 -05:00
* [Regex for auto-linking ](https://github.com/bryanwoods/autolink-js ) (MIT) is used to highlight links (the library is not used)
2021-11-20 20:18:40 -05:00
* [Statically linking go-sqlite3 ](https://www.arp242.net/static-go.html )
2022-03-11 10:43:18 -05:00
* [Linked tabs in mkdocs ](https://facelessuser.github.io/pymdown-extensions/extensions/tabbed/#linked-tabs )
