Documentation EN | RU
Centrifugo broadcaster for laravel , based on:
- Compatible with latest Centrifugo 3.2.0 ๐
- Wrapper over Centrifugo HTTP API ๐
- Authentication with JWT token (HMAC algorithm) for anonymous, authenticated user and private channel ๐๏ธ
- PHP >= 7.4 , 8.0, 8.1
- Laravel 8.75.0 - 10.0
- guzzlehttp/guzzle 6 - 7
- Centrifugo Server 3.2.0 or newer (see here)
Require this package with composer:
composer req denis660/laravel-centrifugo
Open your config/app.php and add the following to the providers array:
'providers' => [
// And uncomment BroadcastServiceProvider
App\Providers\BroadcastServiceProvider::class,
],
Open your config/broadcasting.php and add new connection like this:
'centrifugo' => [
'driver' => 'centrifugo',
'token_hmac_secret_key' => env('CENTRIFUGO_TOKEN_HMAC_SECRET_KEY',''),
'api_key' => env('CENTRIFUGO_API_KEY',''),
'url' => env('CENTRIFUGO_URL', 'http://localhost:8000'), // centrifugo api url
'verify' => env('CENTRIFUGO_VERIFY', false), // Verify host ssl if centrifugo uses this
'ssl_key' => env('CENTRIFUGO_SSL_KEY', null), // Self-Signed SSl Key for Host (require verify=true)
],
Also you should add these two lines to your .env file:
CENTRIFUGO_TOKEN_HMAC_SECRET_KEY=token_hmac_secret_key-from-centrifugo-config
CENTRIFUGO_API_KEY=api_key-from-centrifugo-config
CENTRIFUGO_URL=http://localhost:8000
These lines are optional:
CENTRIFUGO_SSL_KEY=/etc/ssl/some.pem
CENTRIFUGO_VERIFY=false
Don't forget to change BROADCAST_DRIVER
setting in .env file!
BROADCAST_DRIVER=centrifugo
To configure Centrifugo server, read official documentation
For broadcasting events, see official documentation of laravel
A simple client usage example:
<?php
declare(strict_types = 1);
namespace App\Http\Controllers;
use denis660\Centrifugo\Centrifugo;
use Illuminate\Support\Facades\Auth;
class ExampleController
{
public function example(Centrifugo $centrifugo)
{
// Send message into channel
$centrifugo->publish('news', ['message' => 'Hello world']);
// Generate connection token
$token = $centrifugo->generateConnectionToken((string)Auth::id(), 0, [
'name' => Auth::user()->name,
]);
// Generate private channel token
$apiSign = $centrifugo->generatePrivateChannelToken((string)Auth::id(), 'channel', time() + 5 * 60, [
'name' => Auth::user()->name,
]);
//Get a list of currently active channels.
$centrifugo->channels();
//Get channel presence information (all clients currently subscribed on this channel).
$centrifugo->presence('news');
}
}
Name | Description |
---|---|
publish(string $channel, array $data, $skipHistory = false) | Send message into channel. |
broadcast(array $channels, array $data, $skipHistory = false) | Send message into multiple channel. |
presence(string $channel) | Get channel presence information (all clients currently subscribed on this channel). |
presenceStats(string $channel) | Get channel presence information in short form (number of clients). |
history(string $channel, $limit = 0, $since = [], $reverse = false) | Get channel history information (list of last messages sent into channel). |
historyRemove(string $channel) | Remove channel history information. |
subscribe(string $channel, string $user, $client = '') | subscribe user from channel. |
unsubscribe(string $channel, string $user, string $client = '') | Unsubscribe user from channel. |
disconnect(string $user_id) | Disconnect user by it's ID. |
channels(string $pattern = '') | Get channels information (list of currently active channels). |
info() | Get stats information about running server nodes. |
generateConnectionToken(string $userId = '', int $exp = 0, array $info = [], array $channels = []) | Generate connection token. |
generatePrivateChannelToken(string $client, string $channel, int $exp = 0, array $info = []) | Generate private channel token. |
The MIT License (MIT). Please see [License File](https://github.com/denis660/laravel-centrifugo/blob/master/LICENSE for more information.