LiveKit Egress (livekit-egress)

Recording workers of the LiveKit rooms (room composite, track and participant egress): files uploaded to the S3 bucket of the service in SeaweedFS with an identity limited to it. The workers take their jobs from Redis; LiveKit Server signs the egress_ended webhook Navin Enterprise uses to file the recording in the tenant layout.

Generated from catalog/services/livekit-egress.yaml: do not edit by hand.

Summary

Version	1.15.0
Use	install and configure
Layer	functional (AI catalog)
Category	AI serving
Installation methods	podman
External connection	no
Sandbox only	no

Licence

SPDX identifier	Apache-2.0
Licence policy	core licence (MIT or Apache-2.0)
Licence exception	-
Licence exceptions of its dependencies	LEX-032 (pending, awaiting the client), LEX-033 (pending, awaiting the client)
Platform component	livekit-egress

Packages and artifacts

A package the project of the service publishes (its image, its binary archive, its Python or OS package) carries the licence of the service; a third-party package carries the licence written on its row, read from the official upstream metadata.

Kind	Package	Version	Licence	Details
container image	docker.io/livekit/egress	v1.15.0	Apache-2.0	image key egress, used by egress, digest sha256:ac244a40268ce1dd1510fbff6eb529609ec68aceff1602343f79be8ca08c355b

Images are pinned by tag in the descriptor, and by digest when the descriptor declares one (the offline bundle then refuses a pulled image that does not carry it); the digest is recorded in the mirror of the Manager when the offline bundle is imported, and every pull or load is checked against it.

Supported systems and architectures

Method	Operating systems	Architectures
podman	RHEL family (dnf), Debian family (apt), Arch Linux (pacman)	x86_64, aarch64 (not restricted by the descriptor)

Certified host systems: RHEL 8/9/10, Rocky Linux 8/9/10, AlmaLinux 8/9/10, Oracle Linux 8/9, CentOS Stream 9/10, Ubuntu 22.04/24.04, Debian 12, Arch Linux (rolling). The host preflight accepts these systems (other releases of a known family give a warning, end of life releases are refused) and the x86_64 and aarch64 architectures.

Prerequisites

Host

• at least 4 CPU (warning, cpu).
• at least 4096 MB of memory (warning, memory).

Network and ports

Component	Port name	Port	Opened in the host firewall
egress	health	8592/tcp	no
egress	metrics	6791/tcp	yes

Services and connections needed

• livekit: livekit.
• redis: redis.
• storage: seaweedfs.

Details and resolution: see Dependencies.

Installation methods and modes

Method	Default	What the method uses
podman	yes	the container images of the descriptor, run by Podman under systemd

Components

Component	Kind	Installation methods	Ports
Egress worker (egress)	worker	podman	8592/tcp, 6791/tcp

Single worker (single) (default)

One recording worker.

What the mode deploys:

Component	Placement
egress	min 1, max 1

Worker pool (pool)

Several workers on the same Redis; each job goes to a worker with free CPU.

What the mode deploys:

Component	Placement
egress	min 2, recommended 2

Install this service

The install wizard of the Navin Manager plans, validates and runs the installation; you need the services:install permission on the cluster.

1. Open the wizard. In Clusters, choose the row action Install services of the target cluster. The wizard opens on its first step, Service.

2. Choose the service. On the Service step, select LiveKit Egress. The card shows the licence Apache-2.0 and the dependencies the installation needs.

3. Choose the hosts and the mode. On the Hosts step, tick the hosts, then choose the Mode: single (default), pool. Each mode deploys the components listed in Installation methods and modes.

4. Bind the dependencies. On the Bindings step, choose for each dependency (livekit, redis, storage) Install with the platform or Use an existing connection; an optional dependency can stay on No binding.

5. Configure. On the Configure step, review the parameters (see Configuration parameters). Passwords left empty with a generated default are generated and sealed by the Manager.

6. Review and install. On the Install step the Manager validates the plan and shows the installation order; when it says "The plan is valid. Ready to install.", choose Install. A highly available mode is installed only when its HA checks pass.

7. Verify. The operation ends when the health checks of every instance pass (see Health checks); the service then shows as running in Services.

High availability

Cluster	native (native)
High availability	redundancy (redundancy)
Failover	native (native)
Replication	none (none)
Quorum	none (none)
Discovery	registry (registry)
Entry point	none (none)
Official documentation	https://docs.livekit.io/transport/self-hosting/egress/
References	https://github.com/livekit/egress

Prerequisites

Prerequisite	Must be highly available	Modes	Description
redis	yes	pool	Highly available Redis shared with LiveKit Server.

Topology per mode

Modes	Highest catalog level	Distribution	Quorum component	Fault domains	Description
single	standalone (standalone)	single (single)	-	1	One worker, no fault tolerance.
pool	ha (ha)	parallel jobs (parallel-jobs)	-	2	Several workers; a new recording goes to a worker that is up and has free CPU.

Notes

• A recording runs on one worker: the loss of that worker ends it with an error and the files not uploaded yet are lost.
• Each worker needs 4 CPUs and 4 GB of memory (official requirement); a room composite takes 2 to 6 CPUs.

Configuration parameters

Network

Parameter	Type	Default	Allowed values	Required	Secret	Restart	Description
Health port (health_port)	port	8592	-	no	no	no	HTTP status of the worker (JSON), local to the host.
Metrics port (metrics_port)	port	6791	-	no	no	no	Prometheus port (livekit_egress_available for the capacity).
LiveKit URL (livekit_url)	string	(empty)	-	no	no	no	ws:// or wss:// URL of LiveKit Server (its load balancer in the distributed mode); empty: the first server of the livekit binding.

Recording

Parameter	Type	Default	Allowed values	Required	Secret	Restart	Description
Maximum recording (file_max_duration)	string	4h	^[1-9][0-9]{0,4}(s|m|h)$	no	no	no	Longest file recording; once reached the egress ends with EGRESS_LIMIT_REACHED.
CPU ceiling (max_cpu_utilization)	float	0.8	min 0.3, max 0.95	no	no	no	CPU share above which a worker refuses new jobs.

Dependencies

For each active dependency the Manager takes the first of: the binding chosen in the wizard; a service of the same installation that provides it; a service already installed in the cluster; the only connection of the expected type. Otherwise an optional dependency stays unbound, and a required one is added to the installation in its default mode (the column below names the catalog service added).

Binding	Provided by	Connection type	Endpoint	Optional	When nothing is bound	Description
livekit	livekit	-	signal	no	livekit is added to the installation	LiveKit Server of the rooms: API key pair and WebSocket URL (its redis_bus must be on).
redis	redis	redis	redis	no	redis is added to the installation	The Redis of LiveKit Server: job queue of the workers.
storage	seaweedfs	s3	s3	no	seaweedfs is added to the installation	Bucket of the recordings and its S3 identity, limited to that bucket (provisioned by SeaweedFS before the installation).

Commands

Command	Component	Target	Description
Recent logs (logs)	egress	chosen host	Last lines of the worker journal.

Health checks

Liveness (per instance)

Component	Check	Details
egress	HTTP http://127.0.0.1:{{ config.health_port }}/	Expected 200; 60 retries; interval 2 s; timeout 3 s

Preflight checks

Check	Type	Meaning	Severity	Components
cpu	cpu_count {"min": 4}	at least 4 CPU	warning	every component
memory	memory_mb {"min": 4096}	at least 4096 MB of memory	warning	every component

Uninstall

Paths removed when the data is purged: {{ paths.log }}.

Quick links

• Metrics: http://{{ host.fqdn }}:{{ config.metrics_port }}/metrics

Upstream documentation

• Homepage: https://docs.livekit.io/transport/self-hosting/egress/
• Source: https://github.com/livekit/egress
• High availability: https://docs.livekit.io/transport/self-hosting/egress/
• High availability: https://github.com/livekit/egress