Jitsi Magnify

An authentication, room and meeting management system for Jitsi based on Django/React.

Jitsi Magnify is built with ReactJS for the frontend, and Django for the backend.

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 sudo but this can be avoided by assigning your user to the docker group.

Project bootstrap

The easiest way to start working on the project is to use our Makefile :

$ make bootstrap

This command builds the app container, installs dependencies and performs database migrations. It's a good idea to use this command each time you are pulling code from the project repository to avoid dependency-releated or migration-releated issues.

When the command stops, check that all services are running as expected:

$ docker-compose ps

You should now be able to access the demo site at localhost:8070.

Finally, you can see all available commands in our Makefile with :

$ make help

Django admin

You can access the Django admin site at localhost:8071/admin.

To access the Django admin, you will first need to create a superuser account:

$ make superuser

Running Magnify in production

Configure a Jitsi instance

Before running Magnify, you will need a Jitsi instance with JWT authentication activated:

ENABLE_AUTH=1
AUTH_TYPE=jwt
JWT_APP_ID=magnify
JWT_APP_SECRET={JWT_JITSI_APP_SECRET}

In the Prosody configuration, you should also set the variable: XMPP_DOMAIN={JWT_JITSI_XMPP_DOMAIN}.

The JWT_JITSI_APP_SECRET and JWT_JITSI_XMPP_DOMAIN variables should be set to the same value in your Jitsi instance and in Magnify.

Configure Magnify

The easiest way to run Magnify in production is to use the official Docker image.

Configuration is done via environment variables as detailed in our configuration guide.

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.

We try to raise our code quality standards and expect contributors to follow the recommandations from our handbook.

License

This work is released under the MIT License (see LICENSE).