Merge pull request #542 from authanram/master

Update docs

Author: rennokki

docs/getting-started/installation.md

@@ -36,10 +36,20 @@ This is the default content of the config file that will be published as  `confi
 ```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.
      */
@@ -49,6 +59,8 @@ return [
             '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,
         ],
@@ -81,6 +93,18 @@ return [
      */
     '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.
@@ -89,6 +113,12 @@ return [
          */
         '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.
          */
@@ -99,7 +129,7 @@ return [
          * 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.
@@ -118,18 +148,27 @@ return [
          * certificate chain of issuers. The private key also may be contained
          * in a separate file specified by local_pk.
          */
-        'local_cert' => null,
+        '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' => null,
+        'local_pk' => env('LARAVEL_WEBSOCKETS_SSL_LOCAL_PK', null),
 
         /*
          * Passphrase for your local_cert file.
          */
-        'passphrase' => null
+        '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,
 ];
 ```