README

Documentation · Install · Quick start · Usage guide

A PHP WebSocket server and message router built on OpenSwoole. Use its native action-based protocol for custom applications, or run its Pusher-compatible mode with Laravel Echo and Laravel's Reverb or Pusher broadcaster.

Laravel Echo guide · Docker Hub

What it does

• Routes native WebSocket messages to built-in or custom action handlers.
• Supports Pusher-compatible public, private and presence channels for Laravel Echo clients.
• Provides signed HTTP endpoints for publishing events and querying channels.
• Offers configurable resource limits and application isolation for Pusher deployments.
• Runs as a PHP library or as a standalone Docker server.

Requirements

For the PHP library, you need PHP 8.2 or newer, Composer, and the OpenSwoole extension (version 22.0 or newer). The Docker image includes PHP and OpenSwoole. Development with the renamed PHP client requires PHP 8.3+ and OpenSwoole 26.2+; the server library keeps its PHP 8.2 runtime minimum.

composer require firebrikdotcom/socket-conveyor

The firebrikdotcom/* Composer namespace is being prepared. Until it is registered on Packagist and a release is published, existing installations continue to use kanata-php/socket-conveyor. The Docker image below remains available under its existing name.

See the usage guide for a native server, protocol examples and configuration.

Quick start with Docker

Export your existing PUSHER_APP_ID, PUSHER_APP_KEY and PUSHER_APP_SECRET in your shell, then run:

docker run --rm --init -p 127.0.0.1:8080:8080 \
  -e PUSHER_APP_ID -e PUSHER_APP_KEY -e PUSHER_APP_SECRET \
  lotharthesavior/socket-conveyor:2.6.1

The image runs a Pusher-compatible server. Match its credentials to your Laravel broadcasting configuration. The port above binds to localhost; use a properly configured reverse proxy and TLS for public access. See the Docker guide for image tags, configuration and deployment details.

Laravel Echo and Pusher compatibility

To configure a server from PHP instead of using the Docker launcher:

use Conveyor\Constants;
use Conveyor\ConveyorServer;

(new ConveyorServer())
    ->port(8080)
    ->conveyorOptions([
        Constants::WEBSOCKET_SUBPROTOCOL => Constants::PUSHER,
        Constants::USE_PRESENCE => true,
        Constants::APPS => [[
            'app_id' => 'local',
            'key' => env('REVERB_APP_KEY'),
            'secret' => env('REVERB_APP_SECRET'),
            'enable_client_messages' => true,
            'enabled' => true,
        ]],
    ])
    ->start();

Set Laravel's Reverb or Pusher settings to the same application ID, key, secret, host and port. The server accepts WebSocket connections at /app/{key} and signed HTTP requests under /apps/{app_id}. Follow the Laravel Echo guide for a complete client and authorization setup.

Security and operations

Pusher mode validates inputs, isolates applications and applies configurable resource budgets; review Pusher security and limits before deployment. The Docker health check reports TCP liveness; the smoke test checks actual event delivery.

More resources

• Full usage guide, including native mode and troubleshooting
• Real Pusher client example, using Laravel Echo and pusher-js
• Changelog
• MIT license