Laravel Cloud WebSockets

Introduction

Laravel Cloud offers a fully managed WebSocket infrastructure powered by Laravel Reverb clusters. Laravel Reverb is a Pusher-compatible WebSocket server that supports private channels, presence channels, client events, and more. Laravel and Symfony applications can connect to Reverb out of the box, and you may use Pusher’s SDKs to connect from PHP, JavaScript, Python, Go, Ruby, and Java applications. You can create Laravel Reverb powered WebSocket clusters directly from the Laravel Cloud dashboard, without an external account, and attach them to your application’s environments.

Laravel Reverb

Laravel Reverb is the open source, high-performance WebSocket server that powers Laravel Cloud’s WebSocket clusters. Because Reverb speaks the Pusher protocol, it can provide features like private and presence channels to any application with a Pusher-compatible client. When you run managed Laravel Reverb on Laravel Cloud, Laravel Cloud provisions and manages your Reverb clusters for you. You don’t need to set up and maintain a scalable, high-availability WebSocket server yourself. See the pricing docs for details on concurrent connections, limitations, and pricing.

Creating clusters

To create a Laravel Reverb powered WebSocket cluster, go to your organization’s Resources page, click the WebSockets tab, then click + New WebSocket cluster. Laravel Cloud prompts you to select a region and the maximum number of concurrent connections your cluster needs to handle. Laravel Cloud automatically creates a default WebSocket application for you called production. To attach it to an environment, go to your application canvas and click Add resource > WebSockets. WebSocket applications let you segment and share your cluster capacity across multiple applications and environments. After you attach the WebSocket application to the environment, redeploy your application for the changes to take effect.

Connecting your application

Make sure your application has Laravel Reverb and Laravel Echo installed:

composer require laravel/reverb
npm install --save-dev laravel-echo pusher-js

Laravel Cloud automatically injects the Reverb environment variables needed by your application, including the frontend variables required by the Laravel Echo JavaScript client. No manual configuration is required.

REVERB_APP_ID=10001
REVERB_APP_KEY=********
REVERB_APP_SECRET=********
REVERB_HOST=ws-********-reverb.laravel.cloud
REVERB_PORT=443
REVERB_SCHEME=https
REVERB_VERIFY_SSL=true

VITE_APP_NAME="${APP_NAME}"

VITE_REVERB_APP_KEY="${REVERB_APP_KEY}"
VITE_REVERB_HOST="${REVERB_HOST}"
VITE_REVERB_PORT="${REVERB_PORT}"
VITE_REVERB_SCHEME="${REVERB_SCHEME}"

Laravel Cloud’s WebSocket clusters use the Pusher protocol, which is compatible with any Pusher-protocol client library. Make sure your application has the required packages installed:

composer require pusher/pusher-php-server
npm install pusher-js

Laravel Cloud automatically injects the Reverb environment variables when you attach a WebSocket application to your environment:

REVERB_APP_ID=10001
REVERB_APP_KEY=********
REVERB_APP_SECRET=********
REVERB_HOST=ws-********-reverb.laravel.cloud
REVERB_PORT=443
REVERB_SCHEME=https
REVERB_VERIFY_SSL=true

# config/services.yaml
services:
    Pusher\Pusher:
        arguments:
            $auth_key: '%env(REVERB_APP_KEY)%'
            $secret: '%env(REVERB_APP_SECRET)%'
            $app_id: '%env(REVERB_APP_ID)%'
            $options:
                host: '%env(REVERB_HOST)%'
                port: '%env(int:REVERB_PORT)%'
                scheme: '%env(REVERB_SCHEME)%'
                useTLS: true
                verify: '%env(bool:REVERB_VERIFY_SSL)%'

You can then inject Pusher\Pusher into any service or controller through autowiring.REVERB_APP_KEY and REVERB_HOST are safe to expose to the browser. For example, you can render them into your frontend templates for the JavaScript client. REVERB_APP_SECRET is for server-side authentication only, so never expose it publicly.Laravel Cloud automatically allows origins from attached environments. If your frontend is hosted elsewhere, add its URL (for example, https://frontend.example.com) to the WebSocket application’s Allowed origins.

Make sure your application has Pusher’s Node.js HTTP SDK installed:

npm install pusher

Laravel Cloud automatically injects the following variables when you attach a WebSocket application to your environment:

PUSHER_APP_ID=10001
PUSHER_APP_KEY=********
PUSHER_APP_SECRET=********
PUSHER_HOST=ws-********-reverb.laravel.cloud
PUSHER_PORT=443
PUSHER_SCHEME=https

Then, create a Pusher client using the injected variables:

const Pusher = require('pusher');

const pusher = new Pusher({
    appId: process.env.PUSHER_APP_ID,
    key: process.env.PUSHER_APP_KEY,
    secret: process.env.PUSHER_APP_SECRET,
    host: process.env.PUSHER_HOST,
    port: process.env.PUSHER_PORT,
    useTLS: process.env.PUSHER_SCHEME === 'https',
});

For complete examples of publishing and receiving events, check out the Pusher SDKs documentation.

Make sure your application has Pusher’s Python HTTP SDK installed:

pip install pusher

Laravel Cloud automatically injects the following variables when you attach a WebSocket application to your environment:

PUSHER_APP_ID=10001
PUSHER_APP_KEY=********
PUSHER_APP_SECRET=********
PUSHER_HOST=ws-********-reverb.laravel.cloud
PUSHER_PORT=443
PUSHER_SCHEME=https

Then, create a Pusher client using the injected variables:

import os

import pusher

client = pusher.Pusher(
    app_id=os.environ["PUSHER_APP_ID"],
    key=os.environ["PUSHER_APP_KEY"],
    secret=os.environ["PUSHER_APP_SECRET"],
    host=os.environ["PUSHER_HOST"],
    port=int(os.environ["PUSHER_PORT"]),
    ssl=os.environ["PUSHER_SCHEME"] == "https",
)

For complete examples of publishing and receiving events, check out the Pusher SDKs documentation.

Make sure your application has Pusher’s Go HTTP SDK installed:

go get github.com/pusher/pusher-http-go/v5

Laravel Cloud automatically injects the following variables when you attach a WebSocket application to your environment:

PUSHER_APP_ID=10001
PUSHER_APP_KEY=********
PUSHER_APP_SECRET=********
PUSHER_HOST=ws-********-reverb.laravel.cloud
PUSHER_PORT=443
PUSHER_SCHEME=https

Then, create a Pusher client using the injected variables. The Go SDK expects the port to be included in its Host field:

client := pusher.Client{
	AppID:  os.Getenv("PUSHER_APP_ID"),
	Key:    os.Getenv("PUSHER_APP_KEY"),
	Secret: os.Getenv("PUSHER_APP_SECRET"),
	Host:   net.JoinHostPort(os.Getenv("PUSHER_HOST"), os.Getenv("PUSHER_PORT")),
	Secure: os.Getenv("PUSHER_SCHEME") == "https",
}

For complete examples of publishing and receiving events, check out the Pusher SDKs documentation.

Make sure your application’s Gemfile includes Pusher’s Ruby HTTP SDK, then run bundle install:

gem "pusher"

Laravel Cloud automatically injects the following variables when you attach a WebSocket application to your environment:

PUSHER_APP_ID=10001
PUSHER_APP_KEY=********
PUSHER_APP_SECRET=********
PUSHER_HOST=ws-********-reverb.laravel.cloud
PUSHER_PORT=443
PUSHER_SCHEME=https

Then, create a Pusher client using the injected variables:

require "pusher"

client = Pusher::Client.new(
  app_id: ENV.fetch("PUSHER_APP_ID"),
  key: ENV.fetch("PUSHER_APP_KEY"),
  secret: ENV.fetch("PUSHER_APP_SECRET"),
  host: ENV.fetch("PUSHER_HOST"),
  port: Integer(ENV.fetch("PUSHER_PORT")),
  use_tls: ENV.fetch("PUSHER_SCHEME") == "https"
)

For complete examples of publishing and receiving events, check out the Pusher SDKs documentation.

Laravel Cloud automatically injects the following variables into Java applications, as well as PHP applications that don’t use Laravel or Symfony:

PUSHER_APP_ID=10001
PUSHER_APP_KEY=********
PUSHER_APP_SECRET=********
PUSHER_HOST=ws-********-reverb.laravel.cloud
PUSHER_PORT=443
PUSHER_SCHEME=https

You may then use Pusher’s HTTP SDKs to publish events from your server and its WebSocket SDKs to receive them. For examples in each language, check out the Pusher SDKs documentation.

Editing, resizing, and splitting clusters

You can edit and resize your WebSocket cluster from your organization’s Resources page. Go to WebSocket clusters and click the … icon on your cluster, then click Edit settings. You can use a single WebSocket cluster across multiple applications by splitting the maximum concurrent connections you have provisioned to your cluster across multiple WebSocket applications.

You can choose an even distribution or manually configure a custom split.

Metrics

To view your WebSocket metrics, such as connection count and message rate, navigate to Organization > Resources > WebSockets, click your Reverb cluster, and review the Metrics section. You can also select … > View metrics on the cluster card to jump directly to this section. Use the application selector in the Metrics section to view All applications or an individual application. Use the time range selector to adjust the period shown.

Detaching applications

If your application no longer needs a WebSocket cluster, you can detach it from your application canvas.

Detaching a WebSocket application from an environment does not delete the cluster or stop it from accruing usage charges.

Deleting clusters

You may delete a WebSocket cluster from your organization’s Resources page. Navigate to the WebSockets tab and click the … icon for the cluster you would like to delete. Then, click Delete cluster.

Other WebSocket providers

If you don’t want to use Laravel Reverb powered WebSocket clusters, you can pair Laravel Cloud with an external WebSocket provider like Pusher or Ably. Both are compatible with Laravel event broadcasting and Laravel Echo. However, you will need to manage your WebSocket infrastructure and billing outside of Laravel Cloud, and you will need to manage your environment variables manually.

Get started

Deploy guides

Basics

Resources

Private Cloud

Services

Monitoring

Billing

Other

Laravel Cloud WebSockets

Introduction

Laravel Reverb

Creating clusters

Connecting your application

Editing, resizing, and splitting clusters

Metrics

Detaching applications

Deleting clusters

Other WebSocket providers

​Introduction

​Laravel Reverb

​Creating clusters

​Connecting your application

​Editing, resizing, and splitting clusters

​Metrics

​Detaching applications

​Deleting clusters

​Other WebSocket providers

Introduction

Laravel Reverb

Creating clusters

Connecting your application

Editing, resizing, and splitting clusters

Metrics

Detaching applications

Deleting clusters

Other WebSocket providers