nicholashill/wsrelay repository overview

WebSocket Relay Server facilitates P2P-style communication between different browser users, without any WebRTC faff. It acts as an intermediatory relaying messages between users and can support scenarios such as online chat or multiplayer gaming.

Use the published container image in Docker Hub:

docker run -p 22002:22002 nicholashill/wsrelay:latest

Supply any number of environment variables to configure the server:

• ACCEPTED_ORIGINS, to override which origins to permit (I.E. https://whatever⁠), defaults as * for all.
• ACCEPTED_PROTOCOLS: to override which websocket protocols to permit, defaults as * for all.

Alternatively, mount a volume with an alternative config.json file, and optionally mount a volume to persist data, as per the below example.

docker run -p 22002:22002 \
    -v /var/dockerVolumes/wsrelay/config:/app/config \
    -v /var/dockerVolumes/wsrelay/data:/app/data \
    nicholashill/wsrelay:latest

See the repository homepage⁠ for more documentation.