PHPackages elementworks/pusher-helper - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. elementworks/pusher-helper ActiveCraft-plugin[Utility & Helpers](/categories/utility) elementworks/pusher-helper ========================== Support functionality for Pusher 1.0.8(5y ago)1115proprietaryPHP Since Nov 6Pushed 5y ago1 watchersCompare [ Source](https://github.com/elementworks/pusher-helper)[ Packagist](https://packagist.org/packages/elementworks/pusher-helper)[ RSS](/packages/elementworks-pusher-helper/feed)WikiDiscussions main Synced today READMEChangelogDependencies (2)Versions (10)Used By (0) Pusher Helper plugin for Craft CMS 3.x ====================================== [](#pusher-helper-plugin-for-craft-cms-3x) Support functionality for Pusher Requirements ------------ [](#requirements) This plugin requires Craft CMS 3.0.0-beta.23 or later. Installation ------------ [](#installation) To install the plugin, follow these instructions. 1. Open your terminal and go to your Craft project: ``` cd /path/to/project ``` 2. Then tell Composer to load the plugin: ``` composer require elementworks/pusher-helper ``` 3. In the Control Panel, go to Settings → Plugins and click the “Install” button for Pusher Helper. Pusher Helper Overview ---------------------- [](#pusher-helper-overview) This plugin provides boilerplate backend support for Pusher to CraftCMS, including: - The ability to authenticate to private channels. - Support for large presence implementations using a pull-based approach as described here: - Support for message chunking to allow for messages greater than 10kb to be sent to 'global' presence channel using technique outlined here: There is no front-end code provided by this plugin. You will need to write your own front-end implementation to suit your own requirements. Configuring Pusher Helper ------------------------- [](#configuring-pusher-helper) Copy the `config.php` file in the `src` directory of the plugin into the `config` directory of your project, rename it `pusher-helper.php` and add the settings you need for your project. You are strongly advised to use environment variables for the Pusher settings. Add the following environment variables to your `.env` file in all environments: - `PUSHER_APP_ID` - `PUSHER_KEY` - `PUSHER_SECRET` - `PUSHER_CLUSTER` `PUSHER_CLUSTER` defaults to `eu` if not otherwise specified. The other Pusher API parameters are required for the plugin to work. The `globalChannel` config setting is the name of the global presence channel as described here: and must start with `private-`. The `userFields` config setting determines what fields on a user object will be included in the presence messages sent out on the global presence channel. These can include any valid fields defined on users in your project. They can be used to populate a who's online list, so think about what information you might want to include on there, remembering it is best to keep this as brief as possible to limit the number and size of messages sent. Pusher imposes a 10kb limit on messages, so the messages sent on the global presence channel will be chunked if they are above this. Using Pusher Helper ------------------- [](#using-pusher-helper) Install and configure the plugin as described above. You are responsible for providing the following to make this work: - All front-end javascript using the `pusher.js` library to authenticate users and receive and process messages from the global presence channel. The plugin provides no code for the front-end of your site and will not function without it. - Set up a cron job on your server to ping `./craft pusher-helper/pusher/send-presence-state` at 1 minute intervals to update the presence state on the global presence channel. Pusher Helper Roadmap --------------------- [](#pusher-helper-roadmap) Some things to do, and ideas for potential features: - Release it Brought to you by [Element Works Ltd](https://elementworks.co.uk) ### Health Score 27 — LowBetter than 46% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity11 Limited adoption so far Community7 Small or concentrated contributor base Maturity60 Established project with proven stability Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~2 days Total 8 Last Release 2097d ago ### Community Maintainers ![](https://avatars.githubusercontent.com/u/74006400?v=4)[Element Works Ltd](/maintainers/elementworks)[@elementworks](https://github.com/elementworks) --- Top Contributors [![steverowling](https://avatars.githubusercontent.com/u/4478560?v=4)](https://github.com/steverowling "steverowling (40 commits)") --- Tags cmsCraftcraftcmscraft-pluginpusher helper ### Embed Badge ![Health badge](/badges/elementworks-pusher-helper/health.svg) ``` [![Health](https://phpackages.com/badges/elementworks-pusher-helper/health.svg)](https://phpackages.com/packages/elementworks-pusher-helper) ``` ### Alternatives [verbb/formie The most user-friendly forms plugin for Craft. 101400.6k78](/packages/verbb-formie)[nystudio107/craft-seomatic SEOmatic facilitates modern SEO best practices & implementation for Craft CMS 5. It is a turnkey SEO system that is comprehensive, powerful, and flexible. 1741.5M73](/packages/nystudio107-craft-seomatic)[verbb/hyper A user-friendly links field for Craft. 24153.5k14](/packages/verbb-hyper)[verbb/vizy A flexible visual editor field for Craft. 4251.5k1](/packages/verbb-vizy)[verbb/comments Add comments to your site. 13754.0k1](/packages/verbb-comments)[verbb/navigation Create navigation menus for your site. 90711.5k20](/packages/verbb-navigation) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)