README

Laravel integration for Sockeon — a real-time WebSocket and HTTP server for PHP.

This package wires Sockeon into Laravel's service container, config system, logging, and Artisan commands so you can run a Sockeon server alongside your Laravel app without a standalone server.php bootstrap.

Requirements

• PHP 8.3+
• Laravel 11, 12, or 13
• sockeon/sockeon ^3.0
• ext-sockets, ext-openssl (required by Sockeon)
• ext-openswoole (optional, for engine=swoole)
• ext-redis (optional, for multi-node scaling)

Installation

composer require sockeon/laravel

Run the installer to publish config and scaffold directories:

php artisan sockeon:install

Or publish config only:

php artisan vendor:publish --tag=sockeon-config

Quick start

1. Create a controller in app/Sockeon/Controllers/:

<?php

namespace App\Sockeon\Controllers;

use Sockeon\Sockeon\Controllers\SocketController;
use Sockeon\Sockeon\Http\Attributes\HttpRoute;
use Sockeon\Sockeon\Http\Request;
use Sockeon\Sockeon\Http\Response;
use Sockeon\Sockeon\WebSocket\Attributes\OnConnect;
use Sockeon\Sockeon\WebSocket\Attributes\SocketOn;

class ChatController extends SocketController
{
    #[OnConnect]
    public function onConnect(string $clientId): void
    {
        $this->emit($clientId, 'welcome', ['clientId' => $clientId]);
    }

    #[SocketOn('chat.message')]
    public function onMessage(string $clientId, array $data): void
    {
        $this->broadcast('chat.message', [
            'clientId' => $clientId,
            'message' => $data['message'] ?? '',
        ]);
    }

    #[HttpRoute('GET', '/api/status')]
    public function status(Request $request): Response
    {
        return Response::json(['clients' => $this->getClientCount()]);
    }
}

1. Start the server:

php artisan sockeon:serve

Controllers in app/Sockeon/Controllers are auto-discovered by default. You can also register classes manually in config/sockeon.php under controllers.

Configuration

All options live in config/sockeon.php. Key environment variables:

See the Sockeon docs for survivability, scaling, CORS, and rate limiting options.

Middleware

Register global middleware in config/sockeon.php:

'middleware' => [
    'http' => [
        App\Sockeon\Middleware\AuthMiddleware::class,
    ],
    'websocket' => [
        App\Sockeon\Middleware\AuthenticateSocket::class,
    ],
    'handshake' => [
        App\Sockeon\Middleware\VerifyAuthKey::class,
    ],
],

Per-route middleware uses HttpRoute / SocketOn attributes on your controllers. See Middleware.

Logging

Sockeon uses its own logger (colored console output and optional file logging). Configure it in config/sockeon.php or via env vars:

SOCKEON_LOG_LEVEL=info
SOCKEON_LOG_FILE=true
SOCKEON_LOG_DIRECTORY=/var/log/sockeon

Artisan commands

Facade

use Sockeon\Laravel\Facades\Sockeon;

$server = Sockeon::server();
$server->broadcast('notification', ['message' => 'Hello']);

The server instance is created once per process and controllers are resolved through Laravel's container (constructor injection works).

Testing

composer test

Documentation

• Sockeon documentation
• Quick start guide

Security

If you discover a security vulnerability, please email xentixar@gmail.com.

License

MIT — see LICENSE.