Setting up LiveKit (optional)

The playbook can install and configure LiveKit for you.

LiveKit is an open source project that provides scalable, multi-user conferencing based on WebRTC. It's designed to provide everything you need to build real-time video audio data capabilities in your applications.

See the project's documentation to learn more.

Decide on a domain and path

By default, LiveKit is configured to be served on the Matrix domain (sfu.example.com, controlled by the livekit_server_hostname variable).

This makes it easy to set it up, without having to adjust your DNS records manually.

If you'd like to run Livekit on another hostname or path, use the livekit_server_hostname variable.

Adjusting DNS records

If you've changed the default hostname, you may need to adjust your DNS records accordingly to point to the correct server.

Ensure that the following DNS names have a public IP/FQDN:

livekit.example.com

Adjusting the playbook configuration

Add the following configuration to your inventory/host_vars/matrix.example.com/vars.yml file:

livekit_server_enabled: true

# Set a secure key for LiveKit authentication
livekit_server_dev_key: 'your-secure-livekit-key'

Adjusting firewall rules

To ensure the services function correctly, the following firewall rules and port forwarding settings are required:

7881/tcp: ICE/TCP (used by LiveKit Server for Element Call)
7882/udp: ICE/UDP Mux (used by LiveKit Server for Element Call)

💡 The suggestions above are inspired by the upstream Ports and Firewall documentation based on how LiveKit is configured in the playbook. If you've using custom configuration for the LiveKit Server role, you may need to adjust the firewall rules accordingly.

Installing

After configuring the playbook and potentially adjusting your DNS records, run the installation command: just install-all or just setup-all

Usage

Once installed, and in conjunction with Element Call and JWT Service, Livekit will become the WebRTC backend for all Element client calls.

Additional Information

Refer to the Livekit documentation for more details on configuring and using Livekit.

2.7 KiB Raw Blame History