web-push-libs / web-push-elixir

Simple web push library for Elixir

Web Push Elixir

Simple web push library for Elixir

Prerequisities

• Elixir 1.15
• OTP 24 / 25 / 26

Installation

1. Add web_push_elixir to your list of dependencies in mix.exs:

def deps do
  [
    {:web_push_elixir, "~> 0.2.0"}
  ]
end

2. Run mix command to generate your Vapid public and private keys:

mix generate.vapid.keys

3. Set environment variables for your generated keys:

environment:
  - VAPID_PUBLIC_KEY=someVapidPublicKey
  - VAPID_PRIVATE_KEY=someVapidPrivateKey
  - VAPID_SUBJECT=mailto:[email protected]

Usage

WebPushElixir provides a simple send_notification/2 function that accepts 2 arguments:

• subscription: the subscription information received from the client - example demo
• message: the message string.

subscription = '{"endpoint":"https://some-push-service","keys":{"p256dh":"BNcRdreALRFXTkOOUHK1EtK2wtaz5Ry4YfYCA_0QTpQtUbVlUls0VJXg7A8u-Ts1XbjhazAkj7I99e8QcYP7DkM=","auth":"tBHItJI5svbpez7KI4CCXg=="}}'
message = "Some message"

WebPushElixir.send_notification(subscription, message)

For more information on how to subscribe a client, permission UX and more - take a look at https://web.dev/notifications/

Run tests

mix test

License

Web Push Elixir is open-sourced software licensed under the MIT license.

Credits

Heavily inspired by elixir-web-push-encryption