parra/ntfy

mirror of https://github.com/binwiederhier/ntfy.git synced 2024-12-23 10:12:38 +01:00

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

curl notifications ntfy ntfysh pubsub push-notifications rest-api

Find a file

Philipp Heckel 6cd31502e7 Merge branch 'main' of github.com:binwiederhier/ntfy into develop-docs		2022-03-17 16:04:15 -04:00
.github/workflows	Re-embed fonts	2022-03-05 21:15:40 -05:00
assets
auth
client
cmd	Remove urfave/cli workaround	2022-03-16 14:50:00 -04:00
docs	Merge branch 'main' of github.com:binwiederhier/ntfy into develop-docs	2022-03-17 16:04:15 -04:00
examples
scripts	Emojis, formatting, clear all	2022-02-24 12:26:07 -05:00
server	Publish as JSON	2022-03-16 14:16:54 -04:00
test
tools/fbsend
util	Gzip static responses	2022-03-10 21:55:56 -05:00
web	Fixed typo in url	2022-03-15 16:09:20 +01:00
.gitignore	Embed new web UI into server	2022-03-05 20:24:10 -05:00
.goreleaser.yml	rpm: Do not replace server.yml, closes #166	2022-03-14 17:21:28 -04:00
Dockerfile
go.mod	Remove urfave/cli workaround	2022-03-16 14:50:00 -04:00
go.sum	Remove urfave/cli workaround	2022-03-16 14:50:00 -04:00
LICENSE
LICENSE.GPLv2
main.go	Remove urfave/cli workaround	2022-03-16 14:50:00 -04:00
Makefile	WIP: Develop docs	2022-03-16 22:33:23 -04:00
mkdocs.yml	Docs, release notes	2022-02-27 15:45:43 -05:00
README.md	Update README.md	2022-03-13 16:08:38 -04:00
requirements.txt

README.md

ntfy.sh | Send push notifications to your phone or desktop via PUT/POST

ntfy (pronounce: notify) is a simple HTTP-based pub-sub notification service. It allows you to send notifications to your phone or desktop via scripts from any computer, entirely without signup or cost. It's also open source (as you can plainly see) if you want to run your own.

I run a free version of it at ntfy.sh, and there's an open source Android app too.

Documentation

Getting started | Android/iOS | API | Install / Self-hosting | Building

Contributing

I welcome any and all contributions. Just create a PR or an issue.

Contact me

You can directly contact me on Discord or on Matrix (bridged from Discord), or via the GitHub issues, or find more contact information on my website.

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:

github.com/urfave/cli/v2 (MIT) is used to drive the CLI
Mixkit sounds (Mixkit Free License) are used as notification sounds
Sounds from notificationsounds.com (Creative Commons Attribution) are used as notification sounds
Roboto Font (Apache 2.0) is used as a font in everything web
React (MIT) is used for the web app
Material UI components (MIT) are used in the web app
MUI dashboard template (MIT) was used as a basis for the web app
Dexie.js (Apache 2.0) is used for web app persistence in IndexedDB
GoReleaser (MIT) is used to create releases
go-smtp (MIT) is used to receive e-mails
stretchr/testify (MIT) is used for unit and integration tests
github.com/mattn/go-sqlite3 (MIT) is used to provide the persistent message cache
Firebase Admin SDK (Apache 2.0) is used to send FCM messages
github/gemoji (MIT) is used for emoji support (specifically the emoji.json file)
Lightbox with vanilla JS as a lightbox on the landing page
HTTP middleware for gzip compression (MIT) is used for serving static files
Regex for auto-linking (MIT) is used to highlight links (the library is not used)
Statically linking go-sqlite3
Linked tabs in mkdocs