Download the PHP package qruto/laravel-wave without Composer

Bring live to your application

# Introduction Unlock the power of Laravel's [broadcasting system](https://laravel.com/docs/master/broadcasting) with **Wave**. Imagine that real-time server broadcasting is possible over native HTTP without any ~WebSockets~ setup. Meet the **[Server-sent Events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events)** 🛜 Works seamlessly with Laravel's default `redis` broadcasting driver and supports [Laravel Echo](https://github.com/laravel/echo). Experience it live with our [demo streaming tweets](https://wave.qruto.dev) 🐤. > Server-Sent Events (**SSE**) is specially tuned for real-time server-to-client > communication. _Compatible with_ [](https://laravel.com/docs/11.x/broadcasting) [](https://laravel.com/docs/11.x/octane) [](https://herd.laravel.com) ## 🌟 Key Features **⚡ Works with native Redis Driver**: Wave seamlessly integrates with Laravel's default `redis` broadcasting driver, ensuring efficient real-time data transfer. **🔄 Resume From Last**: Connection drops? No problem! Wave intelligently resumes the event stream from the last event, ensuring no crucial data is lost in transit. **🟢 Live Models**: With a simple interface that respects Laravel's native conventions for [Model Events Broadcasting](https://laravel.com/docs/master/broadcasting#model-broadcasting) and [Broadcast Notifications](https://laravel.com/docs/master/notifications#broadcast-notifications), Wave turbocharges your application with real-time updates.e **🍃 Resource-Friendly Broadcasting with `pauseInactive`**: This feature maximizes resource efficiency by closing the data stream when user inactive ( such as when the user minimizes the browser) and automatically reopens it upon resumption of visibility. Turned off by default. **🎛️️ Full Requests Control**: Wave hands you the reins over connection and authentication requests, granting you the freedom to shape your broadcasting setup to your exact requirements. ## Installation ### Laravel 11 or higher Install the package via Composer at first, then install broadcasting setup: ### Laravel 10 or lower Install **Wave** on both server and client sides using Composer and npm: Then, set your `.env` file to use the `redis` broadcasting driver: ## Usage After installing **Wave**, your server is ready to broadcast events. You can use it with **Echo** as usual or try `Wave` model API to work with predefined Eloquent events. In Laravel 11 or higher, after `install:broadcasting`, you will find: - broadcasting channel authorization file in `routes/channels.php` - broadcasting configuration file in `config/broadcasting.php` - echo instance in `resources/echo.js` - _(optional)_ **Wave** configuration file in `config/wave.php` ### Manual usage Import Laravel Echo with `WaveConnector` and pass it to the broadcaster option:

For Laravel 10 or lower, locate Echo connection configuration in resources/js/bootstrap.js file.

Use Echo as you typically would. 📞 [Receiving Broadcasts](https://laravel.com/docs/master/broadcasting#receiving-broadcasts) documentation. ### Use Live Eloquent Models With native conventions of [Model Events Broadcasting](https://laravel.com/docs/master/broadcasting#model-broadcasting) and [Broadcast Notifications](https://laravel.com/docs/master/notifications#broadcast-notifications) you can use **Wave** models to receive model events and notifications. Start by calling the `model` method on the `Wave` instance with the model name and key. By default, Wave prefixes model names with `App.Models` namespace. You can customize this with the `namespace` option: 📄 [Check out full Laravel Broadcasting documentation](https://laravel.com/docs/11.x/broadcasting) ## Configuration ### Client Options These options can be passed to the `Wave` or `Echo` instance: | Name | Type | Default | Description | |---------------|----------------------------------------------------------------------------------------|-------------------------|--------------------------------------------------------------------------------------------------------------------------------------| | endpoint | _string_ | `/wave` | Primary SSE connection route. | | namespace | _string_ | `App.Events` | Namespace of events to listen for. | | auth.headers | _object_ | `{}` | Additional authentication headers. | | authEndpoint | _string?_ | `/broadcasting/auth` | Authentication endpoint. | | csrfToken | _string?_ | `undefined` or `string` | CSRF token, defaults from `XSRF-TOKEN` cookie. | | bearerToken | _string?_ | `undefined` | Bearer tokenfor authentication. | | request | _[Request](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)?_ | `undefined` | Custom settings for connection and authentication requests. | | pauseInactive | _boolean_ | `false` | If `true`, closes connection when the page is hidden and reopens when visible. | | debug | _boolean_ | `false` | Toggles debug mode. If set to `true`, provides detailed event logs in the console, helping with event diagnosis and troubleshooting. | ### Server Options You can publish the Wave configuration file with: Here are the contents of the published configuration file: ## Persistent Connection with Nginx + PHP FPM Wave is designed to automatically reconnect after a request timeout. During reconnection, you won't lose any events because Wave stores event history for one minute by default and resumes it. You can adjust the duration of event history storage by modifying the `resume_lifetime` value in the config file. However, if you want to maintain a persistent connection, let's configure your web server. ### `fastcgi_read_timeout` By default, the `fastcgi_read_timeout` value is `60s` for Nginx + PHP FastCGI server setup. #### Option 1. Without changing the `fastcgi_read_timeout` value > Ensure that the interval between events pushed into Wave connection is shorter > than the read timeout value To enhance the certainty of events occurring more frequently than the standard timeout, Wave attempts to send a ping event with each Server-Sent Events (SSE) connection request, provided that the previous event occurred prior to the `ping.frequency` configuration value. If your application doesn't expect many real-time connections, specify the list of environments in which a ping event will be sent with each Wave connection. By default, this is set to `local`. #### Option 2. Manual ping control To ensure accurate frequency sending a ping event: 1. Disable automatic sending by changing the `ping.enable` config value to `false` 2. Use the `sse:ping` command to manually send a single ping or operate at an interval Run the command with the `--interval` option to send a ping event at a specified interval in seconds, for example let's send a ping event every `30s`: So, every `30s`, the command will send a ping event to all active connections and ensure that the connection remains persistent, because the frequency of sending events is less than `60s`. Alternatively, use the Laravel [Tasks scheduler](https://laravel.com/docs/master/scheduling#introduction) to send a ping event every minute or more often if `fastcgi_read_timeout` value is greater than `60s`: ### `request_terminate_timeout` Some platforms, such as [Laravel Forge](https://forge.laravel.com), configure the PHP FPM pool with `request_terminate_timeout = 60`, terminating all requests after `60s`. You can disable this in the `/etc/php/8.1/fpm/pool.d/www.conf` config file: or you can configure a separate pool for the SSE connection. ## Future Plans 📍 Local broadcasting driver 📥 📤 two ways live models syncing 📡 Something awesome with opened live abilities... ## Testing ## Support In light of recent events in Ukraine, my life has taken an unexpected turn. Since February 24th, I've lost my commercial work, my permanent residence, and my ability to plan for the future. During these challenging times, I derive strength and purpose from creating open source projects, such as Wave. [](https://github.com/sponsors/qruto) I welcome you to visit my [GitHub Sponsorships profile](https://github.com/sponsors/qruto). There, you can discover more about my current work, future ambitions, and aspirations. Every ⭐ you give brings joy to my day, and your sponsorship can make a profound difference in my ability to continue creating. I'm truly grateful for your support, whether it's a shout-out or a heartfelt " thank you". 💳 [Help directly](https://revolut.me/slavarazum). ## Changelog Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently. ## Contributing Please see [CONTRIBUTING](https://github.com/spatie/.github/blob/main/CONTRIBUTING.md) for details. ## Security Vulnerabilities Please review [our security policy](../../security/policy) on how to report security vulnerabilities. ## Credits - [Slava Razum](https://github.com/slavarazum) - [All Contributors](../../contributors) Package template based on [Spatie Laravel Skeleton](https://github.com/spatie/package-skeleton-laravel). ## License The MIT License (MIT). Please see [License File](LICENSE.md) for more information.