Repository files navigation

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.

LiveKit's server is written in Go, using the awesomePion WebRTC implementation.

• Scalable, distributed WebRTC SFU (Selective Forwarding Unit)
• Modern, full-featured client SDKs
• Built for production, supports JWT authentication
• Robust networking and connectivity, UDP/TCP/TURN
• Easy to deploy: single binary, Docker or Kubernetes
• Advanced features including:
  • speaker detection
  • simulcast
  • end-to-end optimizations
  • selective subscription
  • moderation APIs
  • end-to-end encryption
  • SVC codecs (VP9, AV1)
  • webhooks
  • distributed and multi-region

https://docs.livekit.io

• LiveKit Meet (source)
• Spatial Audio (source)
• Livestreaming from OBS Studio (source)
• AI voice assistant using ChatGPT (source)

• Agents: build real-time multimodal AI applications with programmable backend participants
• Egress: record or multi-stream rooms and export individual tracks
• Ingress: ingest streams from external sources like RTMP, WHIP, HLS, or OBS Studio

Client SDKs enable your frontend to include interactive, multi-user experiences.

Server SDKs enable your backend to generateaccess tokens,callserver APIs, andreceivewebhooks. In addition, the Go SDK includes client capabilities,enabling you to build automations that behave like end-users.

• CLI - command line interface & load tester
• Docker image
• Helm charts

The following will install LiveKit's media server:

brew install livekit

curl -sSL https://get.livekit.io| bash

Download thelatest release here

Start LiveKit in development mode by runninglivekit-server --dev. It'll use a placeholder API key/secret pair.

API Key: devkeyAPI Secret: secret

To customize your setup for production, refer to ourdeployment docs

A user connecting to a LiveKit room requires anaccess token. Accesstokens (JWT) encode the user's identity and the room permissions they've been granted. You can generate a token with ourCLI:

lk token create \    --api-key devkey --api-secret secret \    --join --room my-first-room --identity user1 \    --valid-for 24h

Head over to ourexample app and enter a generated token to connect to your LiveKitserver. This app is built with ourReact SDK.

Once connected, your video and audio are now being published to your new LiveKit instance!

lk room join \    --url ws://localhost:7880 \    --api-key devkey --api-secret secret \    --identity bot-user1 \    --publish-demo \    my-first-room

This command publishes a looped demo video to a room. Due to how the video clip was encoded (keyframes every 3s),there's a slight delay before the browser has sufficient data to begin rendering frames. This is an artifact of thesimulation.

LiveKit Cloud is the fastest and most reliable way to run LiveKit. Every project gets free monthly bandwidth andtranscoding credits.

Sign up forLiveKit Cloud.

Read ourdeployment docs for more information.

Pre-requisites:

• Go 1.23+ is installed
• GOPATH/bin is in your PATH

Then run

git clone https://github.com/livekit/livekitcd livekit./bootstrap.shmage

We welcome your contributions toward improving LiveKit! Please join uson Slack to discuss your ideas and/or PRs.

LiveKit server is licensed under Apache License v2.0.