fresh / centrifugo-bundle
Provides communication with web-socket server Centrifugo in Symfony applications.
Fund package maintenance!
fre5h
Installs: 57 818
Dependents: 0
Suggesters: 0
Security: 0
Stars: 65
Watchers: 2
Forks: 4
Open Issues: 3
Type:symfony-bundle
Requires
- php: >=8.1
- fresh/datetime: ^2.0
- symfony/config: ~6.1
- symfony/console: ~6.1
- symfony/dependency-injection: ~6.1
- symfony/framework-bundle: ~6.1
- symfony/http-client: ~6.1
- symfony/http-foundation: ~6.1
- symfony/http-kernel: ~6.1
- symfony/security-core: ~6.1
- symfony/validator: ~6.1
Requires (Dev)
README
📦 Provides communication with web-socket server Centrifugo in Symfony applications.
Features 🎁
- Compatible with latest Centrifugo 2.8.6 🚀
- Wrapper over Centrifugo HTTP API 🔌
- Authentication with JWT token (HMAC algorithm) for anonymous, authenticated user and private channel 🗝️
- Batch request in JSON streaming format 💪
- Console commands ⚒️️
- Integration into Symfony Web-Profiler 🎛️
Requirements 🧐
- PHP 8.1
- Symfony 6.1
Installation 🌱
$ composer req fresh/centrifugo-bundle
By default, Symfony Flex adds this bundle to the config/bundles.php
file and adds required environment variables into .env
file.
In case when you ignored contrib-recipe
during bundle installation it would not be done. Then you have to do this manually.
Check the config/bundles.php
file
# config/bundles.php return [ // Other bundles... Fresh\CentrifugoBundle\FreshCentrifugoBundle::class => ['all' => true], // Other bundles... ];
Check the .env
file and add you configuration
# .env ###> fresh/centrifugo-bundle ### CENTRIFUGO_API_KEY=secret-api-key CENTRIFUGO_API_ENDPOINT=http://localhost:8000/api CENTRIFUGO_SECRET=secret ###< fresh/centrifugo-bundle ###
ℹ️ Customize bundle configuration
Using 🧑🎓
Centrifugo service
<?php declare(strict_types=1); namespace App\Service; use Fresh\CentrifugoBundle\Service\CentrifugoInterface; class YourService { private CentrifugoInterface $centrifugo; public function __construct(CentrifugoInterface $centrifugo) { $this->centrifugo = $centrifugo; } public function example(): void { $this->centrifugo->publish(['foo' => 'bar'], 'channelA'); } }
ℹ️ More examples of using Centrifugo service
Authentication with JWT tokens 🗝️
Console commands ⚒️
centrifugo:publish
centrifugo:broadcast
centrifugo:unsubscribe
centrifugo:disconnect
centrifugo:presence
centrifugo:presence-stats
centrifugo:history
centrifugo:history-remove
centrifugo:channels
centrifugo:info
ℹ️ More examples of using console commands
Integration into Symfony Web-Profiler 🎛️
Contributing 🤝
Read the CONTRIBUTING file.