ewert/neos-webpush

This package provides a backend module to manage and send Web Push Notifications

1.0.0 2019-08-02 15:44 UTC

Requires

• minishlink/web-push: ^5.2
• neos/flow: *
• neos/neos: ~3.0 || ~4.0 || dev-master

MIT

README

This package provides a backend module to manage and send Web Push Notifications.

Installation

1. Run the following command in your site package

   composer require ewert/neos-webpush --no-update

2. Then run composer update in your projects root folder.

3. Run the following command to migrate your database ./flow doctrine:migrate

4. Finally you can add the WebPushAdministrator role to the users who need access to the new backend module.

Configuration

Browsers need to verify your identity. A standard called VAPID can authenticate you for all browsers.
You'll need to create and provide a public and private key for your server.
These keys must be safely stored and should not change.

When you open up the Backend Module for the first time, an example configuration like the following with autogenerated keys will be created for you.

Ewert:
  WebPush:
    vapid:
      publicKey: ''
      privateKey: ''

Asking the users for Permission

To be able to send some messages to your users, you have to first ask them for permission.
To do that, you just have to call the following JavaScript function:

window.EwertWebPush.requestPermission();

Screenshots

Overview:

New Message