chaosws/chaos repository overview

⁠What is Chaos?

Chaos is lightweight websocket server based on Pusher⁠ communication protocol written in c++.

⁠How to use this image

Starting a Choas instance is simple:

$ docker run -e PUSHER_APP_KEY=websocketkey -e PUSHER_APP_SECRET=somethingsecret  -d chaosws/chaos:tagname

⁠... via docker-compose

Example docker-compose.yml for chaos:

  chaos:
    image: chaosws/chaos:latest
    ports: 
      - "6001:6001"
    environment: 
      WS_SERVER: "0.0.0.0"
      REDIS_SERVER: "0.0.0.0"
      PUSHER_APP_KEY: "websocketkey"
      PUSHER_APP_SECRET: "somethingsecret"
      PUSHER_APP_CLIENT_EVENTS: 1

⁠Environment Variables

PUSHER_APP_ID

Pusher application id

PUSHER_APP_KEY

Pusher application key

PUSHER_APP_SECRET

Pusher application secret

PUSHER_APP_CLIENT_EVENTS

enable or disable pusher client event

PUSHER_APP_ACTIVITY_TIMEOUT

pusher connection timeout in seconds

REDIS_SERVER

listener address ipv4, ipv6 or unix:/path/to/socket for unix socket for internal communication default: localhost

REDIS_PORT

redis listener port default: 6379

REDIS_CONNECTIONS

redis listener backlog default: 500

WS_SERVER

websocket address ipv4, ipv6 or unix:/path/to/socket for unix socket default: localhost

WS_PORT

websocket listener port default: 6001

WS_CONNECTIONS

websocket listener backlog default: 500

WS_CLIENT_MAX_SIZE

websocket max frame limit in bytes default: 16384

HTTP_CLIENT_MAX_SIZE

http request max size in bytes default: 4096

LOG_LEVEL

log level threshold, possible values: DEBUG, INFO, NOTICE, WARNING, ERROR, CRIT, ALERT, EMERG default: INFO