Skip to content

Installation

Overview · Configuration · Usage · FAQ · Developer notes

  • CS-Cart or Multi-Vendor 4.17.2 to 4.21.x, PHP 7.4 to 8.3.
  • PHP extensions openssl and curl (present on almost every host).
  • HTTPS on the storefront. Browsers allow push only on secure pages.
  • A cron job (recommended) for scheduled campaigns, product alerts after imports and large lists.
  1. Add-ons > Manage > upload kv_web_push-1.0.0.zip and install it.
  2. Enter the license key on the add-on page (License tab or the card at the top).
  3. The add-on creates the store’s VAPID key pair during installation. Nothing else to register.
  4. Open the storefront: from the page view and after the delay you set, the permission card appears.

Run every 5 minutes:

php /path/to/store/admin.php --dispatch=kv_web_push.cron

Over HTTP: https://your-store/admin.php?dispatch=kv_web_push.cron&cron_password=... with the cron password of Settings > Security. Without the cron job, a campaign saved with Send now goes out at once (as many messages as fit into about 20 seconds) and product alerts fired by an admin save go out at once; the rest waits for Send queue now.

Upload the new zip over the installed add-on, or use the Upgrade Center package. The built-in synchronizer adds new tables, settings and texts on the first admin page view; subscribers, campaigns and keys are kept.

Uninstalling deletes the subscribers, campaigns, alerts and keys. Subscribed browsers stop receiving messages; a later reinstall creates new keys and visitors subscribe again.