百科.dev
全部条目在线工具AI 编程趋势榜开源项目技术资讯提交条目
登录
< 返回工具列表
E

egress

> 编程语言
开源

导出和记录 WebRTC 会话和轨迹

354 stars0 点赞0 次浏览
访问官网GitHub

工具介绍

导出和记录 WebRTC 会话和轨迹

LiveKit Egress

WebRTC is fantastic for last-mile media delivery, but interoperability with other services can be challenging. An application may want to do things like store a session for future playback, relay a stream to a CDN, or process a track through a transcription service – workflows where media travels through a different system or protocol. LiveKit Egress is the solution to these interoperability challenges. It provides a consistent set of APIs that gives you universal export of your LiveKit sessions and tracks.

Capabilities

  1. Room composite for exporting an entire room.
  2. Web egress for recordings that aren't attached to a single LiveKit room.
  3. Track composite for exporting synchronized tracks of a single participant.
  4. Track egress for exporting individual tracks.

Depending on your request type, the egress service will either launch Chrome using a web template (room composite requests) or a supplied url (web requests), or it will use the Go SDK directly (track and track composite requests). Irrespective of method used, when moving between protocols, containers or encodings, LiveKit's egress service will automatically transcode streams for you using GStreamer.

Supported Output

Egress Type MP4 File OGG File WebM File HLS (TS Segments) RTMP(s) Stream SRT Stream WebSocket Stream Thumbnails (JPEGs)
Room Composite ✅ ✅ ✅ ✅ ✅ ✅
Web ✅ ✅ ✅ ✅ ✅ ✅
Track Composite ✅ ✅ ✅ ✅ ✅ ✅
Track ✅ ✅ ✅ ✅

Files can be uploaded to any S3 compatible storage, Azure, or GCP.

Documentation

Full docs available here

Config

The Egress service takes a yaml config file:

…

The config file can be added to a mounted volume with its location passed in the EGRESS_CONFIG_FILE env var, or its body can be passed in the EGRESS_CONFIG_BODY env var.

Compatibility note on psrpc.compression

Bus compression requires psrpc v0.7.6 or newer on every node sharing the redis bus. An older peer ignores the compression marker and decodes the gzipped bytes as the message payload, so the message is dropped without an error. Enabling it is therefore a two-stage operator action: roll a build with psrpc v0.7.6+ out to livekit-server, egress, ingress, SIP and any agent workers first, then raise quality at the publishers. It is off by default.

max_decompressed_size only affects reading, so it can be set ahead of quality.

The remaining rpc.PSRPCConfig keys (max_attempts, timeout, backoff, buffer_size) are accepted under psrpc: for config parity with livekit-server, but egress does not read them.

Filenames

The below templates can also be used in filename/filepath parameters:

Egress Type {room_id} {room_name} {time} {utc} {publisher_identity} {track_id} {track_type} {track_source}
Room Composite ✅ ✅ ✅ ✅
Web ✅ ✅
Track Composite ✅ ✅ ✅ ✅ ✅
Track ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅
  • If no filename is provided with a request, one will be generated in the form of "{room_name}-{time}".
  • If your filename ends with a /, a file will be generated in that directory.
  • For 1/2/2006, 3:04:05.789 PM, {time} format would display "2006-01-02T150405", and {utc} format "20060102150405789"

Examples:

Request filename Resulting filename
"" testroom-2022-10-04T011306.mp4
"livekit-recordings/" livekit-recordings/testroom-2022-10-04T011306.mp4
"{room_name}/{time}" testroom/2022-10-04T011306.mp4
"{room_id}-{publisher_identity}.mp4" 10719607-f7b0-4d82-afe1-06b77e91fe12-david.mp4
"{track_type}-{track_source}-{track_id}" audio-microphone-TR_SKasdXCVgHsei.ogg

Running locally

These changes are not recommended for a production setup.

To run against a local livekit server, you'll need to do the following:

  • open /usr/local/etc/redis.conf and comment out the line that says bind 127.0.0.1
  • change protected-mode yes to protected-mode no in the same file
  • find your IP as seen by docker
    • ws_url needs to be set using the IP as Docker sees it
    • on linux, this should be 172.17.0.1
    • on mac or windows, run docker run -it --rm alpine nslookup host.docker.internal and you should see something like Name: host.docker.internal Address: 192.168.65.2

These changes allow the service to connect to your local redis instance from inside the docker container.

Create a directory to mount. In this example, we will use ~/egress-test.

Create a config.yaml in the above directory.

  • redis and ws_url should use the above IP instead of localhost
  • insecure should be set to true
yaml
log_level: debug
api_key: your-api-key
api_secret: your-api-secret
ws_url: ws://192.168.65.2:7880
insecure: true
redis:
  address: 192.168.65.2:6379

Then to run the service:

bash
docker run --rm \
    -e EGRESS_CONFIG_FILE=/out/config.yaml \
    -v ~/egress-test:/out \
    livekit/egress

You can then use our cli to submit egress requests to your server.

Chrome sandboxing

By default, Room Composite and Web egresses run with Chrome sandboxing disabled. This is because the default docker security settings prevent Chrome from switching to a different kernel namespace, which is needed by Chrome to setup its sandbox.

Chrome sandboxing within Egress can be reenabled by setting the the enable_chrome_sandbox option to true in the egress configuration, and launching docker using the provided seccomp security profile:

bash
docker run --rm \
    -e EGRESS_CONFIG_FILE=/out/config.yaml \
    -v ~/egress-test:/out \
    --security-opt seccomp=chrome-sandboxing-seccomp-profile.json \
    livekit/egress

This profile is based on the default docker seccomp security profile and allows the 2 extra system calls (clone and unshare) that Chrome needs to setup the sandbox.

Note that kubernetes disables seccomp entirely by default, which means that running with Chrome sandboxing enabled is possible on a kubernetes cluster with the default security settings.

FAQ

Can I store the files locally instead of uploading to cloud storage?

  • Yes, you can mount a volume with your docker run command (e.g. -v ~/livekit-egress:/out/), and use the mounted directory in your filenames (e.g. /out/my-recording.mp4). Since egress is not run as the root user, write permissions will need to be enabled for all users.

I get a "no response from egress service" error when sending a request

  • Your livekit server cannot connect to an egress instance through redis. Make sure they are both able to reach the same redis db.
  • If all of your egress instances are full, you'll need to deploy more instances or set up autoscaling.

I get a different error when sending a request

  • Make sure your egress, livekit, server sdk, and livekit-cli are all up to date.

Can I run this without docker?

  • It's possible, but not recommended. To do so, you would need to install gstreamer along with its plugins, chrome, xvfb, and have a pulseaudio server running.

Testing and Development

To run the test against your own LiveKit rooms, a deployed LiveKit server with a secure websocket url is required. First, create egress/test/config.yaml:

yaml
log_level: debug
api_key: your-api-key
api_secret: your-api-secret
ws_url: wss://your-livekit-url.com
redis:
  address: 192.168.65.2:6379
room_only: false
web_only: false
track_composite_only: false
track_only: false
file_only: false
stream_only: false
segments_only: false
dot_files: false
short: false

Join a room using https://example.livekit.io or your own client, then run mage integration test/config.yaml. This will test recording different file types, output settings, and streams against your room.

LiveKit Ecosystem

Agents SDKsPython · Node.js

LiveKit SDKsBrowser · Swift · Android · Flutter · React Native · Rust · Node.js · Python · Unity · Unity (WebGL) · ESP32 · C++

Starter AppsPython Agent · TypeScript Agent · React App · SwiftUI App · Android App · Flutter App · React Native App · Web Embed

UI ComponentsReact · Android Compose · SwiftUI · Flutter

Server APIsNode.js · Golang · Ruby · Java/Kotlin · Python · Rust · PHP (community) · .NET (community)

ResourcesDocs · Docs MCP Server · CLI · LiveKit Cloud

LiveKit Server OSSLiveKit server · Egress · Ingress · SIP

CommunityDeveloper Community · Slack · X · YouTube

Issues· 0 开放

查看全部 Issues在 GitHub 打开

暂无开放 Issues,或尚未同步最近议题。

> 标签

Go

暂无评论,来聊聊你的看法吧

> 工具信息

发布日期2026年8月1日
最后更新2026年9月17日
分类编程语言
定价开源

> 相关工具

T
TypeScript
JavaScript 的超集,为前端与全栈提供静态类型
P
Python
通用编程语言,广泛用于 Web、数据与 AI
G
Go
Google 推出的简洁高效系统语言