Server

Server Docs for 1.2.x

Please note that this documentation is specific to LiveSwitch 1.3.x (and higher) server components. For documentation of LiveSwitch 1.2.x (and older) server components please see here.

Server Components

LiveSwitch Server consists of three server components:

  1. The Gateway - provides signalling functionality allowing your clients to make connections to Media Servers.
  2. The Media Server - provides WebRTC connections allowing your clients to stream media through SFU, or MCU, connections.
  3. The SIP Connector - provides interoperability with third party SIP services.

Of these three services it is required that you set up at least one Gateway and one Media Server for your clients to get SFU, or MCU, connections. This is the minimum required set up and is generally suitable only for development. In production we recommend at least two (load balanced) Gateways for redundancy, and depending on your peak concurrent usage you may require a cluster of Media Servers to handle your media traffic. Providing a SIP Connector is required only if your use case requires SIP interoperability. For more information on server Ops concerns see the Server Requirements section.

Getting Started

To quickly get your server environment up and running you should work through the Installation and Configuration guides. For discussion on more advanced issues please read through the Advanced Topics page.

Server Requirements

LiveSwitch has several server components that have particular hardware requirements. The following specifications describe the requirements of each component, which will help you when you are setting up your application's infrastructure.

Gateway

Firewall

  • Allow inbound TCP traffic on port 8080 (default, configurable) for HTTP
  • Allow inbound TCP traffic on port 8443 (default, configurable) for HTTPS

Minimum Hardware

  • 2x CPU
  • 2GB RAM
  • Moderate network performance

Recommended Hardware

  • 4x CPU
  • 4GB RAM
  • High network performance

High Availability

  • 2+ gateways
  • Load balance the with high-availability guarantees

Media Server

Firewall

  • For clustering, allow TCP traffic on port 8445. If 8445 is unavailable, media servers will try the next port, incrementally, until one is available (i.e. 8446, 8447, 8448, 8449, etc).
  • For client connections, allow inbound UDP traffic on ports 49152-65535 on public interfaces.

Minimum

  • 4x CPU
  • 4GB RAM
  • High network performance

Recommended Hardware

  • 8x CPU
  • 8GB RAM
  • Highest network performance

High Availability

  • 2+ media servers

SIP Connector

Firewall

  • For SIP requests allow UDP and or TCP traffic on port 5060 on public interfaces.