frozenmountain/liveswitch-websocket-media-server repository overview

The LiveSwitch WebSocket Media Server accepts inbound streaming audio and video media over the WebSocket protocol to join WebRTC-based conferences.

⁠Quick Start

First, set up your LiveSwitch Gateway⁠.

Next, start your LiveSwitch WebSocket Media Server docker image:

sudo docker run -d \
    --env CONNECTIONSTRINGS:DEFAULT='postgres://postgres:[email protected]:5432/postgres' \
    --env CONNECTIONSTRINGS:CACHE='redis://127.0.0.1' \
    --env SERVICEBASEURL='http://127.0.0.1:8080' \
    --network host \
    --restart always \
    --ulimit nofile=65535:65535 \
    --name liveswitch-websocket-media-server \
      frozenmountain/liveswitch-websocket-media-server

See below for more information about the CONNECTIONSTRINGS:DEFAULT and CONNECTIONSTRINGS:CACHE environment variables.

⁠Network

The LiveSwitch Media Server requires host network access.

TCP port 7001 handles the incoming Media-Over-WebSockets.

⁠Configuration

The LiveSwitch WebSocket Media Server has two levels of configuration.

1. Instance configuration for settings specific to an individual server is done via environment variables or a JSON configuration file.
2. Deployment configuration for settings that apply to all servers is done via the administration console or REST API.

⁠Instance Configuration

Environment variables are recommended for simple configuration.

If using a JSON file, it must be located at /app/FM.LiveSwitch.WebSocketMediaServer.Service.config.json, e.g.:

docker cp FM.LiveSwitch.WebSocketMediaServer.Service.config.json liveswitch-websocket-media-server:/app/FM.LiveSwitch.WebSocketMediaServer.Service.config.json

Example JSON file:

{
  "ConnectionStrings": {
    "Default": "postgres://postgres:[email protected]:5432/postgres'",
    "Cache": "redis://127.0.0.1"
  }
}

Environment variable names map to the JSON property names using .NET Core conventions⁠.

⁠CONNECTIONSTRINGS:DEFAULT

A postgres connection URI that matches the documentation here⁠. If not provided, the server will fail to startup.

⁠CONNECTIONSTRINGS:CACHE

A redis connection string compatible with ServiceStack.Redis⁠. If not specified, it will default to 127.0.0.1.

⁠Deployment Configuration

The administration console is accessible via the Gateway on :9090/admin by default. It can be accessed by any modern web browser.

The REST API is accessible via the Gateway on :9090/admin/api by default. LiveSwitch conforms to OData⁠ best practices. The v2 API is recommended for read/write access to configuration.

The REST API explorer is accessible via the Gateway on :9090/admin/swagger by default. Swagger⁠ allows you to explore and interact with the REST API from your web browser.