PHPackages                             artisansdk/server - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [HTTP & Networking](/categories/http)
4. /
5. artisansdk/server

ActiveProject[HTTP & Networking](/categories/http)

artisansdk/server
=================

A service-based, Laravel PHP implementation of an async, realtime, WebSocket server.

1.0.4(9y ago)1233[1 issues](https://github.com/artisansdk/server/issues)MITPHPPHP >=5.6.4

Since Apr 15Pushed 2y ago3 watchersCompare

[ Source](https://github.com/artisansdk/server)[ Packagist](https://packagist.org/packages/artisansdk/server)[ RSS](/packages/artisansdk-server/feed)WikiDiscussions master Synced 3w ago

READMEChangelog (5)Dependencies (11)Versions (7)Used By (0)

Server
======

[](#server)

A service-based, Laravel PHP implementation of an async, realtime, WebSocket server.

Table of Contents
-----------------

[](#table-of-contents)

- [Installation](#installation)
    - [Configure the Environment](#configure-the-environment)
    - [Nginx Websocket Proxy Configuration](#nginx-websocket-proxy-configuration)
    - [Running the Server (Supervisord)](#running-the-server)
- [Usage Guide](#usage-guide)
    - [Extending the Server Manager](#extending-the-server-manager)
    - [Pushing Messages to the Realtime Queue](#pushing-messages-to-the-realtime-queue)
    - [Authenticating Client Messages](#authenticating-client-messages)
- [Licensing](#licensing)

Installation
------------

[](#installation)

The package installs into a Laravel application like any other Laravel package:

```
composer require artisansdk/server ~1.0

```

Then in your Laravel application's `config/app.php` add the `ArtisanSDK\Server\Provider::class`to the `providers` key. This will register the configs and Artisan commands provided by the package. You can publish these configs to `config/server.php` by running:

```
php artisan vendor:publish --provider="ArtisanSDK\\Server\\Provider" --tag=config

```

> **Show Me:** You can see how to integrate this package by browsing the source code of [`larandomizer/app`](http://github.com/larandomizer/app) which is a full featured prize give away app for meetups and conferences.

### Configure the Environment

[](#configure-the-environment)

You will still want to edit the `.env` file to customize environment settings. Note that no database is used as all data is stored in memory on the server. Restarting the server will cause all data to be lost. Below are available options for server customization:

- `SERVER_ADDRESS` (`127.0.0.1`): sets the address the server should bind to (`0.0.0.0` would be for allowing all external connections)
- `SERVER_PORT` (`8080`): sets the port the server will listen on for websocket connections
- `SERVER_MAX_CONNECTIONS` (`100`): the server rejects new connections after this limit (set to `0` to allow unlimited)
- `SERVER_QUEUE` (`default`): the name of the queue that realtime messages will be sent to
- `SERVER_QUEUE_DRIVER` (`beanstalkd`): the driver to use for the realtime message queue
- `SERVER_KEY` (`password`): the admin password to authenticate connections against admin protected connections

### Nginx Websocket Proxy Configuration

[](#nginx-websocket-proxy-configuration)

Nginx makes the perfect lightweight frontend server for the Laravel backend application. Additionally it can be used to proxy websockets connecting on port `80` to the `8080` default server socket. Doing so helps get around some firewall settings. The following should be placed just before your default `location`directive for the Laravel application itself (e.g.: Forge's default). Using these settings you can host websockets securely with the `wss://` protocol allowing Nginx to handle the SSL connection and your websocket server handling basic HTTP.

```
location /server/ {
    proxy_pass http://127.0.0.1:8080;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header Host $host;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_read_timeout 5m;
    proxy_http_version 1.1;
    proxy_set_header Upgrade $http_upgrade;
    proxy_set_header Connection "upgrade";
}

```

A quick note on the settings used:

- `location /server/` directs all traffic going to `/server/` to the proxy
- `proxy_pass` passes the traffic to the localhost webserver on port `8080`
- `proxy_read_timeout` customizes the connection drop to hang up idle connections
- `proxy_http_version` is the version of the websocket protocol in HTTP
- `X-Real-IP` header gives your websocket server the real IP of the client connection
- `Upgrade` and `Connection` headers instruct the browser to upgrade to websocket connection

### Running the Server

[](#running-the-server)

The websocket server can be ran as an console command using `php artisan server:start`and if you pass `--help` to the command you can see additional options. You can stop the running server by killing the process with `CMD + C` (or `CTRL + C`).

In production you would want to have Supervisor monitor the server and restart it if ever it crashes. The demo application has a "Restart Server" command which actually just stops the server and expects Supervisor to start it again automatically. If you are using Laravel Forge this is pretty easy to do by adding a New Deamon on the server with a configuration of:

- Command: `/usr/bin/php /home/forge/default/artisan server:start`
- User: `forge`

The resulting Supervisor config might be:

```
[program:server]
command=/usr/bin/php /home/forge/default/artisan server:start
autostart=true
autorestart=true
user=forge
redirect_stderr=true
startsecs=1
stdout_logfile=/home/forge/.forge/server.log

```

Forge does not add the `startsecs` by default but in practice this may be needed to give the server ample time to start without hard exiting and forcing Supervisor to give up on starting the process.

Usage Guide
-----------

[](#usage-guide)

### Extending the Server Manager

[](#extending-the-server-manager)

The WebSocket server is a singleton instance that wraps brokers all connections and messages between connected clients and the server via `Broker`. While this class rarely needs modification, the broker collaborates with the `Manager` class. You can think of the manager as the kernel of the application as it maintains the initial boot state and event loop the entire time the server is running. It has sensible defaults but will likely need extending for anything domain specific.

Simple create a new manager class in your local namespace such and include a `boot()`method which will be called to initialize your application's custom listeners:

```