Installation

Socket Conveyor is a Composer package that runs a long-lived OpenSwoole WebSocket server.

Requirements

• PHP 8.2 or newer.
• ext-openswoole 22.0 or newer.
• Composer.
• A host and port the WebSocket server can bind to.

The default Conveyor server host is 0.0.0.0. The examples in these docs use port 8989 for native Conveyor mode and 8990 for Pusher/Reverb-compatible mode.

Install the package

1composer require kanata-php/socket-conveyor

For local development inside the Socket Conveyor repository, install dependencies from the repository root:

1composer install

Verify OpenSwoole

Make sure the PHP binary that will run the server has OpenSwoole enabled:

1php -m | grep openswoole

If Composer reports that ext-openswoole is missing, install and enable the extension for the same PHP binary.

Next step

Start with Quick Start if you want a small native WebSocket server.

Use Pusher Protocol and Laravel Echo / Reverb if you are replacing or complementing Laravel Reverb with Conveyor for Laravel Echo clients.