kytoonlabs/openwebsockets repository overview

⁠OpenWebSockets

OWS is a implementation of laravel-websockets⁠, created to be used in a standalone fashion under docker, docker-compose or kubernetes scenarios.

Latest version of OWS is built under:

• Alpine 3.16
• PHP 8.1
• Laravel 9
• MariaDB 10
• laravel-websockets 1.13.1

Please see section configuration⁠ to change publising ports, ssl certs and enabling stats.

⁠Running with Docker Run

To deploy a OWS service using docker please follow:

1. Install Docker⁠

2. Run docker run --name ows -e OWS_APP_ID=yourappid -e OWS_APP_KEY=yourappkey -e OWS_APP_SECRET=yourappsecret -d -p 6001:6001 kytoonlabs/openwebsockets

3. Configure your application to consume the OWS service at http://{docker_host}:6001

⁠Running with Docker Compose

To deploy OWS using docker-compose you should:

1. Install Docker⁠ and docker-compose

2. Create a docker-compose.yml file

   version: 3
   volumes:
      ows-data:
   services:
      ows:
          image: kytoonlabs/openwebsockets
          ports:
              - '6001:6001'
          environment:
              OWS_APP_ID: yourappid
              OWS_APP_KEY: yourappkey
              OWS_APP_SECRET: yourappsecret
          volumes:
              - ows-data:/var/lib/mysql
          restart: always
   

   Copy

3. Launch docker-compose with docker-compose up -d

⁠Configuration

OWS implements laravel-websockets project and some capabilities can be configured following the table below. Feature requests that apply to this implementation can be requested at the repository's issues⁠ section.

For more information about the laravel-websockets project please visit the official⁠ documentation.

⁠Contributing

If you'd like to report a bug, give us feedback, or contribute to OpenWebSockets implementation, please read our contributor guidelines.

⁠License

OpenWebSockets is open-sourced software licensed under the MIT license⁠.