e4e292d988
* Do not send connection quality when participant is not active. Some times when the connection takes a while (in a long delay network on Safari for example), connection quality arrives before connectivity. * Do not calculate connection quality of unconnected participants
LiveKit - Open source, high performance WebRTC infrastructure
LiveKit is an open source project that provides scalable, multi-user conferencing over WebRTC. It's designed to give you everything you need to build real time video/audio/data capabilities in your applications.
LiveKit is written in Go, using the awesome Pion WebRTC implementation.
Features
- Scalable, distributed WebRTC SFU (Selective Forwarding Unit)
- Modern, full-featured client SDKs for JS, React, iOS, Android, and Flutter
- Built for production - JWT authentication and server APIs
- Robust networking & connectivity. UDP/TCP/TURN
- Easy to deploy - single binary, docker & kubernetes
- Advanced features - speaker detection, simulcast, selective subscription, moderation APIs, and webhooks.
Documentation & Guides
Docs & Guides at: 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:
Server SDKs:
- Javascript (docs)
- Go (docs)
- Ruby
Tools:
- livekit-cli: command line admin & tools
- chrometester: load testing with headless-Chrome bots
- docker image
Quickstart
Generate config file and keys
docker run --rm -v$PWD:/output livekit/generate --local
The above command generates a livekit.yaml that can be used to start LiveKit. It'll contain an API key/secret pair
that can be used with your LiveKit install.
Starting with docker
docker run --rm -p 7880:7880 \
-p 7881:7881 \
-p 7882:7882/udp \
-v $PWD/livekit.yaml:/livekit.yaml \
livekit-server \
--config /livekit.yaml \
--node-ip <machine-ip>
When running with docker, --node-ip needs to be set to your machine's IP address. If the service is to be exposed to
public internet, this should the machine's public IP.
Test with example app
Head over to the example app and enter the generated token to connect to your LiveKit server. This app is built with our React SDK.
Once connected, your video and audio are now published to the newly set-up LiveKit instance!
Generating access tokens (JWT)
For additional users in the room, you'll have to create a token for each participant. Learn more about access tokens.
livekit-server provides a convenient subcommand to create a development token. This token has an expiration of a
month, which is useful for development & testing, but not appropriate for production use.
docker run --rm -e LIVEKIT_KEYS="<api-key>: <api-secret>" \
livekit/livekit-server create-join-token \
--room "<room-name>" \
--identity "<participant-identity>"
Deploying to server
Deployment Docs: https://docs.livekit.io/guides/deploy
Single node server
Use our deploy config generator to set up a single node deployment with automatic TLS termination and built-in TURN.
It includes a cloud-init script that's supported by most cloud environments.
docker run --rm -it -v$PWD:/output livekit/generate
Kubernetes
We publish a helm chart that helps you to set up a cluster with high availability. For detailed instructions, see Kubernetes guide
Building from source
Pre-requisites:
- Go 1.15+ is installed
- GOPATH/bin is in your PATH
Then run
git clone https://github.com/livekit/livekit-server
cd livekit-server
./bootstrap.sh
mage
Contributing
We welcome your contributions to make LiveKit better! Please join us on Slack to discuss your ideas and/or submit PRs.
License
LiveKit server is licensed under Apache License v2.0.