0c55f4a6e1
LiveKit offers Universal Egress, designed to provide universal exports of LiveKit sessions or tracks to a file or stream data. Egress is kept outside of the server to keep the load off the SFU and avoid impacting real-time audio or video performance/quality. Followed the "Running Locally" steps from the https://github.com/livekit/egress repository, but I adapted them to docker-compose. By default, I chose to run both the LiveKit server and the Egress when you up the stack. If we see any performance issue, we could only run the LiveKit server, which is the barebone of the product. Egress will be usefull only when dealing with recording/exporting data. Egress service will output file recordings to "./docker/livekit/out" Note: the Egress service doesn't run as root. You need to update the "/out" permissions, so all user could write to it.
Meet
Meet is a simple video and phone conferencing tool, powered by LiveKit.
Meet is built on top of Django Rest Framework and Vite.js.
Getting started
Prerequisite
Make sure you have a recent version of Docker and Docker Compose installed on your laptop:
$ docker -v
Docker version 20.10.2, build 2291f61
$ docker compose -v
docker compose version 1.27.4, build 40524192
⚠️ You may need to run the following commands with
sudobut this can be avoided by assigning your user to thedockergroup.
Project bootstrap
The easiest way to start working on the project is to use GNU Make:
$ make bootstrap FLUSH_ARGS='--no-input'
Then you can access to the project in development mode by going to http://localhost:3000. You will be prompted to log in, the default credentials are:
username: meet
password: meet
This command builds the app container, installs dependencies, performs
database migrations and compile translations. It's a good idea to use this
command each time you are pulling code from the project repository to avoid
dependency-related or migration-related issues.
Your Docker services should now be up and running 🎉
[FIXME] Explain how to run the frontend project.
Adding content
You can create a basic demo site by running:
$ make demo
Finally, you can check all available Make rules using:
$ make help
Django admin
You can access the Django admin site at http://localhost:8071/admin.
You first need to create a superuser account:
$ make superuser
Contributing
This project is intended to be community-driven, so please, do not hesitate to get in touch if you have any question related to our implementation or design decisions.
License
This work is released under the MIT License (see LICENSE).