WebSocket server for PHP · OpenSwoole · MIT

WebSockets for PHP & Laravel

Connect Laravel Echo to your PHP server, or build a custom WebSocket client with control over your messages.

Custom WebSocket clients Laravel Echo support private + presence channels acknowledgments

Get started View on GitHub Laravel Echo setup

$composer require kanata-php/socket-conveyor

PHP

<?php include __DIR__ . '/vendor/autoload.php'; (new Conveyor\ConveyorServer)->start();

use Conveyor\Constants;use Conveyor\ConveyorServer; (new ConveyorServer())    ->host('127.0.0.1')    ->port(8989)    ->conveyorOptions([        Constants::WEBSOCKET_SUBPROTOCOL => Constants::SOCKET_CONVEYOR,    ])    ->start();

(new ConveyorServer())    ->host('127.0.0.1')    ->port(8990)    ->conveyorOptions([        Constants::WEBSOCKET_SUBPROTOCOL => Constants::PUSHER,        Constants::USE_PRESENCE => true,        Constants::APPS => [[            'app_id' => 'local-app',            'key' => 'local-key',            'secret' => 'local-secret',            'enable_client_messages' => true,            'enabled' => true,        ]],    ])    ->start();

$ php server.php minimal server

actionchannel-connect actionbroadcast-action eventpusher:connection_established actionfanout-action eventOrderShipped channelchat.room.1 actionacknowledge-action channelpresence-room.1 whispertyping httpPOST /conveyor/message actionchannel-disconnect actionchannel-connect actionbroadcast-action eventpusher:connection_established actionfanout-action eventOrderShipped channelchat.room.1 actionacknowledge-action channelpresence-room.1 whispertyping httpPOST /conveyor/message actionchannel-disconnect

clientsConveyorServerchannels · sockets

PHP8.2 or newer

ext-openswoole22.0 or newer

InstallComposer

LicenseMIT

The current published server installs as kanata-php/socket-conveyor. Its move to firebrikdotcom/socket-conveyor is pending; the PHP companion packages already use the new name. See migration status.

For a packaged Pusher/Reverb server, run with Docker to supply PHP and OpenSwoole without installing them locally. Docker and app credentials are required.

Latest releaseFrom GitHub

What’s new in Conveyor

Explore the latest improvements and fixes in the release notes.

View release on GitHub → Repository ↗

01 Overview

What it provides

Socket Conveyor routes WebSocket messages in PHP using OpenSwoole.

A long-running OpenSwoole WebSocket server.

A native JSON action protocol for direct WebSocket clients.

A Pusher/Reverb-compatible protocol for Laravel Echo and pusher-js.

Channel membership, private/presence authorization, server-side broadcasts, acknowledgments, and custom action handlers.

02 Ways to connect

Choose your connection

Choose the guide that matches your app. Each guide covers server configuration, connection details, and a working example. Use one connection mode per server instance.

Use Laravel Echo

Use Laravel broadcasting and Echo with private channels, online member lists, and messages between clients.

Read the Laravel Echo guide →

Build a custom WebSocket client

Send and receive JSON messages directly over WebSockets. Manage channels, track connected clients, and handle your own actions in PHP.

Read the custom client quick start →

03 Installation

Install, then follow your guide

shell · current published server

composer require kanata-php/socket-conveyor

Check requirements, pending Composer registration and installation, then continue with the Native quick start or Laravel Echo / Reverb setup.

Explore the maintained ecosystem components and the archived Belt project, including native clients and the native Laravel broadcaster. PHP client 0.2.0 and broadcaster 0.3.0 are published on Packagist; JS 2.0.1 remains pending; Conveyor Belt is archived.

Looking for runtime versions? See tested-version status.

04 Documentation

Browse the docs

Server setup, protocol guides and companion packages.

Introduction Getting startedChoose a mode and find its setup guide. InstallationA Composer package that runs a long-lived OpenSwoole server. Quick StartStart a native server, connect a client, send one broadcast. UsageNative mode's small JSON action protocol.

Native Conveyor ConveyorRoutes WebSocket messages in PHP using OpenSwoole. Conveyor SubProtocolHandshake, message shape, built-in and custom actions. AuthorizationServer tokens, temporary channel tokens, Echo auth. PresenceTrack which sockets are connected to a channel. AcknowledgmentClients confirm receipt of server messages. HTTP RequestsNative auth and broadcast endpoints, Pusher REST publish. Events, hooks & filtersObserve lifecycle, HTTP, task and message handling.

Laravel and ecosystem Pusher ProtocolWebSocket and REST broadcast setup using the Pusher protocol. Laravel Echo / ReverbLaravel's built-in broadcasting, pointed at Conveyor. PresenceWho is subscribed, with user data from authorization. EcosystemFive component roles, requirements and release status. Native clientsJavaScript candidate and published PHP client, with migration notes. Laravel native broadcasterNative HTTP broadcasting, separate from Echo/Reverb. How to contributeSetup, checks, focused tests, browser smoke test.

Contribute

Reviews go fastest with a small reproduction, a focused change, and the relevant test command.

composer installcomposer testcomposer phpstan

How to contribute

NextInstallation →