Code Monkey home page Code Monkey logo

livekit-django-api's Introduction

django-livekit-api

livekitapi is a Django app to manage livekit conference rooms.

Detailed documentation is in the "docs" directory.

Quick start

  1. Add "livekitapi" and "guardian" to your INSTALLED_APPS setting like this:
    INSTALLED_APPS = [
        ...,
        "livekitapi",
        "guardian",
    ]
  1. Configure livekit info. You can use django-environ:
LIVEKIT_API_KEY=deadbeef
LIVEKIT_API_SECRET=secret
LIVEKIT_INSTANCE=meet-asdf.livekit.cloud
  1. Include the livekitapi URLconf in your project urls.py like this:
path('', include('livekitapi.urls')),
  1. Run python manage.py migrate to create the livekitapi models.

  2. Start the development server and visit http://127.0.0.1:8000/admin/ to create a room (you'll need the Admin app enabled).

  3. Visit http://127.0.0.1:8000/rooms/roomid to participate in an existing conference room.

For more details, refer to the provided example settings.py in the livekitapi_example project.

Permissions

django-livekit uses guardian for authorization. There are two distinct permissions you can give your users or groups:

  • livekitapi.JOIN_ROOM_PERM - this is only effective is the room has set is_open to False.
  • livekitapi.START_STOP_RECORDING_PERM - to be able to toggle room recording. By default, the room's owner has these permissions set.

Livekit control Server

The python livekit api doesn't allow to control the egress server (as far as I know). You can use the small livekit-minio utility for this. That repo also has a second utility for sharing the resulting file with a Nextcloud chat, please refer to the README.

livekit-django-api's People

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.