laravel 11 websockets

Level 58

As of my knowledge cutoff in October 2023, Laravel 11 has not been released yet, so I will provide a solution based on Laravel 10, which should be applicable to future versions as well.

If you're looking to implement WebSockets in a Laravel application without requiring an internet connection, you can use the beyondcode/laravel-websockets package. This package allows you to run a WebSocket server locally, which means it doesn't require an internet connection to function.

Here's a step-by-step guide to setting up laravel-websockets:

Install the Package:

First, you need to install the package via Composer:
```
composer require beyondcode/laravel-websockets
```

Publish the Configuration:

Publish the configuration file using the following Artisan command:

php artisan vendor:publish --provider="BeyondCode\LaravelWebSockets\WebSocketsServiceProvider" --tag="config"

Configure the WebSocket Server:

Open the config/websockets.php file and configure it according to your needs. You can set the host and port for the WebSocket server. By default, it runs on 127.0.0.1:6001.
Run the WebSocket Server:

You can start the WebSocket server using the following Artisan command:
```
php artisan websockets:serve
```

Broadcasting Configuration:

Ensure that your config/broadcasting.php is set up to use the pusher driver, as laravel-websockets is a drop-in replacement for Pusher:

'default' => env('BROADCAST_DRIVER', 'pusher'),

'connections' => [
    'pusher' => [
        'driver' => 'pusher',
        'key' => env('PUSHER_APP_KEY'),
        'secret' => env('PUSHER_APP_SECRET'),
        'app_id' => env('PUSHER_APP_ID'),
        'options' => [
            'cluster' => env('PUSHER_APP_CLUSTER'),
            'useTLS' => false,
            'host' => '127.0.0.1',
            'port' => 6001,
            'scheme' => 'http',
        ],
    ],
],

Environment Variables:

Update your .env file with the necessary Pusher credentials. These can be dummy values since you're running the server locally:
```
BROADCAST_DRIVER=pusher
PUSHER_APP_ID=local
PUSHER_APP_KEY=local
PUSHER_APP_SECRET=local
PUSHER_APP_CLUSTER=mt1
```

Frontend Setup:

Use Laravel Echo to listen for events on the frontend. Make sure to configure it to connect to your local WebSocket server:

import Echo from 'laravel-echo';

window.Pusher = require('pusher-js');

window.Echo = new Echo({
    broadcaster: 'pusher',
    key: process.env.MIX_PUSHER_APP_KEY,
    cluster: process.env.MIX_PUSHER_APP_CLUSTER,
    wsHost: window.location.hostname,
    wsPort: 6001,
    forceTLS: false,
    disableStats: true,
});

By following these steps, you should be able to set up a local WebSocket server using Laravel without requiring an internet connection.