Scalable, high-performance WebRTC SFU. SDKs in JavaScript, React, React Native, Flutter, Swift, Kotlin, Unity/C#, Go, Ruby and Node.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Raja Subramanian 2671493870
Use purely RR based RTT. (#1351)
10 hours ago
.github Update dominikh/staticcheck-action action to v1.3.0 (#1285) 4 weeks ago
.idea Added logging fields for Ingress & Egress services (#1205) 2 months ago
cmd/server add memory used and total to node stats (#1293) 3 weeks ago
deploy Stats collect v2 (#1291) 3 weeks ago
pkg Use purely RR based RTT. (#1351) 10 hours ago
test Add stats for data channel and signal (#1198) 2 months ago
tools SubscribedQualityUpdate message (#270) 1 year ago
version version 1.3.3 (#1289) 3 weeks ago
.gitignore Release with GoReleaser. Allow start without key configuration (#788) 7 months ago
.goreleaser.yaml Switch release CI to build on Linux (#827) 7 months ago
CHANGELOG version 1.3.3 (#1289) 3 weeks ago
Dockerfile Update golang Docker tag to v1.19 (#905) 6 months ago
LICENSE update license & readme 2 years ago
README.md Update README.md (#1310) 2 weeks ago
bootstrap.sh cleanup protoc (#100) 1 year ago
config-sample.yaml Add ice mdns config (#1311) 2 weeks ago
go.mod Use purely RR based RTT. (#1351) 10 hours ago
go.sum Use purely RR based RTT. (#1351) 10 hours ago
install-livekit.sh don't assume uname in /usr/bin/ (#1138) 3 months ago
magefile.go Ingress psrpc (#1295) 3 weeks ago
magefile_unix.go Fix magefile compatibility with Windows (#538) 11 months ago
magefile_windows.go Fix magefile compatibility with Windows (#538) 11 months ago
renovate.json Configure Renovate (#879) 6 months ago

README.md

LiveKit: High-performance WebRTC

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 awesome Pion WebRTC implementation.

GitHub stars Slack community Twitter Follow GitHub release (latest SemVer) GitHub Workflow Status License

Features

Documentation & Guides

https://docs.livekit.io

Try it live

Head to our playground and give it a spin. Build a Zoom-like conferencing app in under 100 lines of code!

SDKs & Tools

Client SDKs

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

Language Repo Declarative UI Links
JavaScript (TypeScript) client-sdk-js React docs | JS example | React example
Swift (iOS / MacOS) client-sdk-swift Swift UI docs | example
Kotlin (Android) client-sdk-android Compose docs | example | Compose example
Flutter client-sdk-flutter native docs | example
Unity WebGL client-sdk-unity-web docs
React Native (beta) client-sdk-react-native native

Server SDKs

Server SDKs enable your backend to generate access tokens, call server APIs, and receive webhooks. In addition, the Go SDK includes client capabilities, enabling you to build automations that behave like end-users.

Language Repo Docs
Go server-sdk-go docs
JavaScript (TypeScript) server-sdk-js docs
Ruby server-sdk-ruby
Java (Kotlin) server-sdk-kotlin
Python (community) tradablebits/livekit-server-sdk-python
PHP (community) agence104/livekit-server-sdk-php

Ecosystem & Tools

Install

We recommend installing livekit-cli along with the server. It lets you access server APIs, create tokens, and generate test traffic.

MacOS

brew install livekit

Linux

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

Windows

Download the latest release here

Getting Started

Starting LiveKit

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

API Key: devkey
API Secret: secret

To customize your setup for production, refer to our deployment docs

Creating access token

A user connecting to a LiveKit room requires an access token. Access tokens (JWT) encode the user's identity and the room permissions they've been granted. You can generate a token with our CLI:

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

Test with example app

Head over to our example app and enter a generated token to connect to your LiveKit server. This app is built with our React SDK.

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

Simulating a test publisher

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

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 the simulation.

Deployment

Use LiveKit Cloud

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

Sign up for LiveKit Cloud.

Self-host

Read our deployment docs for more information.

Building from source

Pre-requisites:

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

Then run

git clone https://github.com/livekit/livekit
cd livekit
./bootstrap.sh
mage

Contributing

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

License

LiveKit server is licensed under Apache License v2.0.