Jitsi Meet Handbook

https://jitsi.github.io/handbook/docs/
Admin
Jitsi is an easy-to-use, secure, state-of-the-art, open-source video conferencing platform built...
Tokens:92,669
Snippets:1,274
Trust Score:8.3
Update:1 month ago
Show doc for...
Tokens:
Raw
### Configure and Start Jitsi Meet Containers

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-windows

Prepare the Jitsi Meet environment by copying the example configuration, generating secure passwords, creating necessary directories, and starting the Docker containers in detached mode.

```bash
# Copy the example environment file
copy env.example .env

# Generate strong passwords (run this from a WSL2 or Git Bash terminal)
bash ./gen-passwords.sh

# Create required configuration directories
mkdir -p ~/.jitsi-meet-cfg/{web,transcripts,prosody/config,prosody/prosody-plugins-custom,jicofo,jvb,jigasi,jibri}

# Start the containers
docker compose up -d

```

--------------------------------

### Installation

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-flutter-sdk

Add the jitsi_meet_flutter_sdk dependency to your Flutter project and get the packages.

```APIDOC
## Installation

### Add dependency

Add the dependency from command-line
```
$ flutter pub add jitsi_meet_flutter_sdk
```

The command above will add this to the `pubspec.yaml` file in your project (you can do this manually):

```yaml
dependencies:
    jitsi_meet_flutter_sdk: ^0.1.7
```

### Install

Install the packages from the terminal:

```bash
$ flutter pub get
```

### Import files

Import the following files into your dart code:

```dart
import 'package:jitsi_meet_flutter_sdk/jitsi_meet_flutter_sdk.dart';
```
```

--------------------------------

### Install React SDK

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-react-sdk

Install the Jitsi Meet React SDK as a project dependency using npm.

```bash
npm install @jitsi/react-sdk  

```

--------------------------------

### Install jitsi-meet-tokens Package

Source: https://jitsi.github.io/handbook/docs/devops-guide/token-authentication

Install the necessary package for token authentication. This command also configures application ID and secret in Prosody.

```bash
apt-get install jitsi-meet-tokens  

```

--------------------------------

### Initialize environment configuration

Source: https://jitsi.github.io/handbook/docs/devops-guide/devops-guide-docker

Creates the .env file from the provided example.

```bash
cp env.example .env  
```

--------------------------------

### Install Flutter Packages

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-flutter-sdk

Run this command in the terminal to install all project dependencies, including the Jitsi Meet Flutter SDK.

```bash
$ flutter pub get  
```

--------------------------------

### Clone and Build Jitsi Meet

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-windows

Clones the Jitsi Meet repository into the Linux filesystem, installs the required Node.js version using nvm, installs project dependencies, and starts the development server.

```bash
# Navigate to your Linux home directory  
cd  
  
# Clone the Jitsi Meet repository  
git clone https://github.com/jitsi/jitsi-meet  
cd jitsi-meet  
  
# Install the Node.js version specified in the .nvmrc file  
nvm install  
  
# Switch to that version (nvm install usually does this automatically,  
# but running nvm use ensures the correct version is active)  
nvm use  
  
# Install dependencies  
npm install  
  
# Start the development server  
make dev  
```

--------------------------------

### Install iOS Pods

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-mobile-jitsi-meet

Navigate to the 'ios' directory and run this command to install the required CocoaPods dependencies. Ensure CocoaPods is installed first.

```bash
cd ios  
pod install  
cd ..  
```

--------------------------------

### Build and Install Debug APK

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-mobile-jitsi-meet

Builds the debug APK and installs it on the connected device, automatically starting the Metro bundler. The first build may take longer due to dependency downloads.

```bash
cd android  
./gradlew installDebug  
```

--------------------------------

### Install Main Dependencies (npm)

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-mobile-jitsi-meet

Run this command in the repository root to install the main JavaScript dependencies for the Jitsi Meet mobile app.

```bash
npm install  
```

--------------------------------

### Install Build Tools

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-windows

Installs essential build tools and Git, which are required for compiling native dependencies.

```bash
sudo apt install -y build-essential git  
```

--------------------------------

### Run Jitsi Meet with webpack-dev-server

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-web-jitsi-meet

Starts the Jitsi Meet development server. Ensure Node.js and npm are installed and dependencies are managed correctly.

```bash
make dev
```

--------------------------------

### Install and build lib-jitsi-meet from sources

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-ljm

Force installation of lib-jitsi-meet and build it from sources. This command ensures that the project uses the local source code.

```bash
npm install lib-jitsi-meet --force && make
```

--------------------------------

### Start Recording

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-iframe-functions

Starts a file recording or streaming session.

```javascript
api.startRecording(options);  
```

--------------------------------

### Install Jitsi-Meet and Dependencies

Source: https://jitsi.github.io/handbook/docs/devops-guide/devops-guide-opensuse

Installs the Jitsi-Meet package along with essential dependencies such as Nginx (web server), Prosody (XMPP server), Lua, Jitsi Videobridge, and Jitsi Jicofo. This command installs the core components for a Jitsi-Meet deployment.

```bash
zypper install nginx prosody lua51-zlib jitsi-meet jitsi-videobridge jitsi-jicofo  

```

--------------------------------

### Start Metro Bundler (Android)

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-mobile-jitsi-meet

Start the Metro bundler from the repository root. The app will automatically connect to it once launched on the device.

```bash
npm start  
```

--------------------------------

### Install nvm

Source: https://jitsi.github.io/handbook/docs/devops-guide/file-sharing

Installs Node Version Manager (nvm) to manage Node.js versions. Run this script to download and execute the nvm installer.

```bash
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.4/install.sh | bash
```

--------------------------------

### Start the Electron App

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-electron-sdk

Run the Electron app after linking the local SDK. Changes in the SDK will be reflected after a rebuild if necessary.

```bash
npm start
```

--------------------------------

### Background Blur Effect Example

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-ljm-api

Example implementation of a background blur effect, including methods to check if the effect can be applied, start it, and stop it.

```javascript
const blurEffect = {
    isEnabled: (track) => track.isVideoTrack(),
    startEffect: (stream) => {
        // Apply blur and return processed stream
        return processedStream;
    },
    stopEffect: () => {
        // Release resources
    }
};

localVideoTrack.setEffect(blurEffect);

// Remove effect
localVideoTrack.setEffect(undefined);
```

--------------------------------

### Start Jitsi Meet with Log Analyser and Grafana

Source: https://jitsi.github.io/handbook/docs/devops-guide/devops-guide-log-analyser

Use this command to start Jitsi Meet components, log analysis tools (Loki, OpenTelemetry), and Grafana concurrently. This command combines multiple Docker Compose files for a complete stack setup.

```bash
docker-compose -f docker-compose.yml -f log-analyser.yml -f grafana.yml up -d
```

--------------------------------

### Install WSL2 and Ubuntu

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-windows

Installs WSL2 with Ubuntu as the default distribution. Restart your computer after installation. Then, update system packages within Ubuntu.

```bash
wsl --install
```

```bash
sudo apt update && sudo apt upgrade -y
```

--------------------------------

### Install Docker and Prepare Keycloak User

Source: https://jitsi.github.io/handbook/docs/devops-guide/authentication

Installs Docker CE and related packages on Ubuntu, then creates a dedicated 'keycloak' user with necessary permissions for Docker and Keycloak data.

```bash
curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.asc  
  
sudo chmod a+r /etc/apt/keyrings/docker.asc  
  
sudo tee /etc/apt/sources.list.d/docker.sources <<EOF  
Types: deb  
URIs: https://download.docker.com/linux/ubuntu  
Suites: $(. /etc/os-release && echo "${UBUNTU_CODENAME:-$VERSION_CODENAME}")  
Components: stable  
Signed-By: /etc/apt/keyrings/docker.asc  
EOF  
apt update  
  
apt install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin  
systemctl start docker  
  
sudo useradd -r -m -s /bin/bash keycloak  
sudo usermod -aG docker keycloak  
sudo mkdir -p /home/keycloak/keycloak-data   
sudo chown -R keycloak:keycloak /home/keycloak/keycloak-data  
sudo su - keycloak  

```

--------------------------------

### Setup Power Monitor in Main Process

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-electron-sdk

Enable the power monitor in the main electron process by calling setupPowerMonitorMain with the Jitsi Meet BrowserWindow instance.

```javascript
const {
    setupPowerMonitorMain
} = require("@jitsi/electron-sdk");

// jitsiMeetWindow - The BrowserWindow instance
// of the window where Jitsi Meet is loaded.
setupPowerMonitorMain(jitsiMeetWindow);
```

--------------------------------

### Install NPM Dependencies

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-android-sdk

Execute NPM in the jitsi-meet project directory to pull in SDK dependencies.

```bash
npm install
```

--------------------------------

### Clone and Build Jitsi Meet Electron SDK

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-electron-sdk

Clone the SDK repository, install dependencies, and build the project. This is the first step for local development.

```bash
git clone https://github.com/jitsi/jitsi-meet-electron-sdk
cd jitsi-meet-electron-sdk
npm install
npm run build
```

--------------------------------

### Deploy Jitsi Meet with optional components

Source: https://jitsi.github.io/handbook/docs/devops-guide/devops-guide-docker

Commands to start Jitsi Meet with various service configurations using Docker Compose.

```bash
docker compose -f docker-compose.yml -f jigasi.yml up  
```

```bash
docker compose -f docker-compose.yml -f etherpad.yml up  
```

```bash
docker compose -f docker-compose.yml -f whiteboard.yml up  
```

```bash
docker compose -f docker-compose.yml -f jibri.yml up -d  
```

```bash
docker compose -f docker-compose.yml -f jigasi.yml -f jibri.yml up -d  
```

```bash
docker compose -f docker-compose.yml -f transcriber.yml up -d  
```

```bash
docker compose -f docker-compose.yml -f transcriber.yml -f jigasi.yml -f jibri.yml up -d  
```

```bash
docker compose -f docker-compose.yml -f log-analyser.yml -f grafana.yml up -d  
```

--------------------------------

### Download and Extract Jitsi Docker Setup

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-windows

Use PowerShell to download the latest stable release of the Jitsi Docker setup and extract it to a local directory.

```powershell
# Download the latest stable release
Invoke-WebRequest -Uri $(
    (Invoke-RestMethod -Uri https://api.github.com/repos/jitsi/docker-jitsi-meet/releases/latest).assets |
    Where-Object { $_.name -like '*.zip' } |
    Select-Object -First 1 -ExpandProperty browser_download_url
) -OutFile jitsi-docker.zip

# Extract the archive
Expand-Archive -Path jitsi-docker.zip -DestinationPath jitsi-docker
cd jitsi-docker*

```

--------------------------------

### Install Jitsi Meet

Source: https://jitsi.github.io/handbook/docs/devops-guide/devops-guide-quickstart

Installs the Jitsi Meet package on Debian-based systems. Ensure you have sudo privileges. The installer handles Nginx/Apache configuration and may prompt for SSL/TLS certificate details.

```bash
sudo apt install jitsi-meet
```

--------------------------------

### startRecording

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-iframe-functions

Starts a file recording or streaming session.

```APIDOC
## api.startRecording(options)

### Description
Starts a file recording or streaming session.
```

--------------------------------

### Deploy changes to lib-jitsi-meet

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-ljm

Install lib-jitsi-meet with force and deploy local changes. Use this when making modifications to the library.

```bash
npm install lib-jitsi-meet --force && make deploy-lib-jitsi-meet
```

--------------------------------

### Start Broadcast and Initialize Screen Sharing

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-ios-sdk

This method is called when the broadcast starts. It posts a notification to signal the start of the broadcast and then calls openConnection to establish a socket connection. It also resets the frameCount for video frame processing.

```swift
override func broadcastStarted(withSetupInfo setupInfo: [String: NSObject]?) {
    frameCount = 0

    DarwinNotificationCenter.shared.postNotification(.broadcastStarted)
    openConnection()
}
```

--------------------------------

### Configure prejoin settings

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-configuration

Example object structure for configuring the prejoin screen behavior.

```javascript
prejoinConfig: {  
    enabled: true,  
    hideDisplayName: false,  
    hideExtraJoinButtons: ['no-audio', 'by-phone'],  
    preCallTestEnabled: false,  
    preCallTestICEUrl: '',  
    showHangUp: true  
}  
```

--------------------------------

### Verify Docker Installation

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-windows

Run these commands in PowerShell or Command Prompt to confirm Docker and Docker Compose are installed and accessible.

```bash
docker --version
docker compose version

```

--------------------------------

### Clone and Build Jitsi Meet

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-web-jitsi-meet

Clone the Jitsi Meet repository, install dependencies, and build the application for production or development.

```bash
git clone https://github.com/jitsi/jitsi-meet
cd ./jitsi-meet

npm install

# To build the Jitsi Meet production application:
make

# For development:
make dev
```

--------------------------------

### Setup Power Monitor in Render Process

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-electron-sdk

Enable the power monitor in the render electron process by calling setupPowerMonitorRender with the Jitsi Meet API instance.

```javascript
const {
    setupPowerMonitorRender
} = require("@jitsi/electron-sdk");

const api = new JitsiMeetExternalAPI(...);
setupPowerMonitorRender(api);
```

--------------------------------

### Install Android SDK Packages and Licenses

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-mobile-jitsi-meet

Use the 'sdkmanager' tool to install required Android SDK components and accept all licenses. This is necessary for building the Android app via the command line.

```bash
sdkmanager "platform-tools" "platforms;android-34" "build-tools;34.0.0"  
sdkmanager --licenses  
```

--------------------------------

### Setup Always On Top in Main Process

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-electron-sdk

Enable the always-on-top feature in the main electron process by calling setupAlwaysOnTopMain with the Jitsi Meet BrowserWindow instance.

```javascript
const {
    setupAlwaysOnTopMain
} = require("@jitsi/electron-sdk");

// jitsiMeetWindow - The BrowserWindow instance
// of the window where Jitsi Meet is loaded.
setupAlwaysOnTopMain(jitsiMeetWindow);
```

--------------------------------

### Start Keycloak Docker Compose

Source: https://jitsi.github.io/handbook/docs/devops-guide/authentication

Starts the Keycloak service in detached mode using Docker Compose and builds the image if necessary.

```bash
docker compose up -d --build  

```

--------------------------------

### Basic Receiver Constraints Example

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-ljm-api

Example of setting basic receiver constraints to limit the number of video streams and their default quality.

```javascript
conference.setReceiverConstraints({
    lastN: 20,
    defaultConstraints: { maxHeight: 360 }
});
```

--------------------------------

### Install Required Packages for LDAP Authentication

Source: https://jitsi.github.io/handbook/docs/devops-guide/ldap-authentication

Installs necessary packages on Debian systems for Cyrus SASL and LDAP integration with Prosody. Ensure Prosody is set up as per 'Authentication (Secure Domain)' first.

```bash
sudo apt-get install sasl2-bin libsasl2-modules-ldap lua-cyrussasl prosody-modules  
sudo prosodyctl install --server=https://modules.prosody.im/rocks/ mod_auth_cyrus  
```

--------------------------------

### Manage Second Screen Windows

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-iframe-commands

Examples for updating, closing, and positioning second screen windows on specific displays.

```javascript
// Put the main stage on the first external display.  
api.executeCommand('setSecondScreen', {  
    id: 'stage-screen',  
    source: { role: 'stage' }  
});  
  
// Same window, now showing the whiteboard.  
api.executeCommand('setSecondScreen', {  
    id: 'stage-screen',  
    source: { role: 'whiteboard' }  
});  
  
// Close it.  
api.executeCommand('setSecondScreen', { id: 'stage-screen' });  
```

```javascript
api.executeCommand('setSecondScreen', {  
    id: 'tv-left',  
    source: { role: 'stage' },  
    screen: 1  
});  
api.executeCommand('setSecondScreen', {  
    id: 'tv-right',  
    source: { role: 'tile' },  
    screen: 2  
});  
```

--------------------------------

### Obtain Let's Encrypt Certificates for TURN Server

Source: https://jitsi.github.io/handbook/docs/devops-guide/turn

This script automates the process of obtaining and installing Let's Encrypt certificates for your TURN server domain. It stops Nginx, issues the certificate using acme.sh, installs it, and then restarts Nginx. Ensure you have socat installed and replace placeholders with your actual domain and email.

```bash
systemctl stop nginx
DOMAIN="turn-jitsi-meet.example.com"
apt install socat
/opt/acmesh/.acme.sh/acme.sh -f --issue -d ${DOMAIN} --standalone --server letsencrypt
/opt/acmesh/.acme.sh/acme.sh -f --install-cert \
    -d ${DOMAIN} \
    --key-file /etc/jitsi/meet/${DOMAIN}.key \
    --fullchain-file /etc/jitsi/meet/${DOMAIN}.crt \
    --reloadcmd "/usr/share/jitsi-meet/scripts/coturn-le-update.sh ${DOMAIN}"
systemctl start nginx
```

--------------------------------

### Setup Connection and Handle Disconnects

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-ios-sdk

Configures the client connection to handle disconnections, including errors. If the connection drops, it finishes the broadcast with an appropriate error message.

```swift
func setupConnection() {
    clientConnection?.didClose = { [weak self] error in
        if let error = error {
            self?.finishBroadcastWithError(error)
        } else {
            // the displayed failure message is more user friendly when using NSError instead of Error
            let JMScreenSharingStopped = 10001
            let customError = NSError(domain: RPRecordingErrorDomain, code: JMScreenSharingStopped, userInfo: [NSLocalizedDescriptionKey: "Screen sharing stopped"])
            self?.finishBroadcastWithError(customError)
        }
    }
}

override init() {
    super.init()
    if let connection = SocketConnection(filePath: socketFilePath) {
      clientConnection = connection
      setupConnection()

      uploader = SampleUploader(connection: connection)
    }
}
```

--------------------------------

### Using JitsiMeetView

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-android-sdk

Provides an example of integrating `JitsiMeetView` directly into an Android Activity, including lifecycle management.

```APIDOC
## Using JitsiMeetView

### Description
This example demonstrates how to use `JitsiMeetView` directly within an Android Activity. It covers initialization, joining a conference, and essential lifecycle method overrides for proper resource management.

### Class Definition
```java
package org.jitsi.example;

import android.os.Bundle;
import android.support.v4.app.FragmentActivity;
import android.content.Intent;

import org.jitsi.meet.sdk.JitsiMeetView;
import org.jitsi.meet.sdk.JitsiMeetActivityDelegate;
import org.jitsi.meet.sdk.JitsiMeetConferenceOptions;

public class MainActivity extends FragmentActivity implements JitsiMeetActivityInterface {
    private JitsiMeetView view;

    @Override
    protected void onActivityResult(int requestCode, int resultCode, Intent data) {
        JitsiMeetActivityDelegate.onActivityResult(this, requestCode, resultCode, data);
    }

    @Override
    public void onBackPressed() {
        JitsiMeetActivityDelegate.onBackPressed();
    }

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);

        view = new JitsiMeetView(this);
        JitsiMeetConferenceOptions options = new JitsiMeetConferenceOptions.Builder()
            .setRoom("https://meet.jit.si/test123")
            .build();
        view.join(options);

        setContentView(view);
    }

    @Override
    protected void onDestroy() {
        super.onDestroy();
        if (view != null) {
            view.dispose();
            view = null;
        }
        JitsiMeetActivityDelegate.onHostDestroy(this);
    }

    @Override
    public void onNewIntent(Intent intent) {
        JitsiMeetActivityDelegate.onNewIntent(intent);
    }

    @Override
    public void onRequestPermissionsResult(final int requestCode, final String[] permissions, final int[] grantResults) {
        JitsiMeetActivityDelegate.onRequestPermissionsResult(requestCode, permissions, grantResults);
    }

    @Override
    protected void onResume() {
        super.onResume();
        JitsiMeetActivityDelegate.onHostResume(this);
    }

    @Override
    protected void onStop() {
        super.onStop();
        JitsiMeetActivityDelegate.onHostPause(this);
    }
}
```

### `JitsiMeetView.join(options)`

#### Description
Joins the conference specified by the given `JitsiMeetConferenceOptions`.

#### Parameters
- **options** (`JitsiMeetConferenceOptions`) - Required - The options for the conference to join.
```

```APIDOC
### `JitsiMeetView.dispose()`

#### Description
Releases all resources associated with this view. This method MUST be called when the Activity holding this view is going to be destroyed, usually in the `onDestroy()` method.

### Method
`dispose()`
```

--------------------------------

### Enable `saslauthd` Service for Boot and LDAP

Source: https://jitsi.github.io/handbook/docs/devops-guide/ldap-authentication

Configures `/etc/default/saslauthd` to start `saslauthd` at boot and use the LDAP mechanism. This uses `sed` for quick modification.

```bash
sudo sed -i -e "s/START=.*/START=yes/" -e "s/MECHANISMS=.*/MECHANISMS=\"ldap\"/" /etc/default/saslauthd  
```

--------------------------------

### Setup Screen Sharing in Main Process

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-electron-sdk

Configure screen sharing in the main electron process by calling setupScreenSharingMain with the BrowserWindow instance, application name, and macOS bundle ID.

```javascript
const {
    setupScreenSharingMain
} = require("@jitsi/electron-sdk");

// jitsiMeetWindow - The BrowserWindow instance of the window where Jitsi Meet is loaded.
// appName - Application name which will be displayed inside the content sharing tracking window
// i.e. [appName] is sharing your screen.
// osxBundleId - Mac Application bundleId for which screen capturer permissions will be reset if user denied them.
setupScreenSharingMain(mainWindow, appName, osxBundleId);
```

--------------------------------

### Deploy Transcription Service to Cloudflare

Source: https://jitsi.github.io/handbook/docs/devops-guide/transcription

Commands to initialize submodules, install dependencies, set secrets, and deploy the service to Cloudflare.

```bash
# check out the libopus submodule (one-time; the image builds it)  
git submodule update --init src/OpusDecoder/opus  
  
# install worker deps and authenticate  
cd worker  
npm install  
npx wrangler login  
  
# set backend API keys as Worker secrets  
npx wrangler secret put OPENAI_API_KEY --config ../wrangler-container.jsonc  
  
# deploy (builds locally, then deploys)  
cd ..  
npm run cf:deploy  
```

--------------------------------

### Create configuration directories

Source: https://jitsi.github.io/handbook/docs/devops-guide/devops-guide-docker

Sets up the required directory structure for persistent storage and logs.

```bash
mkdir -p ~/.jitsi-meet-cfg/{web,prosody/config,prosody/prosody-plugins-custom,jicofo,jvb,jigasi,jibri,transcriber}  
mkdir -p ~/.jitsi-meet-cfg/storage/{jibri,prosody,transcripts,web}  
mkdir -p ~/.jitsi-meet-cfg/tmp/{web-crontabs,web-load-test}  
chmod 777 ~/.jitsi-meet-cfg/storage/{jibri,prosody,transcripts,web}  
chmod 777 ~/.jitsi-meet-cfg/tmp/{web-crontabs,web-load-test}  
```

```powershell
$dirs = "web","prosody/config","prosody/prosody-plugins-custom","jicofo","jvb","jigasi","jibri","transcriber","storage/jibri","storage/prosody","storage/transcripts","storage/web","tmp/web-crontabs","tmp/web-load-test"  
$dirs | ForEach-Object { New-Item -ItemType Directory -Force -Path "$HOME/.jitsi-meet-cfg/$_" }  
```

--------------------------------

### Setup Screen Sharing in Render Process

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-electron-sdk

Enable screen sharing in the render electron process by calling setupScreenSharingRender with the Jitsi Meet iframe API object.

```javascript
const {
    setupScreenSharingRender
} = require("@jitsi/electron-sdk");

// api - The Jitsi Meet iframe api object.
setupScreenSharingRender(api);
```

--------------------------------

### Build .deb Packages for Jitsi Meet

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-web-jitsi-meet

Create a deb package for deploying to a public test server. Ensure lib-jitsi-meet sources are available and dependencies are installed.

```bash
npm install
make
dpkg-buildpackage -A -rfakeroot -us -uc -tc
```

--------------------------------

### Update Package Lists and Install HTTPS Support

Source: https://jitsi.github.io/handbook/docs/devops-guide/devops-guide-quickstart

Ensures your system has the latest package versions and supports HTTPS repositories. Run as root or with sudo.

```bash
sudo apt update
sudo apt install apt-transport-https
```

--------------------------------

### Get Available Devices

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-iframe-functions

Retrieves a list of all available audio and video devices.

```javascript
api.getAvailableDevices().then(devices => {  
    // devices = {  
    //     audioInput: [{  
    //         deviceId: 'ID'  
    //         groupId: 'grpID'  
    //         kind: 'audioinput'  
    //         label: 'label'  
    //     },....],  
    //     audioOutput: [{  
    //         deviceId: 'ID'  
    //         groupId: 'grpID'  
    //         kind: 'audioOutput'  
    //         label: 'label'  
    //     },....],  
    //     videoInput: [{  
    //         deviceId: 'ID'  
    //         groupId: 'grpID'  
    //         kind: 'videoInput'  
    //         label: 'label'  
    //     },....]  
    // }  
    ...  
});
```

--------------------------------

### Build Jitsi Meet SDK for iOS

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-ios-sdk

These commands build the Jitsi Meet SDK for both iOS simulator and device, and then create an XCFramework. Ensure you have the necessary dependencies installed.

```bash
mkdir -p ios/sdk/out  
xcodebuild clean \ 
    -workspace ios/jitsi-meet.xcworkspace \ 
    -scheme JitsiMeetSDK  
xcodebuild archive \ 
    -workspace ios/jitsi-meet.xcworkspace \ 
    -scheme JitsiMeetSDK  \ 
    -configuration Release \ 
    -sdk iphonesimulator \ 
    -destination='generic/platform=iOS Simulator' \ 
    -archivePath ios/sdk/out/ios-simulator \ 
    SKIP_INSTALL=NO \ 
    BUILD_LIBRARY_FOR_DISTRIBUTION=YES  
xcodebuild archive \ 
    -workspace ios/jitsi-meet.xcworkspace \ 
    -scheme JitsiMeetSDK  \ 
    -configuration Release \ 
    -sdk iphoneos \ 
    -destination='generic/platform=iOS' \ 
    -archivePath ios/sdk/out/ios-device \ 
    SKIP_INSTALL=NO \ 
    BUILD_LIBRARY_FOR_DISTRIBUTION=YES  
xcodebuild -create-xcframework \ 
    -framework ios/sdk/out/ios-device.xcarchive/Products/Library/Frameworks/JitsiMeetSDK.framework \ 
    -framework ios/sdk/out/ios-simulator.xcarchive/Products/Library/Frameworks/JitsiMeetSDK.framework \ 
    -output ios/sdk/out/JitsiMeetSDK.xcframework  
cp -a ios/Pods/hermes-engine/destroot/Library/Frameworks/universal/hermes.xcframework ios/sdk/out  

```

--------------------------------

### Configuring Initial Media Devices

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-iframe

Demonstrates how to set the initial audio and video input/output devices for a Jitsi Meet call when creating the API object.

```APIDOC
## Configuring Initial Media Devices

### Description
Specify the desired audio and video input/output devices to be used when the conference starts.

### Example
```javascript
const domain = 'meet.jit.si';
const options = {
    // ... other options
    devices: {
        audioInput: '<deviceLabel>',
        audioOutput: '<deviceLabel>',
        videoInput: '<deviceLabel>'
    },
    // ... other options
};
const api = new JitsiMeetExternalAPI(domain, options);
```
```

--------------------------------

### Configure ALSA Loopback on Ubuntu

Source: https://jitsi.github.io/handbook/docs/devops-guide/devops-guide-docker

Commands to install and configure the ALSA loopback module for Jibri on Ubuntu systems.

```bash
# install the module  
apt update && apt install linux-image-extra-virtual  
# configure 5 capture/playback interfaces  
echo "options snd-aloop enable=1,1,1,1,1 index=0,1,2,3,4" > /etc/modprobe.d/alsa-loopback.conf  
# setup autoload the module  
echo "snd-aloop" >> /etc/modules  
# check that the module is loaded  
lsmod | grep snd_aloop
```

--------------------------------

### Setup Short-Lived Token Keys

Source: https://jitsi.github.io/handbook/docs/devops-guide/file-sharing

Generates RSA private and public keys for signing short-lived tokens used for authentication. Permissions are set for the Prosody user.

```bash
mkdir /etc/jitsi/file-sharing-service
mkdir -p /var/www/jitsi-meet-file-sharing-service/uploads
openssl genrsa -out /etc/jitsi/file-sharing-service/short_lived_token.key 2048
openssl rsa -in /etc/jitsi/file-sharing-service/short_lived_token.key -pubout -out /etc/jitsi/file-sharing-service/short_lived_token.pub
ssh-keygen -f /etc/jitsi/file-sharing-service/short_lived_token.key -e -m pem > /etc/jitsi/file-sharing-service/short_lived_token.pem
chmod g+r /etc/jitsi/file-sharing-service/short_lived_token.key
chown root:prosody /etc/jitsi/file-sharing-service/short_lived_token.key
```

--------------------------------

### Retrieve Signing Hash for Android

Source: https://jitsi.github.io/handbook/docs/dev-guide/mobile-google-auth

Use this command to get the signing hash of your Android application's APK, which is required for Firebase project setup.

```bash
keytool -list -printcert -jarfile the-app.apk
```

--------------------------------

### Setup Always On Top in Render Process

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-electron-sdk

Initialize the always-on-top feature in the render electron process by calling setupAlwaysOnTopRender with the Jitsi Meet API instance and attach a listener for the 'will-close' event.

```javascript
const {
    setupAlwaysOnTopRender
} = require("@jitsi/electron-sdk");

const api = new JitsiMeetExternalAPI(...);
const alwaysOnTop = setupAlwaysOnTopRender(api);

alwaysOnTop.on('will-close', handleAlwaysOnTopClose);
```

--------------------------------

### Link Local SDK into Electron App

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-electron-sdk

Clone the Electron app repository, install its dependencies, and then link the globally registered local SDK into the app's `node_modules`.

```bash
git clone https://github.com/jitsi/jitsi-meet-electron
cd jitsi-meet-electron
npm install
npm link @jitsi/electron-sdk
```

--------------------------------

### Extract and prepare package

Source: https://jitsi.github.io/handbook/docs/devops-guide/devops-guide-docker

Unzips the downloaded package and enters the directory.

```bash
unzip <filename>  
cd <foldername>  
```

--------------------------------

### Clone and Deploy File Sharing Service

Source: https://jitsi.github.io/handbook/docs/devops-guide/file-sharing

Clones the Jitsi Meet file sharing service repository, installs Node.js dependencies, and deploys the service. Ensure you are in the desired directory before cloning.

```bash
cd /srv
git clone https://github.com/jitsi/jitsi-meet-file-sharing-service.git
cd /srv/jitsi-meet-file-sharing-service
nvm install
nvm use
./deploy.sh
```

--------------------------------

### Join Meeting with Options and Listener

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-flutter-sdk

Use the join method to start a meeting, providing conference options and an optional event listener.

```dart
jitsiMeet.join(options, listener);

```

--------------------------------

### Configure Prosody Virtual Host and Components

Source: https://jitsi.github.io/handbook/docs/devops-guide/devops-guide-opensuse

Set up a specific virtual host configuration for Jitsi Meet, including TURN credentials, SSL settings, and enabling required components.

```lua
plugin_paths = { "/usr/share/jitsi-meet/prosody-plugins/" }
  
-- As per https://prosody.im/doc/setting_up_bosh#proxying_requests
consider_bosh_secure = true  
  
-- domain mapper options, must at least have domain base set to use the mapper  
muc_mapper_domain_base = "<FQDN>";  
  
turncredentials_secret = "YOURSECRET3";  
  
turncredentials = {
  { type = "stun", host = "<FQDN>", port = "3478" },
  { type = "turn", host = "<FQDN>", port = "3478", transport = "udp" },
  --  { type = "turns", host = "<FQDN>", port = "443", transport = "tcp" }  
};
  
VirtualHost "<FQDN>"
    authentication = "anonymous"
    ssl = {
        key = "/var/lib/prosody/<FQDN>.key";
        certificate = "/var/lib/prosody/<FQDN>.crt";
    }
    speakerstats_component = "speakerstats.<FQDN>"
    conference_duration_component = "conferenceduration.<FQDN>"
    modules_enabled = {
        "bosh";
        "pubsub";
	    "speakerstats";
	    "turncredentials";
        "conference_duration";
    }
    c2s_require_encryption = false  
  
Component "conference.<FQDN>" "muc"
    modules_enabled = {
        "muc_meeting_id";
        "muc_domain_mapper";
    }
    admins = { "focus@auth.<FQDN>" }
    muc_room_locking = false  
    muc_room_default_public_jids = true  
  
-- internal muc component  
Component "internal.auth.<FQDN>" "muc"
    modules_enabled = {
      "ping";
    }
    admins = { "focus@auth.<FQDN>" }
    muc_room_locking = false  
    muc_room_default_public_jids = true  
    muc_room_cache_size = 1000  
  
Component "jitsi-videobridge.<FQDN>"
    component_secret = "YOURSECRET3"
  
VirtualHost "auth.<FQDN>"
    ssl = {
        key = "/var/lib/prosody/auth.<FQDN>.key";
        certificate = "/var/lib/prosody/auth.<FQDN>.crt";
    }
    authentication = "internal_plain"  
  
Component "focus.<FQDN>"
    component_secret = "YOURSECRET3"
  
Component "speakerstats.<FQDN>" "speakerstats_component"
    muc_component = "conference.<FQDN>"
  
Component "conferenceduration.<FQDN>" "conference_duration_component"
    muc_component = "conference.<FQDN>"

```

--------------------------------

### Start Calls with Video Muted

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-configuration

Forces local video to start in a muted state.

```javascript
startWithVideoMuted: true  
```

--------------------------------

### Set DebConf variables for Jitsi installation

Source: https://jitsi.github.io/handbook/docs/devops-guide/devops-guide-scalable

Configure DebConf variables before installing Jitsi packages to customize hostname, certificate paths, and other settings. This is crucial for a custom installation where the 'jitsi-meet' package doesn't handle all configurations.

```bash
$ cat << EOF | sudo debconf-set-selections
jitsi-videobridge	jitsi-videobridge/jvb-hostname	string	meet.example.com
jitsi-meet	jitsi-meet/jvb-serve	boolean	false
jitsi-meet-prosody	jitsi-videobridge/jvb-hostname	string	meet.example.com
jitsi-meet-web-config	jitsi-meet/cert-choice	select	I want to use my own certificate
jitsi-meet-web-config	jitsi-meet/cert-path-crt	string	/etc/ssl/meet.example.com.crt
jitsi-meet-web-config	jitsi-meet/cert-path-key	string	/etc/ssl/meet.example.com.key
jitsi-meet-web-config	jitsi-meet/jaas-choice	boolean	false
EOF
```

--------------------------------

### Build and Publish SDK to Local Maven Repository

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-android-sdk

Run the release-sdk.sh script from the jitsi-meet project root to build and publish the SDK and its dependencies to a specified local Maven repository.

```bash
./android/scripts/release-sdk.sh /tmp/repo
```

--------------------------------

### Check Start Silent State

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-iframe-functions

Returns a Promise which resolves with whether meeting was started in view only.

```javascript
api.isStartSilent().then(startSilent => {  
    ...  
});  
```

--------------------------------

### Integrate JitsiMeetView in a Custom Activity

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-android-sdk

Example of using JitsiMeetView within a FragmentActivity. This approach requires manual wiring and is less recommended than using JitsiMeetActivity.

```java
package org.jitsi.example;

import android.os.Bundle;
import android.support.v4.app.FragmentActivity;

import org.jitsi.meet.sdk.JitsiMeetView;
import org.jitsi.meet.sdk.ReactActivityLifecycleCallbacks;

// Example
//
public class MainActivity extends FragmentActivity implements JitsiMeetActivityInterface {
    private JitsiMeetView view;

    @Override
    protected void onActivityResult(
            int requestCode,
            int resultCode,
            Intent data) {
        JitsiMeetActivityDelegate.onActivityResult(
                this, requestCode, resultCode, data);
    }

    @Override
    public void onBackPressed() {
        JitsiMeetActivityDelegate.onBackPressed();
    }

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);

        view = new JitsiMeetView(this);
        JitsiMeetConferenceOptions options = new JitsiMeetConferenceOptions.Builder()
            .setRoom("https://meet.jit.si/test123")
            .build();
        view.join(options);

        setContentView(view);
    }

    @Override
    protected void onDestroy() {
        super.onDestroy();

        view.dispose();
        view = null;

        JitsiMeetActivityDelegate.onHostDestroy(this);
    }

    @Override
    public void onNewIntent(Intent intent) {
        JitsiMeetActivityDelegate.onNewIntent(intent);
    }

    @Override
    public void onRequestPermissionsResult(
            final int requestCode,
            final String[] permissions,
            final int[] grantResults) {
        JitsiMeetActivityDelegate.onRequestPermissionsResult(requestCode, permissions, grantResults);
    }

    @Override
    protected void onResume() {
        super.onResume();

        JitsiMeetActivityDelegate.onHostResume(this);
    }

    @Override
    protected void onStop() {
        super.onStop();

        JitsiMeetActivityDelegate.onHostPause(this);
    }
}

```

--------------------------------

### Loading a Conference with JitsiMeetView

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-ios-sdk

Example of how to load a Jitsi Meet conference within your application using the JitsiMeetView. This involves setting the delegate and joining a conference with specified options.

```APIDOC
- (void)viewDidLoad {
  [super viewDidLoad];

  JitsiMeetView *jitsiMeetView = (JitsiMeetView *) self.view;
  jitsiMeetView.delegate = self;

  JitsiMeetConferenceOptions *options = [JitsiMeetConferenceOptions fromBuilder:^(JitsiMeetConferenceOptionsBuilder *builder) {
      builder.serverURL = [NSURL URLWithString:@"https://meet.jit.si"];
      builder.room = @"test123";
      builder.audioOnly = YES;
  }];

  [jitsiMeetView join:options];
}
```

--------------------------------

### Initialize SampleHandler and Uploader

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-ios-sdk

Initializes the SampleHandler and sets up the SampleUploader with a new SocketConnection. This is called during the SampleHandler's initialization.

```swift
override init() {
    super.init()
    if let connection = SocketConnection(filePath: socketFilePath) {
      clientConnection = connection
      uploader = SampleUploader(connection: connection)
    }
}
```

--------------------------------

### Enable Wait for Host and Persistent Lobby

Source: https://jitsi.github.io/handbook/docs/devops-guide/authentication

Configure the main VirtualHost and MUC component to enable the `wait_for_host` module and `persistent_lobby`. Ensure to replace `jitsi.example.com` with your hostname.

```apache
VirtualHost "jitsi.example.com"  
    authentication = "token"  
    ...  
    modules_enabled = {  
        ...  
        "persistent_lobby";  
        ...  
    }

Component "conference.jitsi.example.com" "muc"
    modules_enabled = {  
        ...  
        "muc_wait_for_host";  
        ...  
    }

```

--------------------------------

### Install Jigasi for SIP Gateway

Source: https://jitsi.github.io/handbook/docs/devops-guide/devops-guide-quickstart

Install Jigasi, a server-side application that enables SIP clients to join Jitsi Meet conferences and provides transcription.

```bash
sudo apt install jigasi
```

--------------------------------

### Enable Reservation System Module

Source: https://jitsi.github.io/handbook/docs/devops-guide/reservation

Configure the Prosody virtual host to enable the 'reservations' module and set the base URL for the reservation system's REST API.

```lua
VirtualHost "jitmeet.example.com" 
    -- ....
    modules_enabled = {
        -- ....
        "reservations";
    }
    reservations_api_prefix = "http://reservation.example.com"

```

--------------------------------

### Install nvm and Reload Shell Profile

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-windows

Installs nvm (Node Version Manager) to manage Node.js versions. Reloads the shell profile to make the nvm command available.

```bash
# Install nvm  
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.1/install.sh | bash  
  
# Reload your shell profile so the nvm command becomes available  
source ~/.bashrc  
```

--------------------------------

### Get Email

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-iframe-functions

Returns a participant's email.

```javascript
const email = api.getEmail(participantId);  
```

--------------------------------

### Enable Anonymous Login for Guests in Prosody

Source: https://jitsi.github.io/handbook/docs/devops-guide/secure-domain

Add this section after the main VirtualHost to enable anonymous login for guests. `guest.jitsi.example.com` is an internal domain and does not require DNS or SSL configuration. Replace `jitsi.example.com` with your hostname.

```lua
VirtualHost "guest.jitsi.example.com"  
    authentication = "jitsi-anonymous"  
    c2s_require_encryption = false  

```

--------------------------------

### Share video

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-iframe-commands

Starts or stops sharing a video from a URL.

```javascript
api.executeCommand('startShareVideo', url);
```

```javascript
api.executeCommand('stopShareVideo');
```

--------------------------------

### Set Initial Media Devices

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-iframe

Configure the initial audio and video input/output devices for the Jitsi Meet call. Replace '<deviceLabel>' with actual device IDs.

```javascript
const domain = 'meet.jit.si';
const options = {
    ... 
    devices: {
        audioInput: '<deviceLabel>',
        audioOutput: '<deviceLabel>',
        videoInput: '<deviceLabel>'
    },
    ... 
};
const api = new JitsiMeetExternalAPI(domain, options);
```

--------------------------------

### conferenceCreatedTimestamp

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-iframe-events

Provides notification of the start time of the video conference.

```APIDOC
## conferenceCreatedTimestamp

### Description
Provides notification of the start time of the video conference.

### Data Structure
- **timestamp** (timestamp) - Time the conference started.
```

--------------------------------

### Get Number of Participants

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-iframe-functions

Returns the number of conference participants.

```javascript
const numberOfParticipants = api.getNumberOfParticipants();  
```

--------------------------------

### isStartSilent

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-iframe-functions

Returns a Promise which resolves with whether meeting was started in view only.

```APIDOC
## api.isStartSilent()

### Description
Returns a Promise which resolves with whether meeting was started in view only.
```

--------------------------------

### Add Connection Event Listeners and Connect

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-ljm-api

Attach listeners for connection events and establish the server connection.

```javascript
connection.addEventListener(JitsiMeetJS.events.connection.CONNECTION_ESTABLISHED, onConnectionSuccess);
connection.addEventListener(JitsiMeetJS.events.connection.CONNECTION_FAILED, onConnectionFailed);
connection.addEventListener(JitsiMeetJS.events.connection.CONNECTION_DISCONNECTED, disconnect);

connection.connect();
```

--------------------------------

### Get Display Name

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-iframe-functions

Returns a participant's display name.

```javascript
const displayName = api.getDisplayName(participantId);  
```

--------------------------------

### Set Token Authentication URLs in config.js

Source: https://jitsi.github.io/handbook/docs/devops-guide/authentication

Append these lines to your `config.js` file to configure token authentication and logout URLs. Ensure correct formatting and replace `jitsi.example.com` with your hostname.

```javascript
config.tokenAuthUrl='https://'+ config.hosts.domain + '/realms/jitsi-realm/protocol/openid-connect/auth?client_id=jitsi&response_type=code&scope=openid&state={state}&redirect_uri=https://'+ config.hosts.domain + '/static/sso.html&code_challenge={code_challenge}&code_challenge_method=S256';
config.tokenLogoutUrl='https://'+ config.hosts.domain + '/realms/jitsi-realm/protocol/openid-connect/logout?post_logout_redirect_uri=https://'+ config.hosts.domain + '/static/logout.html';
config.tokenAuthInline=true;
config.sso={ ssoService: config.hosts.domain, tokenService: config.hosts.domain + '/realms/jitsi-realm/protocol/openid-connect', clientId: "jitsi" };

```

--------------------------------

### Get Livestream URL

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-iframe-functions

Retrieves the URL for the current live stream.

```javascript
api.getLivestreamUrl().then(livestreamData => {  
    // livestreamData = {  
    //     livestreamUrl: 'livestreamUrl'  
    // }  
    ...  
});
```

--------------------------------

### Get Deployment Info

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-iframe-functions

Retrieves information about the current deployment, such as region and shard.

```javascript
api.getDeploymentInfo().then(deploymentInfo => {  
    // deploymentInfo = {  
    //     region: 'deployment-region',  
    //     shard: 'deployment-shard',  
    //     ...  
    // }  
    ...  
});
```

--------------------------------

### Enable audio-only mode

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-configuration

Forces the conference to start without video transmission or reception.

```javascript
startAudioOnly: false  
```

--------------------------------

### Static TURN Server Configuration

Source: https://jitsi.github.io/handbook/docs/devops-guide/turn

Configure Jitsi Meet's P2P mode with static TURN server details. This method is simple but exposes credentials and is not recommended for production environments.

```javascript
    [
        { urls: 'turn:turn.example.com1', username: 'user', credential: 'pass' },
    ]

```

--------------------------------

### Create User in Prosody

Source: https://jitsi.github.io/handbook/docs/devops-guide/secure-domain

Use the `prosodyctl register` command to create a new user in Prosody. Replace `<username>`, `<your-hostname>`, and `<password>` with your specific details.

```bash
sudo prosodyctl register <username> <your-hostname> <password>  

```

```bash
sudo prosodyctl register myname jitsi.example.com mypassword123  

```

--------------------------------

### conferenceCreatedTimestamp event structure

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-iframe-events

Represents the data structure for conference start time events.

```javascript
{
    timestamp: timestamp // time the conference started  
}
```

--------------------------------

### Cloudflare Worker Endpoint Example

Source: https://jitsi.github.io/handbook/docs/devops-guide/transcription

The resulting URL format for the deployed Cloudflare Worker.

```text
wss://<worker-name>.<ACCOUNT>.workers.dev/transcribe  
```

--------------------------------

### Get Current Devices

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-iframe-functions

Retrieves the list of currently selected audio and video devices.

```javascript
api.getCurrentDevices().then(devices => {  
    // devices = {  
    //     audioInput: {  
    //         deviceId: 'ID'  
    //         groupId: 'grpID'  
    //         kind: 'videoInput'  
    //         label: 'label'  
    //     },  
    //     audioOutput: {  
    //         deviceId: 'ID'  
    //         groupId: 'grpID'  
    //         kind: 'videoInput'  
    //         label: 'label'  
    //     },  
    //     videoInput: {  
    //         deviceId: 'ID'  
    //         groupId: 'grpID'  
    //         kind: 'videoInput'  
    //         label: 'label'  
    //     }  
    // }  
    ...  
});
```

--------------------------------

### Start with audio muted

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-configuration

Sets the local audio state to muted upon joining a call.

```javascript
startWithAudioMuted: false  
```

--------------------------------

### Get IFrame

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-iframe-functions

Returns the IFrame HTML element which is used to load the Jitsi Meet conference.

```javascript
const iframe = api.getIFrame();  
```

--------------------------------

### Get Participants Info

Source: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-iframe-functions

Deprecated method for retrieving participant information. Use getRoomsInfo instead.

```javascript
api.getParticipantsInfo();
```

--------------------------------

### Disable STUN for Offline Installations

Source: https://jitsi.github.io/handbook/docs/devops-guide/devops-guide-docker

Disable STUN discovery in airgapped environments where the server cannot reach the Internet.

```bash
JVB_DISABLE_STUN=true  
```
Tokens:
Raw