Component

core/messaging/livekit-server

A LiveKit media server — the selective forwarding unit that carries realtime audio and video between the participants of a room. A client opens a WebSocket signalling session on the API port, then exchanges media over WebRTC, which the server terminates either on one multiplexed UDP port with a TCP port beside it as the fallback path for clients whose network blocks UDP, or on a contiguous range of UDP ports that gives each connection its own socket, which carries traffic only where the pod uses the node's own network. Wire here when the cluster carries realtime voice or video itself rather than handing the media to a carrier it does not run, and the same server serves conventional applications as readily as agent workloads. Consumers receive the server's in-cluster host, its signalling port, the protocol that port speaks, and the API key identifier they pair with their own issued secret; the token-signing secret arrives through the api_secret slot here and as the `credential` on each consumer's connection to this server, and is never published on the topology. Realized by a Helm Recipe that synthesizes a Deployment and a ClusterIP Service over the upstream image and declares no volume: the server holds no durable disk, keeping room and participant state in memory, so more than one replica means wiring the state-store socket to a Redis-compatible datastore rather than adding storage here. With `values.metrics_enabled` true the Recipe turns on the server's metrics, on a port of their own that checks no caller, and publishes their address as `metrics_endpoint`; false, that key is empty.

Provenance

OfficialSigned by a signing identity this catalog recognizes as an official publisher.
Content digest
sha256:e41f9b088537b784dcc0eb6a73aad4c07fe9d4687d4567426a235b104907b83a
Published
2026-11-10T10:12:26Z
Signing identity
https://token.actions.githubusercontent.com/https://github.com/aggrega-ai/aggrega-hub/.github/workflows/catalog-publish-sign.yml@refs/heads/main

Signature

  • Officialapplication/vnd.dev.sigstore.bundle.v0.3+json

    https://token.actions.githubusercontent.com/https://github.com/aggrega-ai/aggrega-hub/.github/workflows/catalog-publish-sign.yml@refs/heads/main

    sha256:cac242eca02a697ec799a2664609dc0c5931199d11ed30bcbd5f9a486c070a0d

Reference at this version

oci://hub.aggrega.ai/component/core/messaging/livekit-server:1.0.0

Developer parameters

Values the developer sets in the Aggregate.

NameTypeDefaultRequiredDescription
api_keystringdevkeynoPublic identifier of the API key pair. It travels in the clear inside every access token the server issues, so it is not secret; the secret half is the api_secret credential slot.
metrics_enabledbooleanfalsenoTurns on the server's own metrics, in the Prometheus format, on a port of their own, 6789, and publishes their address as `metrics_endpoint`; while false that key is empty. The metrics port checks no caller, so anything that reaches it can read them.

Operator sizing

Infrastructure sizing the operator tunes per environment.

NameTypeDefaultRequiredDescription
portinteger (min 1024, max 65535)7880noSignalling and API port. Clients open their WebSocket session here and the server APIs answer on it. Most operators should omit this and let the Recipe assign the default (7880).
rtc_tcp_portinteger (min 1024, max 65535)7881noTCP port carrying WebRTC media for clients whose network blocks UDP. It is a fallback path rather than the ordinary one, and it stays declared so such a client still connects.
rtc_udp_portinteger (min 1024, max 65535)7882noSingle UDP port all WebRTC media is multiplexed onto. It is declared as a container port and fronted by the Service, so it is the media path a Release reaches with no further host configuration. It carries the media while the two range bounds below are unset; setting both of them selects the range instead, and this port is then neither configured nor declared.
rtc_port_range_startinteger (min 1024, max 65535)—noFirst port of the contiguous UDP range the server draws a per-connection media port from. Set it together with rtc_port_range_end — the server reads the range only when both bounds are present, and carries media on the multiplexed rtc_udp_port when either is missing. A range gives each connection its own socket rather than multiplexing every connection onto one, which raises the media throughput a single server sustains. The ports in it are configuration the server reads rather than ports the component declares — they are not container ports and no Service fronts them, so they carry client traffic only where the pod uses the node's own network and the range is open on the node's firewall.
rtc_port_range_endinteger (min 1024, max 65535)—noLast port of the contiguous UDP media range, inclusive, and greater than rtc_port_range_start. Set it together with rtc_port_range_start — the server reads the range only when both bounds are present.
engine_versionstringv1.13.6noServer container image tag. Selects the image tag on container targets.
log_levelstring (debug | info | warn | error)infonoServer log verbosity.
computeobject—no—
overridesobject (open)—noProvider-specific overrides. Accepts any nested structure. Each Recipe documents which keys it reads.

Output contract

Values this component publishes to consumers over the uses topology.

NameTypeDefaultRequiredDescription
hoststring—yesIn-cluster DNS name of the Service carrying signalling. A client opens its session against this name together with `port`; the media ports are a separate path and are not published here.
portinteger—yesTCP port that Service accepts signalling and API requests on. It carries the signalling port an operator set, never one of the media ports.
protocolstring—noHow the published address is spoken to — `ws`, since a client opens a WebSocket signalling session before any media flows.
api_keystring—noPublic identifier of the API key pair, which a consumer sends when it mints an access token. It is the naming half of the pair; the secret half arrives through the credential attached to the component's api_secret slot, and a consumer presents the same secret as `credential` on the connection that reaches this server.
metrics_endpointstring—noThe full address Prometheus scrapes this component's metrics at — scheme, host, port and path, `http://<host>:6789/metrics`. Empty while values.metrics_enabled is false.

Uses sockets

The dependency sockets this component connects through. The target of every connection wired through a socket must satisfy its label selector, and each connection may carry an attachment in the slots the socket declares. A required slot is owed by each connection the Aggregate or the Release wires through the socket.

state_store

Selector
component.aggrega.ai/category=datastore
Inject
env

Slots each connection through this socket may fill

SlotSelectorRequiredInjectSensitiveDescription
server_cafeature.aggrega.ai/kind=secretnofileyesOptional authority the server checks the store's certificate against while the store publishes protocol valkey-tls or redis-tls, where the image does not already trust the authority that signs it. Its Secret holds ca.crt. The Recipe mounts the whole Secret read-only and names the file in the server's store settings. The build halts on a server_ca publishing no Secret name, and on one wired to a store served without TLS. Fill it with core/referenced-secret.

Attachment slots

Named binding points at which a Feature attaches to this component. A slot's selector constrains which Feature may fill it and its inject list names how the Feature's material may be delivered. A required slot must be bound on every instance, by an attachment on the instance or at a scope above it, and a sensitive slot is declared to handle secret material. A Feature may also attach under a name no slot declares.

SlotSelectorRequiredInjectSensitiveDescription
api_secretfeature.aggrega.ai/kind=secretyesenvyesSigning secret paired with the api_key identifier. The server issues and validates client access tokens with it, so every client of this server holds the same pair.

Self-inject allowlist

env

Relationships

Typed edges to and from other published entities. A reference with no published target renders as a broken edge rather than a link.

Uses

Used by

Component concept reference →

The Aggrega catalog — an open index of components, features, recipes, and the plugins that render them.

Built with the shared Aggrega design system.

Privacy