laravel-websockets/config/websockets.php

160 lines
5.2 KiB
PHP
Raw Normal View History

2018-11-22 22:55:39 +00:00
<?php
return [
/*
2020-08-13 10:22:58 +00:00
|--------------------------------------------------------------------------
| Dashboard Settings
|--------------------------------------------------------------------------
|
| You can configure the dashboard settings from here.
|
*/
'dashboard' => [
2020-08-13 10:22:58 +00:00
'port' => env('LARAVEL_WEBSOCKETS_PORT', 6001),
2020-08-13 10:22:58 +00:00
'path' => 'laravel-websockets',
'middleware' => [
'web',
\BeyondCode\LaravelWebSockets\Dashboard\Http\Middleware\Authorize::class,
],
],
'managers' => [
/*
|--------------------------------------------------------------------------
| Application Manager
|--------------------------------------------------------------------------
|
| An Application manager determines how your websocket server allows
| the use of the TCP protocol based on, for example, a list of allowed
| applications.
| By default, it uses the defined array in the config file, but you can
| anytime implement the same interface as the class and add your own
| custom method to retrieve the apps.
|
*/
'app' => \BeyondCode\LaravelWebSockets\Apps\ConfigAppProvider::class,
/*
|--------------------------------------------------------------------------
| Channel Manager
|--------------------------------------------------------------------------
|
| When users subscribe or unsubscribe from specific channels,
| the connections are stored to keep track of any interaction with the
| WebSocket server.
| You can however add your own implementation that will help the store
| of the channels alongside their connections.
|
*/
'channel' => \BeyondCode\LaravelWebSockets\WebSockets\Channels\ChannelManagers\ArrayChannelManager::class,
],
2018-12-04 19:27:52 +00:00
/*
2018-11-24 00:25:40 +00:00
* This package comes with multi tenancy out of the box. Here you can
2018-12-01 13:17:32 +00:00
* configure the different apps that can use the webSockets server.
2018-11-23 21:46:09 +00:00
*
* Optionally you specify capacity so you can limit the maximum
* concurrent connections for a specific app.
*
2018-12-01 14:47:55 +00:00
* Optionally you can disable client events so clients cannot send
2018-12-04 19:27:52 +00:00
* messages to each other via the webSockets.
2018-11-24 00:25:40 +00:00
*/
2018-12-01 12:57:02 +00:00
'apps' => [
2018-11-24 00:25:40 +00:00
[
2018-12-01 12:57:02 +00:00
'id' => env('PUSHER_APP_ID'),
2018-11-24 22:52:55 +00:00
'name' => env('APP_NAME'),
2018-12-01 12:57:02 +00:00
'key' => env('PUSHER_APP_KEY'),
2018-12-01 14:47:55 +00:00
'secret' => env('PUSHER_APP_SECRET'),
'path' => env('PUSHER_APP_PATH'),
'capacity' => null,
2018-12-01 15:24:36 +00:00
'enable_client_messages' => false,
2018-12-03 10:58:42 +00:00
'enable_statistics' => true,
2018-11-24 00:25:40 +00:00
],
2018-11-23 21:46:09 +00:00
],
2018-11-26 07:51:59 +00:00
/*
* This array contains the hosts of which you want to allow incoming requests.
2018-12-04 19:27:52 +00:00
* Leave this empty if you want to accept requests from all hosts.
2018-11-26 07:51:59 +00:00
*/
2018-12-01 14:53:41 +00:00
'allowed_origins' => [
2018-11-26 22:03:13 +00:00
//
2018-11-26 07:51:59 +00:00
],
2018-11-24 22:52:55 +00:00
2018-11-27 14:55:30 +00:00
/*
2018-12-03 08:09:41 +00:00
* The maximum request size in kilobytes that is allowed for an incoming WebSocket request.
2018-11-27 14:55:30 +00:00
*/
2018-12-01 14:53:41 +00:00
'max_request_size_in_kb' => 250,
2018-11-27 14:55:30 +00:00
2018-12-04 09:06:26 +00:00
/*
2020-08-13 10:22:58 +00:00
* Define the optional SSL context for your WebSocket connections.
* You can see all available options at: http://php.net/manual/en/context.ssl.php
2018-12-04 09:06:26 +00:00
*/
2020-08-13 10:22:58 +00:00
'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),
2018-12-04 09:06:26 +00:00
2020-08-13 10:22:58 +00:00
/*
* 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),
],
2018-12-04 19:27:52 +00:00
'statistics' => [
2020-08-13 10:22:58 +00:00
2018-12-04 19:27:52 +00:00
/*
* 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.
*/
2020-08-13 10:22:58 +00:00
'logger' => \BeyondCode\LaravelWebSockets\Statistics\Logger::class,
2018-12-04 19:27:52 +00:00
/*
* Here you can specify the interval in seconds at which statistics should be logged.
*/
2020-08-13 10:22:58 +00:00
2018-12-04 19:27:52 +00:00
'interval_in_seconds' => 60,
/*
* When the clean-command is executed, all recorded statistics older than
* the number of days specified here will be deleted.
*/
2020-08-13 10:22:58 +00:00
2018-12-04 21:22:33 +00:00
'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.
*/
2018-11-26 07:51:59 +00:00
2020-08-13 10:22:58 +00:00
'perform_dns_lookup' => false,
2018-11-26 07:51:59 +00:00
],
2018-12-04 19:27:52 +00:00
];