/jitsi-keycloak

Login to jitsi with keycloak https://github.com/d3473r/jitsi-keycloak/pkgs/container/jitsi-keycloak

Primary LanguageJavaScriptMIT LicenseMIT

jitsi-keycloak

Build Status Latest Version Docker Pulls Docker Image Size (tag)

Installation

  • npm install

Configuration

Keycloak

  • Add a public openid-connect client in your keycloak realm

  • Download the keycloak.json file for your client and put it in the config directory.

  • Allow this app from keycloak (jitsi-keycloak running on https://auth.meet.example.com):

    keycloak

  • If you want to have an avatar displayed in jitsi you can add an avatar custom attribute in keycloak to your desired users:

    avatar

Jitsi

  • Set ENABLE_AUTH=1, AUTH_TYPE=jwt and JWT_APP_ID=jitsi in your jitsi environment
  • Set JWT_APP_SECRET to a random string (e.g. node -e "console.log(require('crypto').randomBytes(24).toString('base64'));")
  • To enable an automatic redirect from jitsi to login set the url of this container TOKEN_AUTH_URL=https://auth.example.com/{room}
  • To enable the guest lobby feature for every new room add XMPP_MODULES=muc_lobby_rooms,persistent_lobby and XMPP_MUC_MODULES=lobby_autostart,token_lobby_bypass. This will enable these two plugins: https://github.com/jitsi-contrib/prosody-plugins/tree/main/lobby_autostart and https://github.com/jitsi-contrib/prosody-plugins/tree/main/token_lobby_bypass. The lobby_bypass attribute is automatically enabled for every logged in user.

Replace the following placeholders in app.js or pass them as environment variables:

  • JITSI_SECRET with the shared secret from jitsi JWT_APP_SECRET.
  • DEFAULT_ROOM with a default room name e.g. meeting
  • JITSI_URL with the url of your jitsi server e.g. https://meet.example.com

(OPTIONAL) Replace the following placeholders in app.js or pass them as environment variables:

  • ALLOWED_SUB with the allowed sub, the default is *
  • ALLOWED_ROOM with the allowed room, the default is *

Run

  • npm run dev

Build with docker

  • docker build -t jitsi-keycloak .

Run with docker

  • docker run -it --rm -p 3000:3000 -v $(pwd)/config:/config jitsi-keycloak

Run with docker-compose in example directory

  • docker-compose up -d