Download the PHP package springboardvr/laravel-ably-broadcaster without Composer
On this page you can find all versions of the php package springboardvr/laravel-ably-broadcaster. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download springboardvr/laravel-ably-broadcaster
More information about springboardvr/laravel-ably-broadcaster
Files in springboardvr/laravel-ably-broadcaster
Package laravel-ably-broadcaster
Short Description An Ably broadcaster for Laravel
License MIT
Homepage https://github.com/springboardvr/laravel-ably-broadcaster
Informations about the package laravel-ably-broadcaster
Ably Broadcaster for Laravel
Adding support for the Ably broadcaster to Laravel! This uses the native Ably PHP SDK and adds a custom Laravel Broadcast Driver.
Installation
You can install the package via composer:
Configuration
Currently to use Ably with Laravel Echo in the frontend you need to enable the Pusher Protocol Support inside of your Abbly account.
- Go to Settings for your Application
- Enable Pusher protocol support under Protocol Adapter Settings
Once you've got that setup you can continue to configuring your Laravel application.
Change your default Broadcast driver name in config/broadcasting.php
Then you need to add Ably to your config/broadcasting.php
config file under connections
.
Then you need to update your .env
file with your Ably configuration details. The Key is available in the API Keys section of Ably. You need a key with full Privileges.
The ABLY_KEY
value will look something like g7CSSj.E08Odw:t2w2LkZ7OcR2Xk7S
For the MIX_ABLY_KEY
value you need to take everything before the :
in your ABLY_KEY
, like g7CSSj.E08Odw
Once you've got the Laravel side setup you also need to update Laravel Echo to use Ably! It keeps using the Pusher JS library but you use the Websocket Host that Ably provides.
That's it! Public, Private, and Presence channels will all work as with Pusher.
Testing
Limitations
- Currently in the frontend it is using the PusherJS library rather then the Ably library. We will be evaluating adding support for this library to Laravel Echo in the future.
- When you are broadcasting to multiple channels we aren't yet using the Bulk Publish endpoints. Once these are moved out of Beta we will update the library to support them.
- Limited testing! Needs to be expanded to cover the Auth functions.
Changelog
Please see CHANGELOG for more information what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
- Matthew Hall
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
All versions of laravel-ably-broadcaster with dependencies
ably/ably-php Version ^1.1
illuminate/support Version 5.7.* || 5.8.* || ^6.0 || ^7.0 || ^8.0
ext-json Version *