LiveSwitch Console

Manage your servers, applications, and channels in the LiveSwitch Console. Once you have completed your installation, you can find your Console running on your Gateway's localhost at https://localhost:9090/admin. This section describes the LiveSwitch Console and its features.

Configuration Entities

Configuration entities are used to configure your global environment, your deployment-specific environments, and your client application environments.

  • Site: Shows your license key and secondary (ephemeral) Redis cache configuration.
  • Deployments: Pertains to your server-side deployments; for example, Gateways, Media Servers, and SIP Connectors.
  • Applications: Configures client application's shared secret and global settings.
  • Channels: Specifies media settings for channels. Channels are subordinate to a given application, so channel configuration is specific to particular channels joined by your clients.

Home

The home page provides you with a brief status overview of your system health. The status overview shows:

  • The secure status of your v1 API.
  • The number of Media Servers that are currently operational.

If you didn't enable authentication for your v1 API, a warning message appears. Clicking this message takes you to the API Keys page. The Secure v1 API section allows you to opt in to v1 API authentication. For more information, see API Keys.

If you have no connected Media Servers, your clients can't connect to either SFU or MCU mode. To resolve this, see Media Servers.

On the title bar, you can view the alerts. From any page in the LiveSwitch Console, clicking the bell icon displays your system status. You can click a status to navigate and gain more information about the particular status alert.

Servers

The Servers page shows you the LiveSwitch Server environment. It lists your Gateways, Media Servers, and SIP Connectors.

Gateways

The Gateway section shows the Gateways that are operational in your LiveSwitch infrastructure. You can click the arrow beside each listed Gateway to get more information such as the architecture, core count, physical memory, and such. Physical memory is the amount of memory installed on the machine.

Important

The physicalMemory field on the Gateway console shows 0 (zero) when this information can't be retrieved due to platform limitations rather than an error. For example, you can expect this value to be 0 on Linux. The physicalMemory is successfully retrieved from Windows runtime, macOS, iOS, Android, and Unity.

Troubleshooting - No Gateways Connected

If you see a message stating that no Gateways are running, contact LiveSwitch Support.

Media Servers

The Media Server section shows the Media Servers that are registered with a Gateway in your LiveSwitch infrastructure. You can click the arrow beside each listed Media Server to get more information such as core count, current connection details, and such.

Troubleshooting - No Media Servers Connected

This is potentially a serious issue as it means that no client can get an SFU or MCU connection. The most likely causes are:

  1. You didn't install a Media Server. See the Installation guide for more information.
  2. You have misconfigured your serviceBaseUrl, which is how your Media Servers communicate with your Gateway. See Deployment Configuration for more information.

SIP Connectors

The SIP Connector section shows the SIP Connectors that are registered with a Gateway in your LiveSwitch infrastructure. You can click the arrow beside each listed SIP Connector to get more information such as the architecture, core count, and such.

Troubleshooting - No SIP Connectors Connected

The possible causes are:

  1. You didn't install a SIP Connector. You don't need to provide a SIP Connector if your use case doesn't require SIP support. If you do, see the Installation guide for more information.
  2. You have misconfigured your serviceBaseUrl, which is how your SIP Connectors communicate with your Gateway. See Site Configuration for more information.

Recording Monitor

The Recording Monitor scans the file system and dispatches, moves recording jobs if Move is enabled, and muxes jobs if Mux is enabled. It also expires old recordings, deletes expired recordings, and processes REST API requests. It owns the recording management database and runs migrations when updating to new versions.

Recording Mover

The Recording Mover executes move jobs queued by the Recording Monitor and Muxer. It moves recording files to AWS S3 bucket.

Recording Muxer

The Recording Muxer processes muxing jobs. These jobs take multiple files from a recording session and mix them together to produce a single muxed recording file. Afterwards it will dispatch a move job if Move is enabled.

Administrative User

The Configuration Console supports a single user. This is the user that you set up as step 3 of the Initialization Wizard. This user has full administrative privileges and can access all configuration options supported by the Console.

Note

This user account is specific to accessing your Configuration Console and is distinct from any other LiveSwitch user account that you may have.

Change Password

To change your administrator user password, click your username on the top-right corner and then click Change Password.

images

Search Server Documentation

The search functionality on the LiveSwitch Console allows you to search the LiveSwitch Server documentation. To search for any documents related to LiveSwitch Server, click the icon. The search box appears. Start typing the text in the search box; search results appear in a dropdown list. You can either select the desired result from the dropdown list, or hit Enter to see more results. When you select a result, it opens the server documentation in a new tab. If you don't find the required result in the popup window, you can close the popup window.

Note

If you don't find the documentation that you are looking for, either contact LiveSwitch Support by submitting a request or leave us documentation feedback.

API Keys

The API Keys page allows you to secure your v1 API and manage your API keys.

Secure REST API

LiveSwitch 1.2.x (and lower) Gateways required that access to your administrative route be blocked by your firewall to prevent unauthorized access to administrative features through the REST API. With LiveSwitch 1.3.x (and higher), alternatively, you can use API Keys. To prevent a breaking change when migrating between 1.2.x and 1.3.x, the v1 API isn't secured by default. This ensures that any service currently using the v1 API continues to do so without interruption.

Important

It's considered best practice to secure your v1 API.

After you have secured your v1 APIs, you need to add the API key to the header of your v1 API call.

CURL Example

curl -H "Accept:application/json" -H "X-API-Key: 8b45e287-6470-4727-81c6-39a2589e" -v https://localhost:9090/admin/api/v1.0/mediaservers

Manage API Keys

Create API Keys in the Console from the API Keys page. To create an API key, click NEW API KEY. You must provide a tag, which is a human-readable label for a key. Note that tags don't need to be unique and you can edit them at any time.

Important

You can revoke an API key at any time by deleting it. Be aware that any API call using a revoked key returns a 401 Unauthorized response from your Gateway.