8889841cPK!€[Ò è±YYintroduction.mdnuW+A„¶--- title: Introduction order: 1 --- # Laravel WebSockets 🛰 WebSockets for Laravel. Done right. Laravel WebSockets is a package for Laravel 5.7 and up that will get your application started with WebSockets in no-time! It has a drop-in Pusher API replacement, has a debug dashboard, realtime statistics and even allows you to create custom WebSocket controllers. Once installed, you can start it with one simple command: ```php php artisan websockets:serve ``` --- If you want to know how all of it works under the hood, we wrote an in-depth [blogpost](https://murze.be/introducing-laravel-websockets-an-easy-to-use-websocket-server-implemented-in-php) about it. To help you get started, you can also take a look at the [demo repository](https://github.com/beyondcode/laravel-websockets-demo), that implements a basic Chat built with this package.PK!€[ä·”ƒââquestions-issues.mdnuW+A„¶--- title: Questions and issues order: 3 --- # Questions and issues Find yourself stuck using the package? Found a bug? Do you have general questions or suggestions for improving laravel-websockets? Feel free to create an issue on [GitHub](https://github.com/beyondcode/laravel-websockets/issues), we'll try to address it as soon as possible. If you've found a bug regarding security please mail [marcel@beyondco.de](mailto:marcel@beyondco.de) instead of using the issue tracker.PK!€[$šÎôôinstallation.mdnuW+A„¶--- title: Installation order: 2 --- # Installation Laravel WebSockets can be installed via composer: ```bash composer require beyondcode/laravel-websockets ``` The package will automatically register a service provider. This package comes with a migration to store statistic information while running your WebSocket server. You can publish the migration file using: ```bash php artisan vendor:publish --provider="BeyondCode\LaravelWebSockets\WebSocketsServiceProvider" --tag="migrations" ``` Run the migrations with: ```bash php artisan migrate ``` Next, you need to publish the WebSocket configuration file: ```bash php artisan vendor:publish --provider="BeyondCode\LaravelWebSockets\WebSocketsServiceProvider" --tag="config" ``` This is the default content of the config file that will be published as `config/websockets.php`: ```php return [ /* * Set a custom dashboard configuration */ 'dashboard' => [ 'port' => env('LARAVEL_WEBSOCKETS_PORT', 6001), ], /* * This package comes with multi tenancy out of the box. Here you can * configure the different apps that can use the webSockets server. * * Optionally you specify capacity so you can limit the maximum * concurrent connections for a specific app. * * Optionally you can disable client events so clients cannot send * messages to each other via the webSockets. */ 'apps' => [ [ 'id' => env('PUSHER_APP_ID'), 'name' => env('APP_NAME'), 'key' => env('PUSHER_APP_KEY'), 'secret' => env('PUSHER_APP_SECRET'), 'path' => env('PUSHER_APP_PATH'), 'capacity' => null, 'enable_client_messages' => false, 'enable_statistics' => true, ], ], /* * This class is responsible for finding the apps. The default provider * will use the apps defined in this config file. * * You can create a custom provider by implementing the * `AppProvider` interface. */ 'app_provider' => BeyondCode\LaravelWebSockets\Apps\ConfigAppProvider::class, /* * This array contains the hosts of which you want to allow incoming requests. * Leave this empty if you want to accept requests from all hosts. */ 'allowed_origins' => [ // ], /* * The maximum request size in kilobytes that is allowed for an incoming WebSocket request. */ 'max_request_size_in_kb' => 250, /* * This path will be used to register the necessary routes for the package. */ 'path' => 'laravel-websockets', /* * Dashboard Routes Middleware * * These middleware will be assigned to every dashboard route, giving you * the chance to add your own middleware to this list or change any of * the existing middleware. Or, you can simply stick with this list. */ 'middleware' => [ 'web', Authorize::class, ], 'statistics' => [ /* * This model will be used to store the statistics of the WebSocketsServer. * The only requirement is that the model should extend * `WebSocketsStatisticsEntry` provided by this package. */ 'model' => \BeyondCode\LaravelWebSockets\Statistics\Models\WebSocketsStatisticsEntry::class, /** * The Statistics Logger will, by default, handle the incoming statistics, store them * and then release them into the database on each interval defined below. */ 'logger' => BeyondCode\LaravelWebSockets\Statistics\Logger\HttpStatisticsLogger::class, /* * Here you can specify the interval in seconds at which statistics should be logged. */ 'interval_in_seconds' => 60, /* * When the clean-command is executed, all recorded statistics older than * the number of days specified here will be deleted. */ 'delete_statistics_older_than_days' => 60, /* * Use an DNS resolver to make the requests to the statistics logger * default is to resolve everything to 127.0.0.1. */ 'perform_dns_lookup' => false, ], /* * Define the optional SSL context for your WebSocket connections. * You can see all available options at: http://php.net/manual/en/context.ssl.php */ 'ssl' => [ /* * Path to local certificate file on filesystem. It must be a PEM encoded file which * contains your certificate and private key. It can optionally contain the * certificate chain of issuers. The private key also may be contained * in a separate file specified by local_pk. */ 'local_cert' => env('LARAVEL_WEBSOCKETS_SSL_LOCAL_CERT', null), /* * Path to local private key file on filesystem in case of separate files for * certificate (local_cert) and private key. */ 'local_pk' => env('LARAVEL_WEBSOCKETS_SSL_LOCAL_PK', null), /* * Passphrase for your local_cert file. */ 'passphrase' => env('LARAVEL_WEBSOCKETS_SSL_PASSPHRASE', null), ], /* * Channel Manager * This class handles how channel persistence is handled. * By default, persistence is stored in an array by the running webserver. * The only requirement is that the class should implement * `ChannelManager` interface provided by this package. */ 'channel_manager' => \BeyondCode\LaravelWebSockets\WebSockets\Channels\ChannelManagers\ArrayChannelManager::class, ]; ``` PK!€[K¬#(( _index.mdnuW+A„¶--- title: Getting Started order: 1 --- PK!€[Ò è±YYintroduction.mdnuW+A„¶PK!€[ä·”ƒââ˜questions-issues.mdnuW+A„¶PK!€[$šÎôô½installation.mdnuW+A„¶PK!€[K¬#(( ð_index.mdnuW+A„¶PK:Q