https://github.com/sarthakbagaria/web-push
Web Push library in Haskell.
https://github.com/sarthakbagaria/web-push
pushapi pushnotifications webpush
Last synced: 4 months ago
JSON representation
Web Push library in Haskell.
- Host: GitHub
- URL: https://github.com/sarthakbagaria/web-push
- Owner: sarthakbagaria
- License: mit
- Created: 2017-01-06T21:09:45.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2024-04-16T13:05:30.000Z (almost 2 years ago)
- Last Synced: 2025-10-21T13:49:44.277Z (4 months ago)
- Topics: pushapi, pushnotifications, webpush
- Language: Haskell
- Homepage:
- Size: 32.2 KB
- Stars: 12
- Watchers: 2
- Forks: 12
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# web-push [](https://hackage.haskell.org/package/web-push)
Helper functions to send messages using Web Push protocol.
## Usage
Guides to using Web Push API in browsers can be found on [Mozilla's](https://developer.mozilla.org/en/docs/Web/API/Push_API) and [Google's](https://developers.google.com/web/fundamentals/engage-and-retain/push-notifications/) docs, or you can check out the demo app in the example folder. To run the demo app:
cd example
stack build
stack --docker-network=bridge --docker-run-args='--publish=3000:3000' exec web-push-example
Then access localhost:3000 from a browser. Keep the browser console open to check if there are errors. For use with docker, the above command requires [stack](https://docs.haskellstack.org/en/stable/README/) 2.4 or above.
For production use, store a set of VAPID keys securely and use them for all push notification subscriptions and messages; public key will have to be exposed to client's browser when subscribing to push notifications, but private key must be kept secret and used when generating push notifications on the server. If VAPID keys are re-generated, all push notifications will require re-subscriptions. Also save the latest subscription details such as endpoint from user's browser session securely in the database and use them to send push notifications to the user later.
## References
Current implementation is based on the following versions of the drafts:
- [https://tools.ietf.org/html/draft-ietf-webpush-encryption-04](https://tools.ietf.org/html/draft-ietf-webpush-encryption-04)
- [https://tools.ietf.org/html/draft-ietf-httpbis-encryption-encoding-02](https://tools.ietf.org/html/draft-ietf-httpbis-encryption-encoding-02)
- [https://tools.ietf.org/html/draft-ietf-webpush-protocol-10](https://tools.ietf.org/html/draft-ietf-webpush-protocol-10)
- [https://tools.ietf.org/html/draft-ietf-webpush-vapid-01](https://tools.ietf.org/html/draft-ietf-webpush-vapid-01)