syntaxoops / web-notifications
Send browser push notifications from TYPO3
Package info
github.com/SyntaxOops/web_notifications
Type:typo3-cms-extension
pkg:composer/syntaxoops/web-notifications
Requires
- php: ^8.2
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- ext-openssl: *
- minishlink/web-push: ^10.1
- typo3/cms-backend: ^13.4 || ^14.3
- typo3/cms-core: ^13.4 || ^14.3
- typo3/cms-extbase: ^13.4 || ^14.3
- typo3/cms-fluid: ^13.4 || ^14.3
- typo3/cms-frontend: ^13.4 || ^14.3
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.95
- php-parallel-lint/php-parallel-lint: ^1.4
- phpstan/phpstan: ^2.1
- typo3/coding-standards: ^0.8
Suggests
- typo3/cms-scheduler: Run notification delivery as a scheduled TYPO3 task
Replaces
- typo3-ter/web-notifications: 1.0.1
README
Web Push subscriptions and notification delivery for TYPO3 13.4 LTS and TYPO3 14.3+.
Requirements
- PHP 8.2+
- PHP extensions
curl,mbstring, andopenssl
Installation
composer require syntaxoops/web-notifications vendor/bin/typo3 extension:setup --extension=web_notifications
Add the Site Set syntaxoops/web-notifications to the site dependencies.
Configuration
Generate and store the VAPID key pair:
vendor/bin/typo3 webnotifications:vapid:generate
An existing key pair is kept unchanged.
Create a sysfolder below the site root and add notification records to it. Visit the HTTPS frontend and allow browser notifications to register the device.
The default icon and image dimensions can be changed in the Site Settings.
Sending notifications
Pass the notification sysfolder UID to the command:
vendor/bin/typo3 webnotifications:send 123
Run this command manually or through TYPO3 Scheduler's Execute console commands task.
Development
composer install composer ci
The install command activates .githooks/pre-commit.
License
GPL-2.0-or-later. See LICENSE.