# 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](https://github.com/pion/webrtc) implementation. [![GitHub stars](https://camo.githubusercontent.com/a91018cba0264653ac3358bee2b1b9c89330b579e67d9b4bc84fa5ed5a09fb59/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f73746172732f6c6976656b69742f6c6976656b69743f7374796c653d736f6369616c266c6162656c3d53746172266d61784167653d32353932303030)](https://github.com/livekit/livekit/stargazers/) [![Slack community](https://camo.githubusercontent.com/4effff9cb91569d7aeb071a1324cd2f9dc282e8d9ce420b36a7a3ef19cdeb92c/68747470733a2f2f696d672e736869656c64732e696f2f656e64706f696e743f75726c3d68747470732533412532462532466c6976656b69742e696f253246626164676573253246736c61636b)](https://livekit.io/join-slack) [![Twitter Follow](https://camo.githubusercontent.com/2eba51e863c2eca7e3aece79a9e1022bea9c6aa7934d0d9abac492bf53fcc56c/68747470733a2f2f696d672e736869656c64732e696f2f747769747465722f666f6c6c6f772f6c6976656b6974746564)](https://twitter.com/livekitted) [![GitHub release (latest SemVer)](https://camo.githubusercontent.com/0f964575e913e651945839277798aae8f9c7751c5d827312e1bc41da689eca3e/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f762f72656c656173652f6c6976656b69742f6c6976656b6974)](https://github.com/livekit/livekit/releases/latest) [![GitHub Workflow Status](https://camo.githubusercontent.com/63750cf3f4e6b2d9b17dd6aaa5350f338b2a267080c5e4549d481a567bb7368e/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f776f726b666c6f772f7374617475732f6c6976656b69742f6c6976656b69742f54657374)](https://github.com/livekit/livekit/actions/workflows/buildtest.yaml) [![License](https://camo.githubusercontent.com/f4e0a0d2315c4aa5b27aff6be909155250a5d67677b1da6b8aa194ef8d7bc079/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f6c6976656b69742f6c6976656b6974)](https://github.com/livekit/livekit/raw/master/LICENSE) ## Features - 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](https://docs.livekit.io/guides/room/receive/#speaker-detection) - [simulcast](https://docs.livekit.io/guides/room/publish/#video-simulcast) - [end-to-end optimizations](https://blog.livekit.io/livekit-one-dot-zero/) - [selective subscription](https://docs.livekit.io/guides/room/receive/#selective-subscription) - [moderation APIs](https://docs.livekit.io/guides/server-api/) - [webhooks](https://docs.livekit.io/guides/webhooks/) - [distributed and multi-region](https://docs.livekit.io/deploy/distributed/) ## Documentation & Guides https://docs.livekit.io ## Try it live Head to [our playground](https://livekit.io/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](https://docs.livekit.io/guides/access-tokens/), call [server APIs](https://docs.livekit.io/guides/server-api/), and receive [webhooks](https://docs.livekit.io/guides/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](https://github.com/livekit/server-sdk-go) | [docs](https://pkg.go.dev/github.com/livekit/server-sdk-go) | | JavaScript (TypeScript) | [server-sdk-js](https://github.com/livekit/server-sdk-js) | [docs](https://docs.livekit.io/server-sdk-js/) | | Ruby | [server-sdk-ruby](https://github.com/livekit/server-sdk-ruby) | | | Python (community) | [tradablebits/livekit-server-sdk-python](https://github.com/tradablebits/livekit-server-sdk-python) | | | PHP (community) | [agence104/livekit-server-sdk-php](https://github.com/agence104/livekit-server-sdk-php) | | ### Ecosystem & Tools - [Egress](https://github.com/livekit/egress) - export and record your rooms - [CLI](https://github.com/livekit/livekit-cli) - command line interface & load tester - [Docker image](https://hub.docker.com/r/livekit/livekit-server) - [Helm charts](https://github.com/livekit/livekit-helm) ## Install We recommend installing [livekit-cli](https://github.com/livekit/livekit-cli) along with the server. It lets you access server APIs, create tokens, and generate test traffic. ### MacOS ```shell brew install livekit ``` ### Linux ```shell curl -sSL https://get.livekit.io | bash ``` ### Windows Download the [latest release here](https://github.com/livekit/livekit/releases/latest) ## 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](https://docs.livekit.io/deploy/) ### Creating access token A user connecting to a LiveKit room requires an [access token](https://docs.livekit.io/guides/access-tokens/). Access tokens (JWT) encode the user's identity and the room permissions they've been granted. You can generate a token with our CLI: ```shell 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](https://example.livekit.io) and enter a generated token to connect to your LiveKit server. This app is built with our [React SDK](https://github.com/livekit/livekit-react). Once connected, your video and audio are now being published to your new LiveKit instance! ### Simulating a test publisher ```shell 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. ## Deploying to a server Read our [deployment docs](https://docs.livekit.io/deploy/) for more information. ## Building from source Pre-requisites: - Go 1.16+ is installed - GOPATH/bin is in your PATH Then run ```shell 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](http://livekit.io/join-slack) to discuss your ideas and/or PRs. ## License LiveKit server is licensed under Apache License v2.0.