Zum Hauptinhalt springen

LiveKit

OpenTalk organizes video and audio streams through LiveKit.

Configuration​

The section in the configuration file is called livekit.

FieldTypeRequiredDefault valueDescription
api_keystringyes-The name of the API key used by the OpenTalk controller to communicate with the LiveKit API.
api_secretstringyes-The API secret used by the OpenTalk controller to communicate with the LiveKit API.
public_urlstringyes-The URL under which the LiveKit server can be reached by the OpenTalk frontend. The OpenTalk controller itself will not use this URL, but just pass it on to the frontend.
service_urlstringyes-The URL under which the OpenTalk controller communicates with the LiveKit server.

Example:

[livekit]
api_key = "controller_key"
api_secret = "-secret-"
public_url = "https://livekit-public.example.com"
service_url = "https://livekit-internal.example.com"
  • Ensure that public_url is reachable for all users connecting to LiveKit.
  • The service_url should be the URL where the controller can access the LiveKit server, which can be an internally routed URL or IP.
  • The api_key and api_secret must match the values configured in the LiveKit server.
  • The recorder service will fetch the configuration from the controller

Configuring LiveKit​

  • Use the container image livekit/livekit-server:<version> in combination with controller from the corresponding release.

  • If you are using Docker, it is recommended to run LiveKit in network_mode: host. This is crucial because:

    • A large number of UDP ports are required for proper functionality.
    • Not using network_mode: host will result in a separate process being started for each mapped UDP port.

  • Node ip selection:

    • Add --node-ip <ip> to the container command to specify the IP of the host which will be advertised to clients.

      Example command entry in a compose file:

      command: --config /livekit.yaml --node-ip 198.51.100.23

    • Alternatively, you can set rtc.use_external_ip to true to allow LiveKit to discover the true IP using STUN in cloud environments where the host has a public IP address but is not directly exposed.

  • Configure the access tokens used by the controller and livekit. In the livekit configuration, add an entry in the format <NAME>: <SECRET>, ensuring it is in sync with the controller settings for api_key and api_secret.

    Here is a sample configuration for the LiveKit server:

    ---
    port: 7880
    rtc:
      tcp_port: 7881
      port_range_start: 20000
      port_range_end: 25000
      use_external_ip: true
    keys:
      controller_key: -secret-
    logging:
      json: false
      level: info

  • Adjust Reverse Proxy Configuration

    If you plan to host LiveKit behind a reverse proxy, ensure that:

    • The reverse proxy handles the TLS encryption.
    • Port 7880 (or the configured port) is set as the target for the reverse proxy.