forked from denis660/laravel-centrifugo
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
db3ab66
commit 8e8cae0
Showing
1 changed file
with
151 additions
and
148 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,148 +1,151 @@ | ||
| <p align="center">Documentation <b>EN</b> | <a href="https://github.com/denis660/laravel-centrifuge/blob/master/README_RU.md">RU</a></p> | ||
|
|
||
| <h1 align="center">Laravel + Centrifugo</h1> | ||
| <h2 align="center">Centrifugo broadcast driver for Laravel 8.75.0 - 11 </h2> | ||
|
|
||
| <p align="center"> | ||
| <a href="https://scrutinizer-ci.com/g/denis660/laravel-centrifugo"><img src="https://scrutinizer-ci.com/g/denis660/laravel-centrifugo/badges/quality-score.png?b=master" alt="Build Status"></a> | ||
| <a href="https://github.com/denis660/laravel-centrifugo/releases"><img src="https://img.shields.io/github/release/denis660/laravel-centrifugo.svg?style=flat-square" alt="Latest Version"></a> | ||
| <a href="https://scrutinizer-ci.com/g/denis660/laravel-centrifugo"><img src="https://img.shields.io/scrutinizer/g/denis660/laravel-centrifugo.svg?style=flat-square" alt="Quality Score"></a> | ||
| <a href="https://github.styleci.io/repos/324202212"><img src="https://github.styleci.io/repos/324202212/shield?branch=master" alt="StyleCI"></a> | ||
| <a href="https://packagist.org/packages/denis660/laravel-centrifugo"><img src="https://img.shields.io/packagist/dt/denis660/laravel-centrifugo.svg?style=flat-square" alt="Total Downloads"></a> | ||
| <a href="https://github.com/denis660/Centrifuge/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="Software License"></a> | ||
| </p> | ||
|
|
||
| ## Introduction | ||
| Centrifugo broadcaster for laravel , based on: | ||
| - [LaraComponents/centrifugo-broadcaster](https://github.com/LaraComponents/centrifugo-broadcaster) | ||
| - [centrifugal/phpcent](https://github.com/centrifugal/phpcent) | ||
|
|
||
| ## Features | ||
| - Compatible with latest [Centrifugo 3.2.0](https://github.com/centrifugal/centrifugo/releases/tag/v3.2.0) 🚀 | ||
| - Wrapper over [Centrifugo HTTP API](https://centrifugal.dev/docs/server/server_api) 🔌 | ||
| - Authentication with JWT token (HMAC algorithm) for anonymous, authenticated user and private channel 🗝️ | ||
|
|
||
| ## Requirements | ||
| - PHP >= 7.4 , 8.0, 8.1 | ||
| - Laravel 8.75.0 - 11.0 | ||
| - guzzlehttp/guzzle 6 - 7 | ||
| - Centrifugo Server 3.2.0 or newer (see [here](https://github.com/centrifugal/centrifugo)) | ||
|
|
||
| ## Installation | ||
|
|
||
| Require this package with composer: | ||
|
|
||
| ```bash | ||
| composer req denis660/laravel-centrifugo | ||
| ``` | ||
|
|
||
|
|
||
| Open your config/app.php and add the following to the providers array: | ||
|
|
||
| ```php | ||
| 'providers' => [ | ||
| // And uncomment BroadcastServiceProvider | ||
| App\Providers\BroadcastServiceProvider::class, | ||
| ], | ||
| ``` | ||
|
|
||
| Open your config/broadcasting.php and add new connection like this: | ||
|
|
||
| ```php | ||
| '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 | ||
| ``` | ||
|
|
||
| ## Basic Usage | ||
|
|
||
| To configure Centrifugo server, read [official documentation](https://centrifugal.dev) | ||
|
|
||
| For broadcasting events, see [official documentation of laravel](https://laravel.com/docs/8.x/broadcasting) | ||
|
|
||
| A simple client usage example: | ||
|
|
||
| ```php | ||
| <?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'); | ||
|
|
||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### Available methods | ||
|
|
||
| | 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. | | ||
|
|
||
| ## License | ||
|
|
||
| The MIT License (MIT). Please see [License File](https://github.com/denis660/laravel-centrifugo/blob/master/LICENSE for more information. | ||
| <p align="center">Documentation <b>EN</b> | <a href="https://github.com/denis660/laravel-centrifuge/blob/master/README_RU.md">RU</a></p> | ||
|
|
||
| <h1 align="center">Laravel + Centrifugo</h1> | ||
| <h2 align="center">Centrifugo broadcast driver for Laravel 8.75.0 - 11 </h2> | ||
|
|
||
| <p align="center"> | ||
| <a href="https://scrutinizer-ci.com/g/denis660/laravel-centrifugo"><img src="https://scrutinizer-ci.com/g/denis660/laravel-centrifugo/badges/quality-score.png?b=master" alt="Build Status"></a> | ||
| <a href="https://github.com/denis660/laravel-centrifugo/releases"><img src="https://img.shields.io/github/release/denis660/laravel-centrifugo.svg?style=flat-square" alt="Latest Version"></a> | ||
| <a href="https://scrutinizer-ci.com/g/denis660/laravel-centrifugo"><img src="https://img.shields.io/scrutinizer/g/denis660/laravel-centrifugo.svg?style=flat-square" alt="Quality Score"></a> | ||
| <a href="https://github.styleci.io/repos/324202212"><img src="https://github.styleci.io/repos/324202212/shield?branch=master" alt="StyleCI"></a> | ||
| <a href="https://packagist.org/packages/denis660/laravel-centrifugo"><img src="https://img.shields.io/packagist/dt/denis660/laravel-centrifugo.svg?style=flat-square" alt="Total Downloads"></a> | ||
| <a href="https://github.com/denis660/Centrifuge/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="Software License"></a> | ||
| </p> | ||
|
|
||
| ## Introduction | ||
| Centrifugo broadcaster for laravel , based on: | ||
| - [LaraComponents/centrifugo-broadcaster](https://github.com/LaraComponents/centrifugo-broadcaster) | ||
| - [centrifugal/phpcent](https://github.com/centrifugal/phpcent) | ||
|
|
||
| Test based on: | ||
| - [Opekunov/laravel-centrifugo-broadcaster](https://github.com/Opekunov/laravel-centrifugo-broadcaster) | ||
|
|
||
| ## Features | ||
| - Compatible with latest [Centrifugo 4](https://github.com/centrifugal/centrifugo/releases/tag/v4.1.5) 🚀 | ||
| - Wrapper over [Centrifugo HTTP API](https://centrifugal.dev/docs/server/server_api) 🔌 | ||
| - Authentication with JWT token (HMAC algorithm) for anonymous, authenticated user and private channel 🗝️ | ||
|
|
||
| ## Requirements | ||
| - PHP >= 7.4 , 8.0, 8.1 | ||
| - Laravel 8.75.0 - 11.0 | ||
| - guzzlehttp/guzzle 6 - 7 | ||
| - Centrifugo Server 4 or newer (see [here](https://github.com/centrifugal/centrifugo)) | ||
|
|
||
| ## Installation | ||
|
|
||
| Require this package with composer: | ||
|
|
||
| ```bash | ||
| composer req denis660/laravel-centrifugo | ||
| ``` | ||
|
|
||
|
|
||
| Open your config/app.php and add the following to the providers array: | ||
|
|
||
| ```php | ||
| 'providers' => [ | ||
| // And uncomment BroadcastServiceProvider | ||
| App\Providers\BroadcastServiceProvider::class, | ||
| ], | ||
| ``` | ||
|
|
||
| Open your config/broadcasting.php and add new connection like this: | ||
|
|
||
| ```php | ||
| '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 | ||
| ``` | ||
|
|
||
| ## Basic Usage | ||
|
|
||
| To configure Centrifugo server, read [official documentation](https://centrifugal.dev) | ||
|
|
||
| For broadcasting events, see [official documentation of laravel](https://laravel.com/docs/8.x/broadcasting) | ||
|
|
||
| A simple client usage example: | ||
|
|
||
| ```php | ||
| <?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'); | ||
|
|
||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### Available methods | ||
|
|
||
| | 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. | | ||
|
|
||
| ## License | ||
|
|
||
| The MIT License (MIT). Please see [License File](https://github.com/denis660/laravel-centrifugo/blob/master/LICENSE for more information. |