Repository: jitsi/handbook Branch: master Commit: c025bae48c58 Files: 74 Total size: 440.8 KB Directory structure: gitextract_8_c2mv99/ ├── .github/ │ └── workflows/ │ ├── gh-pages.yml │ └── stale.yml ├── .gitignore ├── .nvmrc ├── LICENSE ├── README.md ├── docs/ │ ├── architecture.md │ ├── assets/ │ │ └── ArchitectureDiagram.drawio │ ├── community/ │ │ ├── intro.md │ │ └── third-party-software.md │ ├── dev-guide/ │ │ ├── android-sdk.md │ │ ├── configuration.md │ │ ├── contributing.md │ │ ├── electron-sdk.md │ │ ├── flutter-sdk.md │ │ ├── iframe-commands.md │ │ ├── iframe-events.md │ │ ├── iframe-functions.md │ │ ├── iframe.md │ │ ├── ios-sdk.md │ │ ├── ljm-api.md │ │ ├── ljm.md │ │ ├── mobile-dropbox.md │ │ ├── mobile-feature-flags.md │ │ ├── mobile-google-auth.md │ │ ├── mobile-jitsi-meet.md │ │ ├── react-native-sdk.md │ │ ├── react-sdk.md │ │ ├── web-integrations.md │ │ ├── web-jitsi-meet.md │ │ └── windows.md │ ├── devops-guide/ │ │ ├── authentication.md │ │ ├── bsd.md │ │ ├── cloud-api.md │ │ ├── devops-guide.md │ │ ├── docker.md │ │ ├── faq.md │ │ ├── file-sharing.md │ │ ├── ldap-authentication.md │ │ ├── log-analyser.md │ │ ├── opensuse.md │ │ ├── quickstart.md │ │ ├── region.md │ │ ├── requirements.md │ │ ├── reservation.md │ │ ├── scalable.md │ │ ├── secure-domain.md │ │ ├── speakerstats.md │ │ ├── token-authentication.md │ │ ├── turn.md │ │ ├── video-sipgw.md │ │ └── videotutorials.md │ ├── faq.md │ ├── intro.md │ ├── releases.md │ ├── security.md │ └── user-guide/ │ ├── advanced.md │ ├── basic.md │ ├── browsers.md │ ├── client-connection-status-indicators.md │ ├── jitsi-meet-for-google-calendar.md │ ├── join-a-jitsi-meeting.md │ ├── keyboard-shortcuts.md │ ├── share-a-jitsi-meeting.md │ ├── start-a-jitsi-meeting.md │ └── use-jitsi-meet-on-mobile.md ├── docusaurus.config.js ├── package.json ├── sidebars.js ├── src/ │ ├── css/ │ │ └── custom.css │ └── pages/ │ ├── help.md │ ├── index.js │ └── styles.module.css └── static/ └── .nojekyll ================================================ FILE CONTENTS ================================================ ================================================ FILE: .github/workflows/gh-pages.yml ================================================ name: Build GH pages and deploy if on master on: push: branches: - master pull_request: jobs: build-deploy: runs-on: ubuntu-latest steps: - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4 - uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4 with: node-version-file: '.nvmrc' - name: Build run: npm ci && npm run build - name: Deploy uses: peaceiris/actions-gh-pages@855ba067441803d21928825cee354a257c1ca173 # v2.5.0 if: ${{ github.ref == 'refs/heads/master' }} env: ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }} PUBLISH_BRANCH: gh-pages PUBLISH_DIR: ./build ================================================ FILE: .github/workflows/stale.yml ================================================ name: 'Close stale issues and PRs' on: schedule: - cron: '30 1 * * *' jobs: stale: runs-on: ubuntu-latest steps: - uses: actions/stale@1160a2240286f5da8ec72b1c0816ce2481aabf84 # v8 with: stale-issue-message: 'This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.' stale-pr-message: 'This PR has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.' stale-issue-label: 'stale' stale-pr-label: 'stale' exempt-issue-labels: 'confirmed,help-needed' exempt-pr-labels: 'confirmed' days-before-issue-stale: 60 days-before-pr-stale: 90 days-before-issue-close: 10 days-before-pr-close: 10 ================================================ FILE: .gitignore ================================================ .DS_Store node_modules translated_docs build yarn.lock .docusaurus .vscode .idea *~ *.sw? ================================================ FILE: .nvmrc ================================================ 20 ================================================ FILE: LICENSE ================================================ Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ================================================ FILE: README.md ================================================ # The Jitsi Handbook This is The Jitsi Handbook. Your one-stop shop for Jitsi documentation. It's powered by [Docusaurus](https://docusaurus.io/). The documentation website can be found [here](https://jitsi.github.io/handbook/). ## Building the site The site is built automatically with every push thanks to a [GH Actions](https://github.com/jitsi/handbook/blob/master/.github/workflows/gh-pages.yml). **NOTE:** You need to have Node.Js(>=16) installed in your system to build this site. NodeJs can be downloaded from [here](https://nodejs.org/en/download/) If you want to build it locally, follow these simple steps: 1. Clone the repository ```shell git clone https://github.com/jitsi/handbook.git ``` 2. Move to the folder where the repository is cloned ```shell cd handbook ``` 3. Install the dependencies ```shell npm install ``` 4. Start the website ```shell npm start ``` The website will be running at http://127.0.0.1:3000/handbook/ You can now edit the files in the `docs` folder and the site will reflect the changes immediately thanks to live reloading. ## Contributing We appreciate all contributions to this repository. Please make a Pull Request, no matter how small, all contributions are valuable! Please follow the given [Contributing Guidelines](https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-contributing) before submitting a pull request. ================================================ FILE: docs/architecture.md ================================================ --- id: architecture title: Architecture --- In this section, a global overview of the Jitsi infrastructure is provided. If you just started contributing to the project, we highly recommend reading this section thoroughly. ## Components Jitsi comprises a [collection of projects](https://jitsi.org/projects/): * [Jitsi Meet](https://jitsi.org/jitsi-meet) - WebRTC compatible JavaScript application that uses Jitsi Videobridge to provide high-quality, scalable video conferences. Build upon React and React Native. * [Jitsi Videobridge (JVB)](https://jitsi.org/jitsi-videobridge) - WebRTC compatible server designed to route video streams amongst participants in a conference. * [Jitsi Conference Focus (jicofo)](https://github.com/jitsi/jicofo) - server-side focus component used in Jitsi Meet conferences that manages media sessions and acts as a load balancer between each of the participants and the videobridge. * [Jitsi Gateway to SIP (jigasi)](https://github.com/jitsi/jigasi) - server-side application that allows regular SIP clients to join Jitsi Meet conferences * [Jitsi Broadcasting Infrastructure (jibri)](https://github.com/jitsi/jibri) - set of tools for recording and/or streaming a Jitsi Meet conference that works by launching a Chrome instance rendered in a virtual framebuffer and capturing and encoding the output with ffmpeg. External Software used by Jitsi: * [Prosody](https://prosody.im/) - XMPP server used for signalling ## Architecture Diagram The individual connections between the previously described components, as well as their external integrations are described in the figure below. ![](https://raw.githubusercontent.com/jitsi/handbook/master/docs/assets/ArchitectureDiagram.png) The external connections can be categorized into two main groups. Firstly, the connections between clients that request a video or audio connection are performed through remote requests and data streams. The second category of external connections is those to external services that help store recordings, stream recordings, stream videos, or help with creating meetings. ## Code Map In this section, we will look at the main parts of the codebase and see what they can be used for. **./react/features** This folder is where it is best to start writing your code, as it contains most of the app components that are used in the apps on Android and iOS, as well as on the web version. This source folder is split up into all the different features that Jitsi has to offer, such as authentication, chat interaction, keyboard shortcuts, screenshot capture, remote control, and virtual background. Each of these features has a folder in this map, which is then again split up to keep a hierarchy and consistency throughout the code. Each feature folder consists of a subfolder called components, in this folder all of the React, or React Native for mobile, components are expressed. Usually, in this folder there will be a separation between native and web components, however, in some cases, the same component could be used for both Android, iOS, and web browsers, in which case there is no separation made. As stated before, the codebase mostly consists of React and React Native, which is the React version for mobile applications. Most of the features make use of the so-called class component by React [^class-comp], however, some new features start to use the new way to write functional components by using hooks[^func-comp]. The application makes use of React Redux as well, this is used as a general state store to keep track of important parameters that are used throughout the application. More on React Redux can be found here [^react-redux]. Most features also contain a file called `middleware.js`. This file acts as a bridge between the component and the functionality of the rest of the application. **./modules/external-api** In this folder, the external API can be found. This API can be used in various events like participants joining/leaving the meeting, changes in avatars or chat, as well as errors in using the microphone or camera. **./android and ./ios** Both of these folders contain the basics of the Android and iOS apps respectively. However, the code for the application itself and its components can be found in the **react/features** folder, which is explained earlier in this section. **./conference.js** This file can be found at the root of the project and contains the foundation of any interaction between a user and a conference room. This consists of setting up a connection to it, joining the meeting room, muting and unmuting, but also functions to gather information about the participants that are in the room. **./lang** This folder contains all the different translations that are present in Jitsi Meet. The translations can be found in the code with each of the keys in the translation maps that can be found in the `main-[language].json` files. **./css** This folder contains all the CSS that is used in the project. The files (mostly .scss files[^scss]) are split up into features like the React features that they are used in. ## Testing The main form of testing code changes is done through torture tests, next to this the code is tested manually. The torture tests are located in a separate repository, [Jitsi Meet Torture](https://github.com/jitsi/jitsi-meet-torture). The project contains end-to-end tests for several key functions such as peer-to-peer and invites. The testing can be done for iOS, Android, and the web, which are all the platforms that Jitsi Meet can be used on. The testing is done automatically for pull requests by project members, where it is used in combination with the continuous integration by a Jenkins instance running the tests, testing on the [meet.jit.si](https://meet.jit.si) instance. Other members can run the tests locally. The test results can be viewed on an automatically generated web page. Manual testing is performed while doing code reviews, however, there are also testing releases that can be freely downloaded and deployed or can be used on the [beta test server](https://beta.meet.jit.si/). ================================================ FILE: docs/assets/ArchitectureDiagram.drawio ================================================ ================================================ FILE: docs/community/intro.md ================================================ --- id: community-intro title: Our community --- Jitsi Meet and all accompanying Jitsi projects are maintained by a community of passionate individuals and corporations. If you have questions, need help, or want to make suggestions, please join our community [here](https://community.jitsi.org/).
import DocCardList from '@theme/DocCardList'; ================================================ FILE: docs/community/third-party-software.md ================================================ --- id: third-party-software title: Third-Party Software --- This page contains links to projects around Jitsi Meet, which are not maintained by the Jitsi team. Please keep this list in alphabetical order. :::warning As these packages are not maintained by the Jitsi team, please ask their respective forums / issue trackers for help if you find issues. ::: ## Cketti's Jitsi Hacks Some extra features using injected scripts. https://jitsi-hacks.cketti.eu/ ## Eparto Virtual Phone This is a Chrome extension that allow users to use their browser as a virtual phone and to make Jitsi-based calls without opening any web site. Chrome web store: [Eparto virtual phone extension](https://chromewebstore.google.com/detail/eparto-virtual-phone/njihflnogjnjnmflicfongbnehhpkhmj) GitHub: https://github.com/emrahcom/eparto-virtual-phone ## Flutter plugin Plugin for Flutter. https://pub.dev/packages/jitsi_meet ## Galaxy Galaxy is a web application for Jitsi admins and users to organize their Jitsi meetings, meeting schedules, and attendees. It supports [JaaS](https://jaas.8x8.vc/) and self-hosted Jitsi deployments. GitHub: https://github.com/emrahcom/galaxy Demo: https://eparto.net ## Galaxy-kc This is the version of `Galaxy` that uses `Keycloak` as the identity provider. https://github.com/emrahcom/galaxy-kc ## GStreamer pipeline integration Integrate Jitsi Meet conferences with GStreamer pipelines. https://github.com/avstack/gst-meet ## GStreamer plugin in C++ Jitsi Meet GStreamer plugin https://github.com/mojyack/gstjitsimeet ## Jitok: Jitsi Token generator Helper web tool and API for generating Jitsi Meet compatible JWT. GitHub: https://github.com/jitsi-contrib/jitok Demo: https://jitok.emrah.com/ Discussion: https://community.jitsi.org/t/jitok-jitsi-token-generator/94683 ## Jitsi-Admin An open-source platform to organize your meetings. Includes all functions we know from the big conference-tools - Plan your Meeting - Secure your Meeting with user login credentials - Create a Report of each user visiting your conference - Create an appointment poll and transfer it into a conference with one click - Dockerised for easy installation Github: https://github.com/H2-invent/jitsi-admin Demo: https://jitsi-admin.de Docker: https://github.com/H2-invent/jitsi-admin/wiki/Install-jitsi-admin-in-docker ## JitsiMeet-AutoStart A lightweight, single-page utility for unattended systems that need to automatically join a Jitsi meeting with the camera enabled. Perfect for kiosks, monitoring setups, or any scenario where a system should automatically connect and display video without user interaction. No deployment required. Github: https://github.com/GammaPi/JitsiMeet-AutoStart ## Jitsi Config Differ Web app to compare reference configs between different Jitsi releases. This aims to help users identify potential changes in config keys and default values when upgrading their deployment. https://shawnchin.github.io/jitsi-config-differ/ Github: https://github.com/shawnchin/jitsi-config-differ ## Jitsi URL Generator A simple tool to illustrate how URL params can be composed to customize Jitsi. It only exposes a small fraction of what is possible, but should hopefully help build familiarity which users can then apply to other config values in the whitelist. https://shawnchin.github.io/jitsi-url-generator/ Github: https://github.com/shawnchin/jitsi-url-generator ## KeyCloak adapter Allow Jitsi to use Keycloak as an identity and OIDC provider. https://github.com/nordeck/jitsi-keycloak-adapter ## KeyCloak integration Integration of KeyCloak for authentication. https://github.com/D3473R/jitsi-keycloak ## Outlook Plugin Plugin for Adding a "Schedule Jitsi Meeting" Button to Microsoft Outlook. GitHub: https://github.com/timetheoretical/jitsi-meet-outlook ## Outlook Pluigin Plugin for Adding a "Schedule Jitsi Meeting" Button to Microsoft Outlook. Written according to Microsoft's modern architecture. GitHub: https://github.com/diggsweden/jitsi-outlook ## Prosody Plugins Collection of community-contributed prosody plugins that can be added to self-hosted Jitsi deployments. https://github.com/jitsi-contrib/prosody-plugins - **event_sync**: Sends HTTP POST to external API when occupant or room events are triggered. - **frozen_nick**: Prevents users from changing their display name if JWT auth is used and name is provided in token context. - **jibri_autostart**: Automatically starts recording when the moderator enters the room. - **lobby_autostart**: Automatically enables lobby for all rooms. - **per_room_max_occupants**: Set different max occupants based on room name and subdomain. - **secure_domain_lobby_bypass**: Allows secure domain authenticated users to bypass lobby. - **time_restricted**: Sets a time limit on rooms and terminates the conference when the time is up. - **token_affiliation**: Promotes users to moderators based on affiliation property in token (JWT). - **token_lobby_bypass**: Enables some users to bypass lobby based on a flag in token (JWT). - **token_lobby_ondemand**: Activates lobby based on a flag in token (JWT). - **token_owner_party**: Prevents unauthorized users from create a room and terminates the conference when the owner leaves. ## SAML to Jitsi JWT Authentification Intergration of SAML authentification with Shibboleth for a Jitsi Meet JWT generator. Github: https://github.com/Renater/Jitsi-SAML2JWT ## Unity plugin Plugin for using lib-jitsi-meet in a Unity environment (WebGL). https://github.com/avstack/jitsi-meet-unity-demo Plugin for using lib-jitsi-meet in a Unity environment (Android and iOS). https://github.com/SariskaIO/Sariska-Media-Unity-Demo ## Generic OIDC and SAML adapter Add support for OIDC and SAML to Jitsi with JWT and anonymous domain activated. Authenticaten for the meeting host, allowing guests to join without requiring authentication. Github: https://github.com/aadpM2hhdixoJm3u/jitsi-OIDC-SAML-adapter Github: https://github.com/aadpM2hhdixoJm3u/jitsi-OIDC-adapter ================================================ FILE: docs/dev-guide/android-sdk.md ================================================ --- id: dev-guide-android-sdk title: Android SDK --- The Jitsi Meet Android SDK provides the same user experience as the Jitsi Meet app, in a customizable way which you can embed in your apps. :::important Android 7.0 (API level 24) or higher is required. ::: ## Sample applications using the SDK If you want to see how easy integrating the Jitsi Meet SDK into a native application is, take a look at the [sample applications repository](https://github.com/jitsi/jitsi-meet-sdk-samples#android). ## Build your own, or use a pre-build SDK artifacts/binaries Jitsi conveniently provides a pre-build SDK artifacts/binaries in its Maven repository. When you do not require any modification to the SDK itself or any of its dependencies, it's suggested to use the pre-build SDK. This avoids the complexity of building and installing your own SDK artifacts/binaries. ### Use pre-build SDK artifacts/binaries In your project, add the Maven repository `https://github.com/jitsi/jitsi-maven-repository/raw/master/releases` and the dependency `org.jitsi.react:jitsi-meet-sdk` into your `build.gradle` files. The repository typically goes into the `build.gradle` file in the root of your project: ```gradle title="build.gradle" allprojects { repositories { maven { url "https://github.com/jitsi/jitsi-maven-repository/raw/master/releases" } google() mavenCentral() maven { url 'https://www.jitpack.io' } } } ``` In recent versions of Android Studios, `allprojects{}` might not be found in `build.gradle`. In that case, the repository goes into the `settings.gradle` file in the root of your project: ```gradle title="settings.gradle" dependencyResolutionManagement { repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS) repositories { google() mavenCentral() maven { url "https://github.com/jitsi/jitsi-maven-repository/raw/master/releases" } maven { url "https://maven.google.com" } } } ``` Dependency definitions belong in the individual module `build.gradle` files: ```gradle dependencies { // (other dependencies) implementation ('org.jitsi.react:jitsi-meet-sdk:+') { transitive = true } } ``` :::warning Make sure you pin your dependency by checking the [releases page](https://github.com/jitsi/jitsi-meet-release-notes/blob/master/CHANGELOG-MOBILE-SDKS.md). ::: ### Build and use your own SDK artifacts/binaries
Show building instructions Start by making sure that your development environment [is set up correctly](/docs/category/mobile). :::note A Note on Dependencies Apart from the SDK, Jitsi also publishes a binary Maven artifact for some of the SDK dependencies (that are not otherwise publicly available) to the Jitsi Maven repository. When you're planning to use a SDK that is built from source, you'll likely use a version of the source code that is newer (or at least _different_) than the version of the source that was used to create the binary SDK artifact. As a consequence, the dependencies that your project will need, might also be different from those that are published in the Jitsi Maven repository. This might lead to build problems, caused by dependencies that are unavailable. ::: If you want to use a SDK that is built from source, you will likely benefit from composing a local Maven repository that contains these dependencies. The text below describes how you create a repository that includes both the SDK as well as these dependencies. For illustration purposes, we'll define the location of this local Maven repository as `/tmp/repo` In source code form, the Android SDK dependencies are locked/pinned by `package.json` and `package-lock.json` of the Jitsi Meet project. To obtain the data, execute NPM in the jitsi-meet project directory: ```shell npm install ``` This will pull in the dependencies in either binary format, or in source code format, somewhere under /node_modules/ Third-party React Native _modules_, which Jitsi Meet SDK for Android depends on, are download by NPM in source code or binary form. These need to be assembled into Maven artifacts, and then published to your local Maven repository. A script is provided to facilitate this. From the root of the jitsi-meet project repository, run: ```shell ./android/scripts/release-sdk.sh /tmp/repo ``` This will build and publish the SDK, and all of its dependencies to the specified Maven repository (`/tmp/repo`) in this example. You're now ready to use the artifacts. In _your_ project, add the Maven repository that you used above (`/tmp/repo`) into your top-level `build.gradle` file: ```gradle allprojects { repositories { maven { url "file:/tmp/repo" } google() mavenCentral() maven { url 'https://www.jitpack.io' } } } ``` You can use your local repository to replace the Jitsi repository (`maven { url "https://github.com/jitsi/jitsi-maven-repository/raw/master/releases" }`) when you published _all_ subprojects. If you didn't do that, you'll have to add both repositories. Make sure your local repository is listed first! Then, define the dependency `org.jitsi.react:jitsi-meet-sdk` into the `build.gradle` file of your module: ```java implementation ('org.jitsi.react:jitsi-meet-sdk:+') { transitive = true } ``` Note that there should not be a need to explicitly add the other dependencies, as they will be pulled in as transitive dependencies of `jitsi-meet-sdk`.
## Using the API Jitsi Meet SDK is an Android library which embodies the whole Jitsi Meet experience and makes it reusable by third-party apps. First, add Java 1.8 compatibility support to your project by adding the following lines into your `build.gradle` file: ```gradle compileOptions { sourceCompatibility JavaVersion.VERSION_1_8 targetCompatibility JavaVersion.VERSION_1_8 } ``` To get started, just launch `JitsiMeetActivity` pointing to the room you want: ```java // Somewhere early in your app. JitsiMeetConferenceOptions defaultOptions = new JitsiMeetConferenceOptions.Builder() .setServerURL(serverURL) // When using JaaS, set the obtained JWT here //.setToken("MyJWT") // Different features flags can be set // .setFeatureFlag("toolbox.enabled", false) // .setFeatureFlag("filmstrip.enabled", false) .setFeatureFlag("welcomepage.enabled", false) .build(); JitsiMeet.setDefaultConferenceOptions(defaultOptions); // ... // Build options object for joining the conference. The SDK will merge the default // one we set earlier and this one when joining. JitsiMeetConferenceOptions options = new JitsiMeetConferenceOptions.Builder() .setRoom(roomName) // Settings for audio and video //.setAudioMuted(true) //.setVideoMuted(true) .build(); // Launch the new activity with the given options. The launch() method takes care // of creating the required Intent and passing the options. JitsiMeetActivity.launch(this, options); ``` Alternatively, you can use the `org.jitsi.meet.sdk.JitsiMeetView` class which extends `android.view.View`. Note that this should only be needed when `JitsiMeetActivity` cannot be used for some reason. Extending `JitsiMeetView` requires manual wiring of the view to the activity, using a lot of boilerplate code. Using the Activity instead of the View is strongly recommended.
Show example ```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); } } ```
### JitsiMeetActivity This class encapsulates a high level API in the form of an Android `FragmentActivity` which displays a single `JitsiMeetView`. You can pass a URL as a `ACTION_VIEW` on the Intent when starting it and it will join the conference, and will be automatically terminated (finish() will be called on the activity) when the conference ends or fails. ### JitsiMeetView The `JitsiMeetView` class is the core of Jitsi Meet SDK. It's designed to display a Jitsi Meet conference (or a welcome page). #### join(options) Joins the conference specified by the given `JitsiMeetConferenceOptions`. #### dispose() 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. ### JitsiMeetConferenceOptions This object encapsulates all the options that can be tweaked when joining a conference. Example: ```java private static @NonNull ArrayList getCustomToolbarButtons() { ArrayList customToolbarButtons = new ArrayList<>(); Bundle firstCustomButton = new Bundle(); Bundle secondCustomButton = new Bundle(); Bundle thirdCustomButton = new Bundle(); Bundle fourthCustomButton = new Bundle(); Bundle fifthCustomButton = new Bundle(); firstCustomButton.putString("icon", "ICON_URL"); firstCustomButton.putString("id", "CUSTOM_BTN_ID"); secondCustomButton.putString("backgroundColor", "CUSTOM_BTN_BACKGROUND_COLOR"); secondCustomButton.putString("icon", "ICON_URL"); secondCustomButton.putString("id", "CUSTOM_BTN_ID"); customToolbarButtons.add(firstCustomButton); customToolbarButtons.add(secondCustomButton); return customToolbarButtons; } // If you want your custom button/s to appear inside the toolbar, // you will need to set your toolbar buttons too and always include "overflowmenu", "hangup". // All the buttons that, because of the screen size, won't fit the toolbar, will be automatically moved to the overflow menu. private String[] getToolbarButtons() { return new String[]{"CUSTOM_BTN_ID", "CUSTOM_BTN_ID", "microphone", "overflowmenu", "hangup"}; } JitsiMeetConferenceOptions options = new JitsiMeetConferenceOptions.Builder() .setServerURL(new URL("https://meet.jit.si")) .setRoom("MonthlyEndorsementsRebuildConsequently") .setAudioMuted(false) .setVideoMuted(false) .setAudioOnly(false) .setWelcomePageEnabled(false) .setConfigOverride("requireDisplayName", true) .setConfigOverride("customToolbarButtons", getCustomToolbarButtons()) .setConfigOverride("toolbarButtons", getToolbarButtons()) .build(); ``` See the `JitsiMeetConferenceOptions` implementation for all available options. ### JitsiMeetActivityDelegate This class handles the interaction between `JitsiMeetView` and its enclosing `Activity`. Generally this shouldn't be consumed by users, because they'd be using `JitsiMeetActivity` instead, which is already completely integrated. All its methods are static. #### onActivityResult(...) Helper method to handle results of auxiliary activities launched by the SDK. Should be called from the activity method of the same name. #### onBackPressed() Helper method which should be called from the activity's `onBackPressed` method. If this function returns `true`, it means the action was handled and thus no extra processing is required; otherwise the app should call the parent's `onBackPressed` method. #### onHostDestroy(...) Helper method which should be called from the activity's `onDestroy` method. #### onHostResume(...) Helper method which should be called from the activity's `onResume` or `onStop` method. #### onHostStop(...) Helper method which should be called from the activity's `onSstop` method. #### onNewIntent(...) Helper method for integrating the *deep linking* functionality. If your app's activity is launched in "singleTask" mode this method should be called from the activity's `onNewIntent` method. #### onRequestPermissionsResult(...) Helper method to handle permission requests inside the SDK. It should be called from the activity method of the same name. #### onUserLeaveHint() Helper method for integrating automatic Picture-in-Picture. It should be called from the activity's `onUserLeaveHint` method. This is a static method. ### Listening for broadcasted events The SDK broadcasts several events that the users can listen for. ```java IntentFilter intentFilter = new IntentFilter(); intentFilter.addAction(BroadcastEvent.Type.CONFERENCE_JOINED.getAction()); LocalBroadcastManager.getInstance(this).registerReceiver(broadcastReceiver, intentFilter); ``` Please see `JitsiMeetActivity`, which registers for all the events and can serve as an example. #### Supported events ##### CONFERENCE_JOINED Broadcasted when a conference was joined. `data` contains the following information: - `url`: the conference URL ##### CONFERENCE_TERMINATED Broadcasted when the active conference ends, be it because of user choice or because of a failure. `data` contains the following information: - `url`: the conference URL - `error`: missing if the conference finished gracefully, otherwise contains the error message ##### CONFERENCE_WILL_JOIN Broadcasted before a conference is joined. `data` contains the following information: - `url`: the conference URL ##### AUDIO_MUTED_CHANGED Broadcasted when the local participant's audio is muted or unmuted. `data` contains the following information: - `muted`: a boolean indicating whether the audio is muted or not. ##### PARTICIPANT_JOINED Broadcasted when a participant has joined the conference. `data` contains the following information: - `email`: the email of the participant. It may not be set if the remote participant didn't set one. - `name`: the name of the participant. - `role`: the role of the participant. - `participantId`: the id of the participant. ##### PARTICIPANT_LEFT Called when a participant has left the conference. `data` contains the following information: - `participantId`: the id of the participant that left. ##### ENDPOINT_TEXT_MESSAGE_RECEIVED Broadcasted when an endpoint text message is received. The `data` HashMap contains a `senderId` key with the participantId of the sender and a `message` key with the content. ##### SCREEN_SHARE_TOGGLED Broadcasted when a participant starts or stops sharing his screen. `data` contains the following information: - `participantId`: Id of the participant that started or stopped sharing his screen. - `sharing`: True if the participant is sharing his screen, false otherwise. ##### PARTICIPANTS_INFO_RETRIEVED Broadcasted when a RETRIEVE_PARTICIPANTS_INFO action is called. The `data` HashMap contains a `participantsInfo` key with a list of participants information and a `requestId` key with the ID that was sent in the RETRIEVE_PARTICIPANTS_INFO action. ##### CHAT_MESSAGE_RECEIVED Broadcasted when a chat text message is received. `data` contains the following information: - `senderId`: the id of the participant that sent the message. - `message`: the content of the message. - `isPrivate`: true if the message is private, false otherwise. - `timestamp`: the (optional) timestamp of the message. ##### CHAT_TOGGLED Broadcasted when the chat dialog is opened or closed. `data` contains the following information: - `isOpen`: true if the chat dialog is open, false otherwise. ##### VIDEO_MUTED_CHANGED Broadcasted when the local participant's video is muted or unmuted. `data` contains the following information: - `muted`: an integer indicating whether the video is muted or not. 0 means unmuted, and 4 means muted. ##### READY_TO_CLOSE The SDK is ready to be closed / dismissed. ##### CUSTOM_BUTTON_PRESSED Broadcasted when a custom button is pressed. `data` contains the following information: - `id`: the id of the pressed custom button. - `text`: the label of the pressed custom button. ##### CONFERENCE_UNIQUE_ID_SET Broadcasted when an meeting unique id has been set. `data` contains the following information: - `sessionId`: the unique meeting id. ### Broadcasting Actions The SDK listens for broadcasted actions from the users and reacts accordingly. ```java Intent muteBroadcastIntent = new Intent(BroadcastAction.Type.SET_AUDIO_MUTED.getAction()); muteBroadcastIntent.putExtra("muted", muted); LocalBroadcastManager.getInstance(getApplicationContext()).sendBroadcast(muteBroadcastIntent); ``` The intents can be built manually (as shown above) or through the methods in `BroadcastIntentHelper`. Please see `JitsiMeetOngoingConferenceService` for more examples of sending actions. #### Supported actions ##### SET_AUDIO_MUTED Sets the state of the localParticipant audio muted according to the `muted` parameter. Expects a `muted` key on the intent extra with a boolean value. ##### SET_VIDEO_MUTED Sets the state of the localParticipant video muted according to the `muted` parameter. Expects a `muted` key on the intent extra with a boolean value. ##### HANG_UP The localParticipant leaves the current conference. Does not expect any extra value. ##### SEND_ENDPOINT_TEXT_MESSAGE Sends a message via the data channel to one particular participant or all of them. Expects a `to` key on the intent extra with the ID of the participant to which the message is meant and a `message` key with a string value, the actual content of the message. If the `to` key is not present or its value is empty, the message will be sent to all the participants in the conference. To get the participantId, the `PARTICIPANT_JOINED` event should be listened for, which `data` includes the id and this should be stored somehow. ##### TOGGLE_SCREEN_SHARE Sets the state of the localParticipant screen share according to the `enabled` parameter. Expects an `enabled` key on the intent extra with a boolean value. ##### RETRIEVE_PARTICIPANTS_INFO Signals the SDK to retrieve a list with the participant's information. The SDK will emit a PARTICIPANTS_INFO_RETRIEVED event. Expects a `requestId` key on the intent extra with a string value, this parameter will be present on the PARTICIPANTS_INFO_RETRIEVED event. ##### OPEN_CHAT Opens the chat dialog. If a `to` key is present with a valid participantId, the private chat for that particular participant will be opened. ##### CLOSE_CHAT Closes the chat dialog. Does not expect any extra value. ##### SEND_CHAT_MESSAGE Sends a chat message, either a private one if a `to` key is present with a valid participantId and to everybody otherwise. Expect a `message` key with a string value. ##### SHOW_NOTIFICATION Show a notification that can be configured based on `appearance`, `description`, `timeout`, `title` and an `uid`. ##### HIDE_NOTIFICATION Hides a notification according to its `uid`. ##### START_RECORDING Starts the recording by setting up a `mode`, either as a `file` or a `stream`, which can also have a `dropboxToken`, `shouldShare` you can provide a `rtmpStreamKey`, `rtmBroadcastID`, `youtubeStreamKey`, `youtubeBroadcastID`, other `extraMetadata`. You can also enable `transcription` through this action. ##### STOP_RECORDING Stops the recording based on `mode` and also can stop `transcription` if it was enabled. ##### OVERWRITE_CONFIG Overwrites `config` during the meeting. ##### SEND_CAMERA_FACING_MODE_MESSAGE Sends a message `to` with the `facingMode` via data channel. ## ProGuard rules When using the SDK on a project some proguard rules have to be added to avoid necessary code being stripped. Add the following to your project's rules file: https://github.com/jitsi/jitsi-meet/blob/master/android/app/proguard-rules.pro ## Picture-in-Picture `JitsiMeetView` will automatically adjust its UI when presented in a Picture-in-Picture style scenario, in a rectangle too small to accommodate its "full" UI. ## Dropbox integration To set up the Dropbox integration, follow these steps: 1. Add the following to the app's AndroidManifest.xml and change `` to your Dropbox app key: ```xml ``` 2. Add the following to the app's strings.xml and change `` to your Dropbox app key: ```xml ``` ================================================ FILE: docs/dev-guide/configuration.md ================================================ --- id: dev-guide-configuration title: Configuration --- This page describes available configuration options for Jitsi Meet. These are either set in `config.js` on the server side or overridden in the app. :::note Options marked with 🚫 are not overwritable through `configOverwrite` ::: :::warning This page is a work in progress. Not all options are described here yet. ::: ## API ### apiLogLevels type: `Array` Logs that should go be passed through the 'log' event if a handler is defined for it Default: **unset** ```javascript apiLogLevels: ['warn', 'log', 'error', 'info', 'debug'] ``` ### buttonsWithNotifyClick type: `Array` Toolbar buttons which have their click/tap event exposed through the API on `toolbarButtonClicked`. Passing a string for the button key will prevent execution of the click/tap routine; passing an object with `key` and `preventExecution` flag on false will not prevent execution of the click/tap routine. Below array with mixed mode for passing the buttons. Default: **unset** ```javascript buttonsWithNotifyClick: [ 'camera', { key: 'chat', preventExecution: false }, { key: 'closedcaptions', preventExecution: true }, 'desktop', 'download', 'embedmeeting', 'etherpad', 'feedback', 'filmstrip', 'fullscreen', 'hangup', 'help', { key: 'invite', preventExecution: false }, 'livestreaming', 'microphone', 'mute-everyone', 'mute-video-everyone', 'participants-pane', 'profile', { key: 'raisehand', preventExecution: true }, 'recording', 'security', 'select-background', 'settings', 'shareaudio', 'sharedvideo', 'shortcuts', 'stats', 'tileview', 'toggle-camera', 'videoquality', // The add passcode button from the security dialog. { key: 'add-passcode', preventExecution: false }, '__end' ] ``` ### customParticipantMenuButtons type: `Array<{ icon: string; id: string; text: string; }>` Default: **unset** A list of custom buttons that can be added to the Participant Context Menu. Each will have an icon, that can be either a base64 encoded image or the path to an image, a unique id, and a text that will be displayed alongside the icon in the menu. This custom button will trigger the `participantMenuButtonClick` event that will have the id set to the button as the `key` and the `participantId`, representing the id of the participant for which the button was clicked. ```javascript customParticipantMenuButtons: [ { icon: 'data:image/svg+xml;base64,...', id: 'custom-button', text: 'Custom Button' } ] ``` ### customToolbarButtons type: `Array<{ icon: string; id: string; text: string; }>` Default: **unset** A list of custom buttons that can be added to the Toolbar. Each will have an icon, that can be either a base64 encoded image or the path to an image, a unique id, and a text that will be displayed alongside the icon in the menu. This custom button will trigger the `toolbarButtonClicked` event that will the id set to the button as the `key`. ```javascript customToolbarButtons: [ { icon: 'data:image/svg+xml;base64,...', id: 'custom-toolbar-button', text: 'Custom Toolbar Button' } ] ``` ### mouseMoveCallbackInterval type: `Number` Default interval (milliseconds) for triggering `mouseMoved` iframe API event. Default: `1000` ```javascript mouseMoveCallbackInterval: 1000 ``` ### participantMenuButtonsWithNotifyClick type: `Array` Participant context menu buttons which have their click/tap event exposed through the API on `participantMenuButtonClick`. Passing a string for the button key will prevent execution of the click/tap routine; passing an object with `key` and `preventExecution` flag on false will not prevent execution of the click/tap routine. Below array with mixed mode for passing the buttons. Default: **unset** ```javascript participantMenuButtonsWithNotifyClick: [ 'allow-video', { key: 'ask-unmute', preventExecution: false }, 'conn-status', 'flip-local-video', 'grant-moderator', { key: 'kick', preventExecution: true }, { key: 'hide-self-view', preventExecution: false }, 'mute', 'mute-others', 'mute-others-video', 'mute-video', 'pinToStage', 'privateMessage', { key: 'remote-control', preventExecution: false }, 'send-participant-to-room', 'verify', ] ``` ### useHostPageLocalStorage type: `Boolean` This property is related to the use case when Jitsi Meet is used via the IFrame API. When the property is true Jitsi Meet will use the local storage of the host page instead of its own. This option is useful if the browser is not persisting the local storage inside the iframe. Default: **unset** ```javascript useHostPageLocalStorage: true ``` ## Audio ### audioLevelsInterval type: `Number` The interval (milliseconds) at which the audio levels are calculated. Default: `200` ```javascript audioLevelsInterval: 200 ``` ### audioQuality type: `Object` Specify audio quality stereo and opusMaxAverageBitrate values in order to enable HD audio. Beware, by doing so, you are disabling echo cancellation, noise suppression and AGC. Default: **unset** ```javascript audioQuality: { stereo: false, opusMaxAverageBitrate: null // Value to fit the 6000 to 510000 range. } ``` ### disableAudioLevels type: `Boolean` Disable measuring of audio levels. Default: `false` ```javascript disableAudioLevels: false ``` ### ~~disableSpeakerStatsSearch~~ type: `Boolean` Specifies whether there will be a search field in speaker stats or not. __DEPRECATED__ Use `speakerStats.disableSearch` instead. Default: false ```javascript disableSpeakerStatsSearch: false ``` ### disabledSounds type: `Array` The sounds passed in this array will be disabled. Default: **unset** ```javascript disabledSounds: [ // 'ASKED_TO_UNMUTE_SOUND' // 'E2EE_OFF_SOUND' // 'E2EE_ON_SOUND' // 'INCOMING_MSG_SOUND' // 'KNOCKING_PARTICIPANT_SOUND' // 'LIVE_STREAMING_OFF_SOUND' // 'LIVE_STREAMING_ON_SOUND' // 'NO_AUDIO_SIGNAL_SOUND' // 'NOISY_AUDIO_INPUT_SOUND' // 'OUTGOING_CALL_EXPIRED_SOUND' // 'OUTGOING_CALL_REJECTED_SOUND' // 'OUTGOING_CALL_RINGING_SOUND' // 'OUTGOING_CALL_START_SOUND' // 'PARTICIPANT_JOINED_SOUND' // 'PARTICIPANT_LEFT_SOUND' // 'RAISE_HAND_SOUND' // 'REACTION_SOUND' // 'RECORDING_OFF_SOUND' // '_ON_SOUND' // 'TALK_WHILE_MUTED_SOUND' ] ``` ### enableNoAudioDetection type: `Boolean` Enabling this will run the lib-jitsi-meet no audio detection module which will notify the user if the current selected microphone has no audio input and will suggest another valid device if one is present. Default: `true` ```javascript enableNoAudioDetection: true ``` ### enableNoisyMicDetection type: `Boolean` Enabling this will run the lib-jitsi-meet noise detection module which will notify the user if there is noise, other than voice, coming from the current selected microphone. The purpose it to let the user know that the input could be potentially unpleasant for other meeting participants. Default: `true` ```javascript enableNoisyMicDetection: true ``` ### speakerStats type: `Object` Options related to the speaker stats feature. Properties: * `disabled` - Specifies whether the speaker stats is enable or not. * `disableSearch` - Specifies whether there will be a search field in speaker stats or not. * `order` - Specifies whether participants in speaker stats should be ordered or not, and with what priority. Default: ```javascript speakerStats: { disabled: false, disableSearch: false, order: [ 'role', // Moderators on top. 'name', // Alphabetically by name. 'hasLeft', // The ones that have left in the bottom. ], // the order of the array elements determines priority. } ``` ### ~~speakerStatsOrder~~ type: `Array` Specifies whether participants in speaker stats should be ordered or not, and with what priority. __DEPRECATED__ Use `speakerStats.order` instead. Default: ```javascript speakerStatsOrder: [ 'role', // Moderators on top. 'name', // Alphabetically by name. 'hasLeft', // The ones that have left in the bottom. ], // the order of the array elements determines priority. ``` ### startAudioMuted type: `Number` Every participant after the Nth will start audio muted. Default: **unset** ```javascript startAudioMuted: 10 ``` ### startAudioOnly type: `Boolean` Start the conference in audio only mode (no video is being received nor sent). Default: **unset** ```javascript startAudioOnly: false ``` ### startSilent type: `Boolean` Enabling it (with #params) will disable local audio output of remote participants and to enable it back a reload is needed. Default: **unset** ```javascript startSilent: false ``` ### startWithAudioMuted type: `Boolean` Start calls with audio muted. This option is only applied locally. Default: **unset** ```javascript startWithAudioMuted: false ``` ## Breakout rooms ### breakoutRooms type: `Object` Options related to the breakout rooms feature. Default: **unset** Properties: * `hideAddRoomButton` - Hides the add breakout room button. This replaces `hideAddRoomButton`. * `hideAutoAssignButton` - Hides the auto assign participants button. * `hideJoinRoomButton` - Hides the join breakout room button. * `hideModeratorSettingsTab` - Hides the button to open the moderator settings tab. * `hideMoreActionsButton` - Hides the more actions button. * `hideMuteAllButton` - Hides the mute all button. ```javascript breakoutRooms: { hideAddRoomButton: false, hideAutoAssignButton: false, hideJoinRoomButton: false } ``` ### ~~hideAddRoomButton~~ type: `Boolean` __DEPRECATED__ Use `breakoutRooms.hideAddRoomButton` instead. Hides add breakout room button. Default: `false` ```javascript hideAddRoomButton: false ``` ## Analytics ### enableDisplayNameInStats type: `Boolean` Enables sending participants' display names to analytics services. ```javascript enableDisplayNameInStats: false ``` ### enableEmailInStats type: `Boolean` Enables sending participants' emails (if available) to analytics services. ```javascript enableEmailInStats: false ``` ### feedbackPercentage type: `Number` Controls the percentage of automatic feedback shown to participants when analytics is enabled. The default value is 100%. If set to 0, no automatic feedback will be requested. ```javascript feedbackPercentage: 100 ``` ## Transcriptions ### autoCaptionOnRecord __DEPRECATED__ Use `transcription.autoTranscribeOnRecord` instead. ### preferredTranscribingLanguage __DEPRECATED__ Use `transcription.preferredLanguage` instead. ### transcribeWithAppLanguage __DEPRECATED__ Use `transcription.useAppLanguage` instead. ### transcribingEnabled __DEPRECATED__ Use `transcription.enabled` instead. ### transcription type: `Object` Transcription related options. Properties: * `enabled` - Enable transcription (in interface_config, subtitles and buttons can be configured). Default `false`. * `translationLanguages` - Translation languages. Available languages can be found in ./lang/translation-languages.json. * `useAppLanguage` - If `true` the transcriber will use the application language. The application language is either explicitly set by participants in their settings or automatically detected based on the environment, e.g. if the app is opened in a Chrome instance which is using French as its default language then transcriptions for that participant will be in french. Default: `true`. * `preferredLanguage` - Transcriber language. This settings will only work if `useAppLanguage` is explicitly set to `false`. Available languages can be found [here](https://github.com/jitsi/jitsi-meet/blob/master/react/features/transcribing/transcriber-langs.json). Default: `'en-US'`. * `autoTranscribeOnRecord` - Enables automatic turning on transcribing when recording is started. Default: `true`. ```javascript transcription: { enabled: true, translationLanguages: ['en-US', 'es'], useAppLanguage: false, preferredLanguage: 'en-US', autoTranscribeOnRecord: true } ``` ## Connection ### bosh* type: `String` The BOSH URL. ```javascript bosh: '//jitsi-meet.example.com/http-bind' ``` ### disableRtx type: `Boolean` Disables or enables RTX (RFC 4588). Default: `false` ```javascript disableRtx: true ``` ### disableSimulcast type: `Boolean` Enable / disable simulcast support. Default: `false` ```javascript disableSimulcast: true ``` ### e2ee type: `Object` Configure End-to-End Encryption. ```javascript e2ee: { labels: { labelTooltip: 'Tooltip', description: 'Description', label: 'E2EE', warning: 'Warning' }, externallyManagedKey: false } ``` ### e2eping type: `Object` Options related to end-to-end (participant to participant) ping. Properties: * `enabled` - Whether end-to-end pings should be enabled. * `numRequests` - The number of responses to wait for. * `maxConferenceSize` - The max conference size in which e2e pings will be sent. * `maxMessagesPerSecond` - The maximum number of e2e ping messages per second for the whole conference to aim for. This is used to contol the pacing of messages in order to reduce the load on the backend. ```javascript e2eping: { enabled: false, numRequests: 5, maxConferenceSize: 200, maxMessagesPerSecond: 250 } ``` ### enableEncodedTransformSupport type: `Boolean` Enable support for encoded transform in supported browsers. This allows E2EE to work in Safari if the corresponding flag is enabled in the browser. **Experimental**. ```javascript enableEncodedTransformSupport: false ``` ### enableForcedReload 🚫 type: `Boolean` Enables forced reload of the client when the call is migrated as a result of the bridge going down. ```javascript enableForcedReload: true ``` ### gatherStats type: `Boolean` Whether to enable stats collection or not in the `TraceablePeerConnection`. This can be useful for debugging purposes (post-processing/analysis of the WebRTC stats) as it is done in the jitsi-meet-torture bandwidth estimation tests. ```javascript gatherStats: false ``` ### hosts type: `Object` ⚠️ **Note:** Since commit `97146ed`, the `hosts` configuration can **no longer be overridden** via `configOverwrite`. It must be defined only in the main `config.js` served by your deployment. This option previously supported dynamic overrides (e.g., for custom domains or hidden domains), but that functionality has been removed from the client for security and consistency reasons. If you need to separate users into different domains (for example, to hide participants from each other), use the **Visitors / Lobby / JWT roles** features instead of host overrides. --- #### Properties - `domain` — XMPP domain - `anonymousdomain` — Domain for guest / unauthenticated users - `authdomain` — Domain for authenticated users (defaults to `domain`) - `focus` — Focus component domain (defaults to `focus.`) - `muc` — XMPP MUC domain #### Example ```javascript hosts: { domain: 'jitsi-meet.example.com', anonymousdomain: 'guest.example.com', authdomain: 'jitsi-meet.example.com', focus: 'focus.jitsi-meet.example.com', muc: 'conference.jitsi-meet.example.com' } ``` ### p2p type: `Object` Peer-To-Peer mode: used (if enabled) when there are just 2 participants. Properties: * `enabled` - Enables peer to peer mode. When enabled the system will try to establish a direct connection when there are exactly 2 participants in the room. If that succeeds the conference will stop sending data through the JVB and use the peer to peer connection instead. When a 3rd participant joins the conference will be moved back to the JVB connection. * `iceTransportPolicy` - Sets the ICE transport policy for the p2p connection. At the time of this writing the list of possible values are `all` and `relay`, but that is subject to change in the future. The enum is defined in the [WebRTC standard](https://www.w3.org/TR/webrtc/#rtcicetransportpolicy-enum). If not set, the effective value is `all`. * `codecPreferenceOrder` - Provides a way to set the codec preference on desktop based endpoints. * `mobileCodecPreferenceOrder` - Provides a way to set the codec preference on mobile devices, both on RN and mobile browser based endpoints. * `backToP2PDelay` - How long we're going to wait, before going back to P2P after the 3rd participant has left the conference (to filter out page reload). * `stunServers` - The STUN servers that will be used in the peer to peer connections. ```javascript p2p: { enabled: true, enableUnifiedOnChrome: false, iceTransportPolicy: 'all', backToP2PDelay: 5, stunServers: [ { urls: 'stun:jitsi-meet.example.com:3478' }, { urls: 'stun:meet-jit-si-turnrelay.jitsi.net:443' } ] } ``` ### pcStatsInterval type: `Number` The interval at which PeerConnection.getStats() is called. Default: `10000` ```javascript pcStatsInterval: 50000 ``` ### peopleSearchQueryTypes type: `Array` The entity types which are queriable when inviting people in a room. Valid values are "phone", "room", "sip", "user", "videosipgw" and "email". Authentication for Jitsi entity types is done by passing a jwt, authentication for external entity types (e. g. email) is done by passing an alternative token (e. g. peopleSearchTokenLocation). Default: `[]` ```javascript peopleSearchQueryTypes: ["user", "email"] ``` ### peopleSearchUrl type: `String` Directory endpoint which is called for invite dialog autocomplete. Expected response format is an array of objects. Each object should be formatted as follows: ```javascript { id: int, type: string, # the entity type (phone, room, user, email etc.), name: string, # the entity display name avatar?: string, # full URL to the entity picture, not mandatory number?: string, # required for phone numbers } ``` Default: `""` ```javascript peopleSearchUrl: "https://myservice.com/api/people" ``` ### inviteServiceUrl type: `String` Endpoint which is called to send invitation requests. The request is made in POST and contains as a POST body an array of objects formatted the same as the peopleSearchUrl response body. Default: `""` ```javascript inviteServiceUrl: "https://myservice.com/api/invite" ``` ### peopleSearchTokenLocation type: `String` Useful for authentication against directories holding entities which don't exist in Prosody (e. g. email). This indicates the localStorage key where the alternate authentication token value is to be found. This alternate token will be used if the JWT value is not set. It will be sent in the Authorization: Bearer header, as the JWT would have been. Default: `""` ```javascript peopleSearchTokenLocation: "service_token" ``` ### useTurnUdp type: `Boolean` Use TURN/UDP servers for the jitsi-videobridge connection (by default we filter out TURN/UDP because it is usually not needed since the bridge itself is reachable via UDP) ```javascript useTurnUdp: false ``` ### webrtcIceTcpDisable type: `Boolean` Disables ICE/TCP by filtering out local and remote TCP candidates in signalling. ```javascript webrtcIceTcpDisable: false ``` ### webrtcIceUdpDisable type: `Boolean` Disables ICE/UDP by filtering out local and remote UDP candidates in signalling. ```javascript webrtcIceUdpDisable: false ``` ### websocket 🚫 type: `String` Websocket URL ```javascript websocket: 'wss://jitsi-meet.example.com/xmpp-websocket' ``` ## Etherpad ### etherpad_base type: `String` If set, it adds a "Open shared document" link to the bottom right menu that will open an etherpad document. ```javascript etherpad_base: 'https://your-etherpad-installati.on/p/' ``` ### openSharedDocumentOnJoin type: `Boolean` If etherpad integration is enabled, setting this to `true` will automatically open the etherpad when a participant joins. This does not affect the mobile app since opening an etherpad obscures the conference controls -- it's better to let users choose to open the pad on their own in that case. ```javascript openSharedDocumentOnJoin: false ``` ## Filmstrip ### disableFilmstripAutohiding type: `Boolean` Prevents the filmstrip from autohiding when screen width is under a certain threshold Default: `false` ```javascript disableFilmstripAutohiding: true ``` ### filmstrip type: `Object` Options related to the filmstrip. Default: **unset** Properties: * `disableResizable` - Disables user resizable filmstrip. This also allows configuration of the filmstrip (width, tiles aspect ratios) through the interfaceConfig options. * `disableStageFilmstrip` - Disables the stage filmstrip (displaying multiple participants on stage besides the vertical filmstrip) ```javascript filmstrip: { disableResizable: true, disableStageFilmstrip: false } ``` ### disableCameraTintForeground type: `Boolean` Default: **unset** If true disable the camera tint foreground on the active speaker in the filmstrip ```javascript disableCameraTintForeground: true ``` ## Face Landmarks ### faceLandmarks type: `Object` Options related to the face landmarks features. Properties: * `enableFaceCentering` - Enables centering faces within a video by sharing face coordinates. * `enableFaceExpressionsDetection` - Enables detecting face expressions from video. * `enableDisplayFaceExpressions` - Enables displaying face expressions in speaker stats. * `enableRTCStats` - Enables anonymized stats collection for face landmarks. * `faceCenteringThreshold` - Minimum required face movement percentage threshold for sending new face centering coordinates data. * `captureInterval` - Milliseconds for processing a new image capture in order to detect face landmarks. ```javascript faceLandmarks: { enableFaceCentering: false, enableFaceExpressionsDetection: false, enableDisplayFaceExpressions: false, enableRTCStats: false, faceCenteringThreshold: 20, captureInterval: 1000 }, ``` ## Giphy ### giphy type: `Object` Setup for the Giphy integration. Properties: * `enabled` - Whether the feature is enabled or not. * `sdkKey` - SDK API Key from Giphy. * `displayMode` - Display mode can be one of: - `tile` - show the GIF on the tile of the participant that sent it. - `chat` - show the GIF as a message in chat. - `all` - all of the above. This is the default option. * `tileTime` - How long the GIF should be displayed on the tile (in milliseconds). * `rating` - Limit results by audience rating: - `g` - broadly accepted as appropriate in a public environment. This is the default option. - `pg` - commonly witnessed in a public environment, but not as broadly accepted as appropriate. - `pg-13` - typically not seen unless sought out, but still commonly witnessed. - `r` - typically not seen unless sought out, and could be considered alarming if witnessed. ```javascript giphy: { enabled: true, sdkKey: 'example-key', displayMode: 'tile', tileTime: 7000, rating: 'pg' } ``` ## Gravatar ### gravatar type: `Object` Setup for Gravatar-compatible services. Properties: * `baseUrl` 🚫 - Base URL for a Gravatar-compatible service. Defaults to Gravatar. * `disabled` - True if Gravatar should be disabled. ```javascript gravatar: { baseUrl: 'https://www.gravatar.com/avatar/', disabled: false } ``` ### ~~gravatarBaseURL~~ 🚫 type: `String` __DEPRECATED__ Use `gravatar.baseUrl` instead. Base URL for a Gravatar-compatible service. Default: 'https://www.gravatar.com/avatar/' ```javascript gravatarBaseURL: 'https://www.gravatar.com/avatar/' ``` ## LastN ### channelLastN type: `Number` Default value for the channel "last N" attribute. -1 for unlimited. ```javascript channelLastN: -1 ``` ### startLastN type: `Number` Provides a way for the lastN value to be controlled through the UI. When startLastN is present, conference starts with a last-n value of startLastN and channelLastN value will be used when the quality level is selected using "Manage Video Quality" slider. ```javascript startLastN: 1 ``` ## Lobby ### ~~autoKnockLobby~~ type: `Boolean` __DEPRECATED__ Use `lobby.autoKnock` instead. If Lobby is enabled starts knocking automatically. ```javascript autoKnockLobby: false ``` ### ~~enableLobbyChat~~ type: `Boolean` __DEPRECATED__ Use `lobby.enableChat` instead. Enable lobby chat. ```javascript enableLobbyChat: false ``` ### ~~hideLobbyButton~~ type: `Boolean` __DEPRECATED__ Use `securityUi.hideLobbyButton` instead. Hide the lobby button. ```javascript hideLobbyButton: false ``` ### lobby type: `Object` Options related to the lobby screen. Default: **unset** Properties: * `autoKnock` - If the lobby is enabled, it starts knocking automatically. Replaces `autoKnockLobby`. * `enableChat` - Enables the lobby chat. Replaces `enableLobbyChat`. ```javascript lobby: { autoKnock: true, enableChat: false } ``` ## Moderator ### disableModeratorIndicator type: `Boolean` Hides the moderator indicators. Default: `false` ```javascript disableModeratorIndicator: true ``` ### disableReactionsModeration type: `Boolean` Disables the moderation of reactions feature. Default: `false` ```javascript disableReactionsModeration: true ``` ### disableRemoteMute type: `Boolean` Disables muting operations of remote participants. Default: `false` ```javascript disableRemoteMute: true ``` ## Notifications ### notifications type: `Array` Use this array to configure which notifications will be shown to the user. The items correspond to the title or description key of that notification. Some of these notifications also depend on some other internal logic to be displayed or not, so adding them here will not ensure they will always be displayed. A falsy value for this prop will result in having all notifications enabled (e.g null, undefined, false). ```javascript notifications: [] ``` ### disabledNotifications type: `Array` List of notifications to be disabled. Works in tandem with the above setting. ```javascript disabledNotifications: [ 'notify.chatMessages', // shown when receiving chat messages while the chat window is closed 'notify.grantedTo', // shown when moderator rights were granted to a participant ] ``` ## Participants Pane ### participantsPane type: `Object` Options related to the participants pane. Default: **unset** Properties: * `hideModeratorSettingsTab` - Hides the button to open the moderator settings tab. * `hideMoreActionsButton` - Hides the more actions button. * `hideMuteAllButton` - Hides the mute all button. ```javascript participantsPane: { hideModeratorSettingsTab: false, hideMoreActionsButton: false, hideMuteAllButton: false } ``` ## Recording ### dropbox type: `Object` Enable the dropbox integration. Properties: * `appKey` - Your APP Key. * `redirectURI` - A URL to redirect the user to, after authenticating by default uses ```javascript dropbox: { appKey: 'DROPBOX_APP_KEY', redirectURI: 'https://jitsi-meet.example.com/subfolder/static/oauth.html' } ``` ### fileRecordingsEnabled type: `Boolean` Whether to enable file recording or not. ```javascript fileRecordingsEnabled: false ``` ### fileRecordingsServiceEnabled 🚫 type: `Boolean` When integrations like dropbox are enabled only that will be shown, by enabling fileRecordingsServiceEnabled, we show both the integrations and the generic recording service (its configuration and storage type depends on jibri configuration) ```javascript fileRecordingsServiceEnabled: true ``` ### fileRecordingsServiceSharingEnabled 🚫 type: `Boolean` Whether to show the possibility to share file recording with other people (e.g. meeting participants), based on the actual implementation on the backend. ```javascript fileRecordingsServiceSharingEnabled: false ``` ### hideRecordingLabel type: `Boolean` Set recording label to auto hide instead of staying always on screen. Default: `false` ```javascript hideRecordingLabel: true ``` ### localRecording type: `Object` Set local recording configuration. Properties: * `disable` - Whether to disable the feature or not. * `notifyAllParticipants` - Whether to notify all the participants when a local recording is started. ```javascript localRecording: { disable: false, notifyAllParticipants: true } ``` ### recordingLimit 🚫 type: `Object` Options for the recording limit notification. Properties: * `limit` - The recording limit in minutes. Note: This number appears in the notification text but doesn't enforce the actual recording time limit. This should be configured in jibri! * `appName` = The name of the app with unlimited recordings. * `appURL` - The URL of the app with unlimited recordings. ```javascript recordingLimit: { limit: 60, appName: 'Unlimited recordings APP', appURL: 'https://unlimited.recordings.app.com/' } ``` ### recordings type: `Object` Options for the recordings features. Properties: * `recordAudioAndVideo` - If true (default) recording audio and video is selected by default in the recording dialog. * `suggestRecording` - If true, shows a notification at the start of the meeting with a call to action button to start recording (for users who can do so). * `showPrejoinWarning` - If true, shows a warning label in the prejoin screen to point out the possibility that the call you're joining might be recorded. * `showRecordingLink` - If true, the notification for recording start will display a link to download the cloud recording. ```javascript recordings: { recordAudioAndVideo: true, suggestRecording: false, showPrejoinWarning: true, showRecordingLink: true } ``` ## Screen Sharing ### desktopSharingFrameRate type: `Object` Optional desktop sharing frame rate options Default: `{ min: 5, max: 5 }` ```javascript desktopSharingFrameRate: { min: 3, max: 10 } ``` ### disableScreensharingVirtualBackground type: `Boolean` Disables using screensharing as virtual background. ```javascript disableScreensharingVirtualBackground: false ``` ### screenshotCapture type: `Object` Options for the screenshot capture feature. Properties: * `enabled` - Enables the feature * `mode` - The mode for the screenshot capture feature. Can be either 'recording' - screensharing screenshots are taken only when the recording is also on, or 'always' - screensharing screenshots are always taken. ```javascript screenshotCapture: { enabled: true, mode: 'recording' } ``` ## Security UI ### securityUi type: `Object` Options regarding the security-related UI elements. Default: **unset** Properties: * `hideLobbyButton` - Hides the lobby button. Replaces `hideLobbyButton`. * `disableLobbyPassword` - Hides the possibility to set and enter a lobby password. ```javascript securityUi: { hideLobbyButton: true, disableLobbyPassword: false } ``` ## Testing ### testing type: `Object` Experimental features. Default: **unset** Properties: * `assumeBandwidth` - Allows the setting of a custom bandwidth value from the UI. * `disableE2EE` - Disables the End to End Encryption feature. Useful for debugging issues related to insertable streams. * `mobileXmppWsThreshold` - Enables XMPP WebSocket (as opposed to BOSH) for the given amount of users. * `p2pTestMode` - P2P test mode disables automatic switching to P2P when there are 2 participants in the conference. * `testMode` - Enables the test specific features consumed by jitsi-meet-torture. * `noAutoPlayVideo` - Disables the auto-play behavior of *all* newly created video element. This is useful when the client runs on a host with limited resources. ```javascript testing: { assumeBandwidth: true, disableE2EE: false, mobileXmppWsThreshold: 10, // enable XMPP WebSockets on mobile for 10% of the users p2pTestMode: false, testMode: false, noAutoPlayVideo: false } ``` ## Video ### constraints type: `Object` W3C spec-compliant video constraints to use for video capture. Currently used by browsers that return true from lib-jitsi-meet's `util#browser#usesNewGumFlow`. The constraints are independent of this config's resolution value. Defaults to requesting an ideal resolution of 720p. ```javascript constraints: { video: { height: { ideal: 720, max: 720, min: 240 } } } ``` ### disableAddingBackgroundImages type: `Boolean` When true the user cannot add more images to be used as a virtual background. Only the default ones will be available. ```javascript disableAddingBackgroundImages: true ``` ### disableH264 type: `Boolean` If set to true, disable the H.264 video codec by stripping it out of the SDP. ```javascript disableH264: true ``` ### disableLocalVideoFlip type: `Boolean` Disable the Flip video option from the context menu for local video. ```javascript disableLocalVideoFlip: true ``` ### disableSelfView type: `Boolean` Disables self-view tile. (hides it from tile view and filmstrip) ```javascript disableSelfView: true ``` ### doNotFlipLocalVideo type: `Boolean` A property used to unset the default flip state of the local video. When it is set to `true`, the local(self) video will not be mirrored anymore. ```javascript doNotFlipLocalVideo: true ``` ### maxFullResolutionParticipants type: `Number` How many participants while in the tile view mode, before the receiving video quality is reduced from HD to SD? Use `-1` to disable. ```javascript maxFullResolutionParticipants: 5 ``` ### resolution type: `Number` Sets the preferred resolution (height) for local video Default: `720` ```javascript resolution: 1080 ``` ### startVideoMuted type: `Number` Every participant after the Nth will start the video muted. ```javascript startVideoMuted: 5 ``` ### startWithVideoMuted type: `Boolean` Start calls with video muted. Only applied locally. ```javascript startWithVideoMuted: true ``` ### videoQuality type: `Object` Specify the settings for video quality optimizations on the client. Properties: * `codecPreferenceOrder` - Provides a way to set the codec preference on desktop-based endpoints. ```javascript codecPreferenceOrder: [ 'AV1', 'VP9', 'VP8', 'H264' ], ``` * `mobileCodecPreferenceOrder` - Provides a way to set the codec preference on mobile devices, both on RN and mobile browser-based endpoints. ```javascript codecPreferenceOrder: [ 'VP8', 'H264', 'VP9' ], ``` Codec specific settings for scalability modes and max bitrates. ```javascript av1: { maxBitratesVideo: { low: 100000, standard: 300000, high: 1000000, fullHd: 2000000, ultraHd: 4000000, ssHigh: 2500000 }, scalabilityModeEnabled: true, useSimulcast: false, useKSVC: true }, h264: { maxBitratesVideo: { low: 200000, standard: 500000, high: 1500000, fullHd: 3000000, ultraHd: 6000000, ssHigh: 2500000 }, scalabilityModeEnabled: true }, vp8: { maxBitratesVideo: { low: 200000, standard: 500000, high: 1500000, fullHd: 3000000, ultraHd: 6000000, ssHigh: 2500000 }, scalabilityModeEnabled: false }, vp9: { maxBitratesVideo: { low: 100000, standard: 300000, high: 1200000, fullHd: 2500000, ultraHd: 5000000, ssHigh: 2500000 }, scalabilityModeEnabled: true, useSimulcast: false, useKSVC: true }, ``` * `minHeightForQualityLvl` - The options can be used to override default thresholds of video thumbnail heights corresponding to the video quality levels used in the application. At the time of this writing, the allowed levels are: * `low` - for the low-quality level (180p at the time of this writing) * `standard` - for the medium quality level (360p) * `high` - for the high-quality level (720p) The keys should be positive numbers which represent the minimal thumbnail height for the quality level. With the default config value below the application will use 'low' quality until the thumbnails are at least 360 pixels tall. If the thumbnail height reaches 720 pixels then the application will switch to the high quality. ## Whiteboard ### whiteboard type: `Object` Options related to the Excalidraw whiteboard integration. Default: **unset** Properties: * `enabled` - Whether the feature is enabled or not. * `collabServerBaseUrl` - The [server](https://github.com/jitsi/excalidraw-backend) used to support whiteboard collaboration. * `userLimit` - The user access limit to the whiteboard, introduced as a means to control the performance. * `limitUrl` - The url for more info about the whiteboard and its usage limitations. ```javascript whiteboard: { enabled: true, collabServerBaseUrl: 'https://excalidraw-backend.example.com', userLimit: 25, limitUrl: 'https://example.com/blog/whiteboard-limits' } ================================================ FILE: docs/dev-guide/contributing.md ================================================ --- id: dev-guide-contributing title: Contributing Guidelines --- # 🤝 How to Contribute We greatly appreciate your willingness to contribute ❤️ Before you start working however, please take a moment to read and follow this brief guide. # 📥 Reporting Issues and Asking Questions - We prefer issues to be discussed first in the [community forum](https://community.jitsi.org/) and when confirmed, then an issue can be opened in the issue tracker of the appropriate project on GitHub. - Feel free to report ***any bugs, ask for new features or anything else*** you need help with. When opening an issue, please provide as much information as possible. - Please ask any general and implementation specific questions on the [community forum](https://community.jitsi.org/) for support. ### 🪲 Bug Reports and Other Issues For bugs please follow these steps: - **Provide Detailed Information:** Include versions of Jitsi Meet, Jicofo, and JVB. - **Description of the Issue:** Clearly explain the problem encountered. - **Reproduction Steps:** Provide step-by-step instructions to recreate the issue. - **Expected Behavior:** Describe the expected outcome when using the software. - **Actual Behavior:** Explain what actually happened, including any error messages. ### 💟 Feature Requests If you have an idea for a new feature or something you'd like to see improved in Jitsi, here's how you can let us know: - **Describe the feature:** Specify the desired functionality. - **Provide examples:** Share similar features from other apps. - **Explain importance:** Justify the feature's relevance. - **Considerations:** Assess potential challenges. - **Additional details:** Include specific preferences. # Code Contributions - Visit the issue tracker ([Jitsi Meet's for example](https://github.com/jitsi/jitsi-meet/issues)) to find a list of open issues that need attention. - Discovered a bug or have a feature request and know how to fix it? Excellent! Keep reading 🔍 - The [Developer Guide](/docs/category/developer-guide) will help you to setup a development environment to start working on the Jitsi Meet applications. ## ✏️ Contributor License Agreement While the Jitsi projects are released under the [Apache License 2.0](https://github.com/jitsi/jitsi-meet/blob/master/LICENSE), the copyright holder and principal creator is [8x8](https://www.8x8.com/). To ensure that we can continue making these projects available under an Open Source license, we need you to sign our Apache-based contributor license agreement as either a [corporation](https://jitsi.org/ccla) or an [individual](https://jitsi.org/icla). If you cannot accept the terms laid out in the agreement, unfortunately, we cannot accept your contribution. ## 🔁 Creating Pull Requests - Fork the repository to your GitHub account. - Create a new branch for your changes, based on the master branch. Choose a descriptive name for your branch. - Make **one** logical change per pull request to keep things organized. - Keep your commit history clean and concise. If necessary, squash multiple commits into one. - Rebase your branch onto the latest changes in the master branch before submitting the pull request. **Never** merge master, always rebase. ### 📝 Commit messages Jitsi projects follow the [Conventional Commits](https://www.conventionalcommits.org) spec, while making the scope mandatory. That is, we use `feat(feature name) add some functionality` as opposed to `feat: add some functionality`. As projects grow large, scoping down changes is helpful. This is a non-exhaustive list of types of commits: ``` [ 'build', 'chore', 'ci', 'docs', 'feat', 'fix', 'perf', 'refactor', 'revert', 'style', 'test' ]; ``` As for what constitutes a "feature", that can vary across projects. "Subsystem" is another valid analogy. In Jitsi Meet, for example, the feature name can be the feature where you made the changes: `react/features/`. In lib-jitsi-meet, the module: `modules/`. Use your judgement and look into the commit history when in doubt. ## ❗️For 8x8 employees - Don't link any internal resources such as Jira issues, this is an Open Source project ## 📝 Coding Style ### Comments * Comments documenting the source code are required. * Comments from which documentation is automatically generated are **not** subject to case-by-case decisions. Such comments are used, for example, on types and their members. Examples of tools which automatically generate documentation from such comments include JSDoc, Javadoc, Doxygen. * Comments that are not automatically processed are strongly encouraged. They are subject to case-by-case decisions. Such comments are often observed in function bodies. * Comments should be formatted as proper English sentences. Such formatting pays attention to, for example, capitalization and punctuation. ### Duplication * Don't copy-paste source code. Reuse it. Be careful not to create bad abstractions just to reuse a small chunk of code, however. ### Naming * An abstraction should have one name within the project and across multiple projects. For example: * The instance of lib-jitsi-meet's `JitsiConnection` type should be named `connection` or `jitsiConnection` in jitsi-meet, not `client`. * The class `ReducerRegistry` should be defined in ReducerRegistry.js and its imports in other files should use the same name. Don't define the class `Registry` in ReducerRegistry.js and then import it as `Reducers` in other files. * The names of global constants (including ES6 module-global constants) should be written in uppercase with underscores to separate words. For example, `BACKGROUND_COLOR`. * The underscore character at the beginning of a name signals that the respective variable, function, or property is non-public i.e. private, protected, or internal. In contrast, the lack of an underscore at the beginning of a name signals public API. ### TypeScript #### Feature layout When adding a new feature, this would be the usual layout. ``` react/features/sample/ ├── actionTypes.ts ├── actions.ts ├── components │   ├── AnotherComponent.tsx │   └── OneComponent.tsx ├── middleware.ts └── reducer.ts ``` All new features must be written in TypeScript. When working on an old feature, converting the JavaScript files to TypeScript is encouraged. The middleware must be imported in `react/features/app/` specifically in `middlewares.any`, `middlewares.native.js` or `middlewares.web.js` where appropriate. Likewise for the reducer. In general, we want to avoid `index` files. We prefer using the full path for imports. However, there are cases where a common file (used by both web and native, eg. `actions.ts`) needs to import from components (from `/native` or from `/web`, depending on the platform the build is for). In this case, we create two `index` files in `components/`: `index.native.ts` and `index.web.ts` and export just the component we need. The common file should then be imported from `components/index`. This has not always been the case and the entire codebase hasn't been migrated to this model but new features should follow this new layout. When working on an old feature, adding the necessary changes to migrate to the new model is encouraged. #### Avoiding bundle bloat When adding a new feature it may trigger a build failure due to the increased bundle size. We have safeguards in place to avoid bundles growing disproportionately. While there are legitimate reasons for increasing the limits, please analyze the bundle first to make sure no unintended dependencies have been included, causing the increase in size. First, make a production build with bundle-analysis enabled: ``` npx webpack -p --analyze-bundle ``` Then open the interactive bundle analyzer tool: ``` npx webpack-bundle-analyzer build/app-stats.json ``` ### Kotlin - For Kotlin code we use the [standard convention](https://kotlinlang.org/docs/coding-conventions.html) and limit line length to 120 characters. We use `ktlint` to enforce formatting. ## 🪟 Windows Development Tips Git on Windows defaults to checking out files with `CRLF` (Carriage Return & Line Feed) line endings. The Jitsi projects are primarily developed in Linux/macOS environments using `LF` line endings. If not configured correctly, Windows contributors will encounter lint failures and cause unnecessary diff noise in pull requests. ### 1. Global Git Configuration To prevent issues, it is highly recommended to configure Git to automatically handle line conversions: ```bash git config --global core.autocrlf input ``` This tells Git to automatically convert `CRLF` endings to `LF` upon commit, ensuring you do not accidentally push Windows line endings into the repository. ### 2. .gitattributes Configuration Many Jitsi repositories use a `.gitattributes` file to explicitly enforce `LF` line endings across the repository. If you use an editor like VS Code or IntelliJ, ensure you have an **EditorConfig** plugin installed (if not built-in) so your editor respects the repository's native line ending preferences. ### 3. Renormalizing an Existing Checkout If you cloned the repository *before* fixing your Git configuration and are currently experiencing lint errors or noisy diffs, you can forcefully re-normalize the line endings in your local repository checkout: ```bash git add --renormalize . git commit -m "docs: fix line endings" ``` ## ✅ Code Reviews - **Submit Your Contribution:** After completing your work, submit your contribution. - **Draft PRs for Discussion:** Consider opening a draft PR early to discuss your approach with the team before fully implementing it. Draft PRs facilitate early collaboration, ensuring efficient progress. - **Assign Reviewers:** Appropriate reviewers are assigned based on the affected code base and expertise required for changes. - **Review Process:** Reviewers will carefully examine your code, checking for adherence to coding standards, correctness, performance and potential issues. - **Feedback and Iteration:** If any issues or suggestions are identified during the review, you'll receive feedback from the reviewers. Address any comments or concerns raised and make necessary revisions to your code. - **Automated tests:** Once the PR is in a good state, a team member will trigger the automated tests. The PR needs to merge cleanly on top of master, and test failures or issues discovered at this stage will need to be addressed before the PR is approved for merging. - **Approval:** Once the code meets the required standards, passes the review, and tests, it will be approved for merging into the main codebase. ## 🎉 Issue Closing - You can close issues automatically with keywords in pull requests and commit messages. For more information, see "[Linking a pull request to an issue.](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword#linking-a-pull-request-to-an-issue-using-a-keyword)" ================================================ FILE: docs/dev-guide/electron-sdk.md ================================================ --- id: dev-guide-electron-sdk title: Electron SDK --- The Jitsi Meet Electron SDK provides a toolkit for adding Jitsi Meet into electron applications with additional features for a better desktop experience. Supported Electron versions: >= 16. ## Sample Application The Jitsi Meet Electron Application is created using the Electron SDK and makes use of all its available features. The source code is available here: [jitsi-meet-electron application repository](https://github.com/jitsi/jitsi-meet-electron). ## Installation Install from npm: npm install @jitsi/electron-sdk Note: This package contains native code on Windows for the remote control module. Binary prebuilds are packaged with prebuildify as part of the npm package. ## Usage ### Screen Sharing **Requirements**: The screen sharing utility requires iframe HTML Element that will load Jitsi Meet. **Enable the screen sharing:** In the **render** electron process of the window where Jitsi Meet is displayed: ```js const { setupScreenSharingRender } = require("@jitsi/electron-sdk"); // api - The Jitsi Meet iframe api object. setupScreenSharingRender(api); ``` In the **main** electron process: ```js 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); ``` **Note**: An example using screensharing in Electron without the SDK is available here: [screensharing example without the SDK](https://github.com/gabiborlea/jitsi-meet-electron-example). ### Remote Control **Requirements**: The remote control utility requires an iframe HTML Element that will load Jitsi Meet. **Enable the remote control:** In the **render** electron process of the window where Jitsi Meet is displayed: ```js const { RemoteControl } = require("@jitsi/electron-sdk"); // iframe - the Jitsi Meet iframe const remoteControl = new RemoteControl(iframe); ``` To disable the remote control: ```js remoteControl.dispose(); ``` NOTE: The `dispose` method will be called automatically when the Jitsi Meet iframe unloads. In the **main** electron process: ```js const { RemoteControlMain } = require("@jitsi/electron-sdk"); // jitsiMeetWindow - The BrowserWindow instance of the window where Jitsi Meet is loaded. const remoteControl = new RemoteControlMain(mainWindow); ``` ### Always On Top Displays a small window with the currently active speaker video when the main Jitsi Meet window is not focused. **Requirements**: 1. Jitsi Meet should be initialized through our [iframe API](https://github.com/jitsi/jitsi-meet/blob/master/doc/api.md) 2. The `BrowserWindow` instance where Jitsi Meet is displayed should use the [Chrome's window.open implementation](https://github.com/electron/electron/blob/master/docs/api/window-open.md#using-chromes-windowopen-implementation) (set `nativeWindowOpen` option of `BrowserWindow`'s constructor to `true`). 3. If you have a custom handler for opening windows you have to filter the always-on-top window. You can do this by its `frameName` argument which will be set to `AlwaysOnTop`. **Enable the aways on top:** In the **main** electron process: ```js const { setupAlwaysOnTopMain } = require("@jitsi/electron-sdk"); // jitsiMeetWindow - The BrowserWindow instance // of the window where Jitsi Meet is loaded. setupAlwaysOnTopMain(jitsiMeetWindow); ``` In the **render** electron process of the window where Jitsi Meet is displayed: ```js const { setupAlwaysOnTopRender } = require("@jitsi/electron-sdk"); const api = new JitsiMeetExternalAPI(...); const alwaysOnTop = setupAlwaysOnTopRender(api); alwaysOnTop.on('will-close', handleAlwaysOnTopClose); ``` `setupAlwaysOnTopRender` returns an instance of EventEmitter with the following events: * _dismissed_ - emitted when the always-on-top window is explicitly dismissed via its close button * _will-close_ - emitted right before the always-on-top window is going to close ### Power Monitor Provides a way to query Electron for system idle and receive power monitor events. **enable power monitor:** In the **main** electron process: ```js const { setupPowerMonitorMain } = require("@jitsi/electron-sdk"); // jitsiMeetWindow - The BrowserWindow instance // of the window where Jitsi Meet is loaded. setupPowerMonitorMain(jitsiMeetWindow); ``` In the **render** electron process of the window where Jitsi Meet is displayed: ```js const { setupPowerMonitorRender } = require("@jitsi/electron-sdk"); const api = new JitsiMeetExternalAPI(...); setupPowerMonitorRender(api); ``` ### NOTE: You'll need to add 'disable-site-isolation-trials' switch because of [https://github.com/electron/electron/issues/18214](https://github.com/electron/electron/issues/18214): ``` app.commandLine.appendSwitch('disable-site-isolation-trials') ``` For more information please check out the SDK's repository [https://github.com/jitsi/jitsi-meet-electron-sdk](https://github.com/jitsi/jitsi-meet-electron-sdk). ## Contributing and Local Development This section explains how the Electron SDK and the Electron app are structured as separate repositories, how to decide where a fix or feature belongs, and how to develop them together locally without publishing to npm. ### SDK vs Electron App — which layer owns what? The Electron desktop experience is split across two repositories: | Repository | Responsibility | |---|---| | [`jitsi-meet-electron-sdk`](https://github.com/jitsi/jitsi-meet-electron-sdk) | Native OS integrations: screen sharing, remote control, always-on-top window, power monitor | | [`jitsi-meet-electron`](https://github.com/jitsi/jitsi-meet-electron) | The application shell: window management, app menus, auto-updates, packaging and distribution | | [`jitsi-meet`](https://github.com/jitsi/jitsi-meet) | The meeting logic itself, rendered inside an iframe inside the Electron shell | Use this as a quick guide when triaging a bug or planning a feature: - **Always-on-top / PiP window layout or lifecycle** → fix in `jitsi-meet-electron-sdk` - **Remote control or screen sharing capture** → fix in `jitsi-meet-electron-sdk` - **App window size, tray icon, menu, auto-update** → fix in `jitsi-meet-electron` - **In-meeting UI or conference behaviour** → fix in `jitsi-meet` :::tip If a bug is visible in the Electron app but not in the web browser, it is almost always the SDK or the Electron shell. Start with `jitsi-meet-electron-sdk`. ::: ### Local development with a linked SDK When you need to test SDK changes against the Electron app without publishing a new npm release, use `npm link` to symlink your local SDK clone into the app. #### Step 1 — Clone and build the SDK ```bash git clone https://github.com/jitsi/jitsi-meet-electron-sdk cd jitsi-meet-electron-sdk npm install npm run build ``` #### Step 2 — Register the local SDK globally ```bash # Still inside jitsi-meet-electron-sdk/ npm link ``` This creates a global symlink named `@jitsi/electron-sdk` pointing to your local clone. #### Step 3 — Link it into the Electron app ```bash git clone https://github.com/jitsi/jitsi-meet-electron cd jitsi-meet-electron npm install npm link @jitsi/electron-sdk ``` #### Step 4 — Start the app ```bash npm start ``` Any changes you make in `jitsi-meet-electron-sdk/` are reflected immediately in the running app (after a rebuild of the SDK if it uses a compile step). ### Verifying the linked version is active After linking, confirm the symlink is in place: ```bash # In the jitsi-meet-electron/ directory ls -la node_modules/@jitsi/electron-sdk ``` The output should show an arrow (`->`) pointing to your local SDK path, for example: ``` node_modules/@jitsi/electron-sdk -> /home/user/jitsi-meet-electron-sdk ``` If it shows a regular directory instead, re-run `npm link @jitsi/electron-sdk`. ### Restoring the published package When you are done with local development, unlink and restore the npm-published version: ```bash # In the jitsi-meet-electron/ directory npm unlink @jitsi/electron-sdk npm install ``` To also remove the global symlink created in Step 2: ```bash # In the jitsi-meet-electron-sdk/ directory npm unlink ``` ================================================ FILE: docs/dev-guide/flutter-sdk.md ================================================ --- id: dev-guide-flutter-sdk title: Flutter SDK --- The Jitsi Meet Flutter SDK provides the same user experience as the Jitsi Meet app, in the form of a Flutter plugin so that you can embed and customize Jitsi Meet in your own Flutter app. ## Sample application using the Flutter If you want to see how easy integrating the Jitsi Meet Flutter SDK into a Flutter application is, take a look at the
[sample applications repository](https://github.com/jitsi/jitsi-meet-sdk-samples#flutter). ## Installation ### Add dependency Add the dependency from command-line ```bash $ 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'; ``` ### Usage #### Join meeting Firstly, create a `JitsiMeet` object, then call the method `join` from it with a `JitsiMeetConferenceOptions` object ```dart var jitsiMeet = JitsiMeet(); var options = JitsiMeetConferenceOptions(room: 'jitsiIsAwesome'); jitsiMeet.join(options); ``` ## Configuration ### iOS Make sure in `Podfile` from the `ios` directory you set the ios version `15.1 or higher` ``` platform :ios, '15.1' ``` The plugin requests camera and microphone access, make sure to include the required entries for `NSCameraUsageDescription` and `NSMicrophoneUsageDescription` in your `Info.plist` file from the `ios/Runner` directory. ```xml NSCameraUsageDescription The app needs access to your camera for meetings. NSMicrophoneUsageDescription The app needs access to your microphone for meetings. ``` ### Android Go to `android/app/build.gradle` and make sure that the `minSdkVersion` is set to at least 24` ```gradle android { ... defaultConfig { ... minSdkVersion 24 } } ``` The `application:label` field from the Jitsi Meet Android SDK will conflict with your application's one . Go to `android/app/src/main/AndroidManifest.xml` and add the tools library and `tools:replace="android:label"` to the application tag. ```xml ... ``` ## Using the API ### JitsiMeet The `JitsiMeet` class is the entry point for the SDK. It is used to launch the meeting screen and to send and receive all the events. 1. #### JitsiMeet() The constructor for the class. 2. #### join(JitsiMeetConferenceOptions options, [JitsiMeetEventListener? listener]) Joins a meeting with the given options and optionally a listener is given - `options` : meeting options - `listener` : event listener for events triggered by the native SDKs 3. #### hangUp() The localParticipant leaves the current meeting. 4. #### setAudioMuted(bool muted) Sets the state of the localParticipant audio muted according to the `muted` parameter. 5. #### setVideoMuted(bool muted) Sets the state of the localParticipant video muted according to the `muted` parameter. 6. #### sendEndpointTextMessage(`{String? to, required String message}`) Sends a message via the data channel to one particular participant or all of them. If the `to` param is empty, the message will be sent to all the participants in the conference. To get the participantId, the `participantsJoined` event should be listened for, which has as a parameter the `participantId` and this should be stored somehow. 7. #### toggleScreenShare(bool enabled) Sets the state of the localParticipant screen sharing according to the `enabled` parameter. 8. #### openChat([String? to]) Opens the chat dialog. If `to` contains a valid participantId, the private chat with that particular participant will be opened. 9. #### sendChatMessage(`{String? to, required String message}`) Sends a chat message to one particular participant or all of them. If the `to` param is empty, the message will be sent to all the participants in the conference. To get the participantId, the `participantsJoined` event should be listened for, which has as a parameter the `participantId` and this should be stored somehow. 10. #### closeChat() Closes the chat dialog. 11. #### retrieveParticipantsInfo() Sends an event that will trigger the `participantsInfoRetrieved` event which will contain participants' information ### JitsiMeetConferenceOptions This object encapsulates all the options that can be tweaked when joining a conference. Example: ```dart var options = JitsiMeetConferenceOptions( serverURL: "https://meet.jit.si", room: "jitsiIsAwesomeWithFlutter", configOverrides: { "startWithAudioMuted": false, "startWithVideoMuted": false, "subject" : "Jitsi with Flutter", }, featureFlags: { "unsaferoomwarning.enabled": false }, userInfo: JitsiMeetUserInfo( displayName: "Flutter user", email: "user@example.com" ), ); ``` - All the values that can be added to the `configOverrides` can be found [here](https://github.com/jitsi/jitsi-meet/blob/master/config.js). - All the values that can be added to the `featureFlags` can be found [here](https://github.com/jitsi/jitsi-meet/blob/master/react/features/base/flags/constants.ts). #### JitsiMeetUserInfo(`{String displayName, String email, String avatar}`) The constructor for the JitsiMeetUserInfo. P.S. the avatar should be an url. ### JitsiMeetEventListener This class intends to be used as a listener for events that come from the native sdks. It will receive as arguments the event handlers #### conferenceJoined(String url) Called when a conference was joined. - `url` : the conference URL #### conferenceTerminated(String url, Object? error) Called when the active conference ends, be it because of user choice or because of a failure. - `url` : the conference URL - `error` : missing if the conference finished gracefully, otherwise contains the error message #### conferenceWillJoin(String url) Called before a conference is joined. - url: the conference URL #### participantJoined(String? email, String? name, String? role, String? participantId) Called when a participant has joined the conference. - `email` : the email of the participant. It may not be set if the remote participant didn't set one. - `name` : the name of the participant. - `role` : the role of the participant. - `participantId` : the id of the participant. #### participantLeft(String? participantId) Called when a participant has left the conference. - `participantId` : the id of the participant that left. #### audioMutedChanged(bool muted) Called when the local participant's audio is muted or unmuted. - `muted` : a boolean indicating whether the audio is muted or not. #### videoMutedChanged(bool muted) Called when the local participant's video is muted or unmuted. - `muted` : a boolean indicating whether the video is muted or not. #### endpointTextMessageReceived(String senderId, String message) Called when an endpoint text message is received. - `senderId` : the participantId of the sender - `message` : the content. #### screenShareToggled(String participantId, bool sharing) Called when a participant starts or stops sharing his screen. - `participantId` : the id of the participant - `sharing` : the state of screen share #### chatMessageReceived(String senderId, String message, bool isPrivate, String? timestamp) Called when a chat text message is received. - `senderId` : the ID of the participant that sent the message. - `message` : the content of the message. - `isPrivate` : true if the message is private, false otherwise. - `timestamp` : the (optional) timestamp of the message. #### chatToggled(bool isOpen) Called when the chat dialog is opened or closed. - `isOpen` : true if the chat dialog is open, false otherwise. #### participantsInfoRetrieved(String participantsInfo) Called when the `retrieveParticipantsInfo` action is called - `participantsInfo` : a list of participants' information as a string. #### readyToClose() Called when the SDK is ready to be closed. No meeting is happening at this point. #### customButtonPressed() Called when a custom button is pressed. - `id` : the ID of the button. - `text` : the label of the button. #### Example of listener: ```dart var listener = JitsiMeetEventListener( conferenceJoined: (url) { debugPrint("conferenceJoined: url: $url"); }, participantJoined: (email, name, role, participantId) { debugPrint( "participantJoined: email: $email, name: $name, role: $role, " "participantId: $participantId", ); participants.add(participantId!); }, chatMessageReceived: (senderId, message, isPrivate) { debugPrint( "chatMessageReceived: senderId: $senderId, message: $message, " "isPrivate: $isPrivate", ); }, readyToClose: () { debugPrint("readyToClose"); }, ); ``` ================================================ FILE: docs/dev-guide/iframe-commands.md ================================================ --- id: dev-guide-iframe-commands title: Commands --- You can control the embedded Jitsi Meet conference by calling **`executeCommand`** on the **`JitsiMeetExternalAPI`** object: ```javascript api.executeCommand(command, ...arguments); ``` The command parameter is a string which contains the command name. You can also execute multiple commands using the **`executeCommands`** method: ```javascript api.executeCommands(commands); ``` The **`commands`** parameter is an object with the names of the commands as keys and the arguments for the commands as values: ```javascript api.executeCommands({ displayName: [ 'nickname' ], toggleAudio: [] }); ``` The following commands are supported: ### displayName Sets the display name of the local participant. This command requires one argument to set the new display name. ```javascript api.executeCommand('displayName', 'New Nickname'); ``` ### password Sets the password for the room. ```javascript // set new password for channel api.addEventListener('participantRoleChanged', function(event) { if (event.role === "moderator") { api.executeCommand('password', 'The Password'); } }); // join a protected channel api.on('passwordRequired', function () { api.executeCommand('password', 'The Password'); }); ``` ### toggleLobby Toggles the lobby mode on or off. This command requires the desired lobby mode state as the argument. ```javascript api.addEventListener('participantRoleChanged', function (event) { if(event.role === 'moderator') { api.executeCommand('toggleLobby', true); } }); ``` ### sendTones Touch tone playback. This command requires the selected touch tone dial pads to play as well as the length of and time gap between tone play as the arguments. ```javascript api.executeCommand('sendTones', { tones: string, // The dial pad touch tones to play. For example, '12345#'. duration: number, // Optional. The number of milliseconds each tone should play. The default is 200. pause: number // Optional. The number of milliseconds between each tone. The default is 200. }); ``` ### startShareVideo Starts sharing a video This command requires the an url pointing to either a youtube video or a video to be streamed from web (e.g an mp4 file) ```javascript api.executeCommand('startShareVideo', url); ``` ### stopShareVideo Stops sharing a video (if the user is the one who started the video) No arguments are required. ```javascript api.executeCommand('stopShareVideo'); ``` ### subject Sets the subject of the conference. This command requires the new subject to be set as the argument and it will be applied only if the participant has the moderator role or after they receive that role later on. ```javascript api.executeCommand('subject', 'New Conference Subject'); ``` ### localSubject Sets the local subject of the conference. This command requires the new local subject to be set as the argument and it can be applied by all participants regardless of their role. ```javascript api.executeCommand('localSubject', 'New Conference Local Subject'); ``` ### toggleAudio Mutes / unmutes the audio for the local participant. No arguments are required. ```javascript api.executeCommand('toggleAudio'); ``` ### toggleVideo Mutes / unmutes the video for the local participant. No arguments are required. ```javascript api.executeCommand('toggleVideo'); ``` ### toggleFilmStrip Hide or show the filmstrip. No arguments are required. ```javascript api.executeCommand('toggleFilmStrip'); ``` ### toggleChat Hide or show chat messaging. No arguments are required. ```javascript api.executeCommand('toggleChat'); ``` ### toggleRaiseHand Hide or show the raised hand. No arguments are required. ```javascript api.executeCommand('toggleRaiseHand') ``` ### toggleShareScreen Start or stop screen sharing. No arguments are required. ```javascript api.executeCommand('toggleShareScreen'); ``` ### setNoiseSuppressionEnabled Enable or disable noise suppression on the current audio track. ```javascript api.executeCommand('setNoiseSuppressionEnabled', { enabled: boolean // Enable or disable noise suppression. }); ``` ### toggleSubtitles Start or stop subtitles. No arguments are required. ```javascript api.executeCommand('toggleSubtitles'); ``` ### toggleTileView Enter or exit the tile view layout mode. No arguments are required. ```javascript api.executeCommand('toggleTileView'); ``` ### hangup Ends the call. No arguments are required. ```javascript api.executeCommand('hangup'); ``` ### endConference Ends the current conference for everyone. This command can only be executed by a meeting moderator, and requires End Conference support to be enabled for the deployment. ```javascript api.executeCommand('endConference'); ``` ### email Changes the local email address. This command requires the new email address as the single argument. ```javascript api.executeCommand('email', 'example@example.com'); ``` ### sendCameraFacingMode Sends a request to a given participant to set camera facing mode as `user` or `environment`. The receiving participant is shown a confirmation dialog. If the `facingMode` param is not sent, the camera will toggle between the two options on subsequent calls. ```javascript api.executeCommand('sendCameraFacingMode', 'receiverParticipantId', 'facingMode'); ``` ### sendEndpointTextMessage Sends a text message to another participant through the data channels. ```javascript api.executeCommand('sendEndpointTextMessage', 'receiverParticipantId', 'text'); ``` ### setLargeVideoParticipant Displays the participant on the large video display. The participant ID, if specified, is displayed on the large video. If no argument is passed, the participant to be displayed on the large video is automatically selected based on the dominant/pinned speaker settings. The second parameter is optional and can be used to specify a `videoType`. When multistream support is enabled by passing this parameter you can specify whether the desktop or the camera video for the specified participant should be selected. The accepted values are `'camera'` and `'desktop'`. The default is `'camera'`. Any invalid values will be ignored and default will be used. ```javascript api.executeCommand('setLargeVideoParticipant', 'abcd1234', 'desktop'); ``` ### setVideoQuality Sets the send and receive video resolution. The resolution height setting is implemented using a single argument. ```javascript api.executeCommand('setVideoQuality', 720); ``` ### muteEveryone Mute all meeting participants. This command can only be executed by the meeting moderator and can take one argument: `mediaType` - for which media type to mute everyone. `mediaType` can be either 'audio' (default) or 'video'. ```javascript api.executeCommand('muteEveryone', 'video'); ``` ### muteRemoteParticipant Mutes a specific remote participant. This command can only be executed by the meeting moderator and takes two arguments: - `participantId` - The ID of the participant to mute (required) - `mediaType` - The media type to mute: either `'audio'` (default) or `'video'` ```javascript // Mute participant's audio api.executeCommand('muteRemoteParticipant', 'participantId123'); // Mute participant's video api.executeCommand('muteRemoteParticipant', 'participantId123', 'video'); ``` ### startRecording Starts a local recording, file recording, streaming session or transcription using passed parameters: - **RTMP streaming** - Recording mode set to **`stream`** with an **`rtmpStreamKey`**. The **`rtmpBroadcastID`** value is optional. - **YouTube streams** - Recording mode set to **`stream`** with an **`youtubeStreamKey`**. The **`youtubeBroadcastID`** value is optional. - **Local Recording** - Recording mode set to **`local`**. The **`onlySelf`** value is optional. - **Dropbox recording** - Recording mode set to **`file`** with a Dropbox OAuth2 token. Additionally, Dropbox saving should be enabled on the Jitsi meet deploy config you are using. - **File recording** - Recording mode set to **`file`**. The **`extraMetadata`** value is optional. Optionally, **`shouldShare`** should be passed on. No other params are required. - **Transcription** - Set the `transcription` option to `true`. ```javascript api.executeCommand('startRecording', { mode: string, //recording mode, either `local`, `file` or `stream`. dropboxToken: string, //dropbox oauth2 token. onlySelf: boolean, //Whether to only record the local streams. Only applies to `local` recording mode. shouldShare: boolean, //whether the recording should be shared with the participants or not. Only applies to certain jitsi meet deploys. rtmpStreamKey: string, //the RTMP stream key. rtmpBroadcastID: string, //the RTMP broadcast ID. youtubeStreamKey: string, //the youtube stream key. youtubeBroadcastID: string, //the youtube broacast ID. extraMetada: Object, // any extra metada for file recording. transcription: boolean, // Whether a transcription should be started. }); ``` ### stopRecording Stops an ongoing **`local`**, **`stream`**, **`file`** recording or transcription. The mode in which the recording was started must be specified. ```javascript api.executeCommand('stopRecording', mode: string, //recording mode to stop, `local`, `stream` or `file` transcription: boolean // whether the transcription should be stopped ); ``` ### initiatePrivateChat Opens the chat window and sets the participant with the given participant ID as the messages recipient. ```javascript api.executeCommand('initiatePrivateChat', participantID: string ); ``` ### cancelPrivateChat Removes the private chat participant thus it resets the chat window to group chat. ```javascript api.executeCommand('cancelPrivateChat'); ``` ### kickParticipant Kicks the participant with the given participant ID from the meeting. ```javascript api.executeCommand('kickParticipant', participantID: string ); ``` ### grantModerator Grants moderator rights to the participant with the given ID. ```javascript api.executeCommand('grantModerator', participantID: string ); ``` ### overwriteConfig Overwrite config.js props with values from the config object passed on to the command. ```javascript api.executeCommand('overwriteConfig', config: Object ); ``` For example: ```javascript api.executeCommand('overwriteConfig', { toolbarButtons: ['chat'] } ); ``` will overwrite the `toolbarButtons` config value with `[chat]`, resulting in UI only showing the `chat` button. ### sendChatMessage Sends a chat message either to a specific participant or as a group chat message. ```javascript api.executeCommand('sendChatMessage', message: string, //the text message to: string, // the receiving participant ID or empty string/undefined for group chat. ignorePrivacy: boolean // true if the privacy notification should be ignored. Defaulted to false. ); ``` ### setFollowMe Allows moderators to toggle the follow me functionality ```javascript api.executeCommand('setFollowMe', value: boolean, // set to true if participants should be following you, false otherwise recorderOnly: boolean // Whether the recorder will be the only one following you. The default is false. ); ``` ### setSubtitles Enables or disables the subtitles. ```javascript api.executeCommand('setSubtitles', enabled: boolean, displaySubtitles: boolean = true, language: string | null = 'en' ); ``` ### setTileView Enables or disables the tileview mode. ```javascript api.executeCommand('setTileView', enabled: boolean ); ``` ### answerKnockingParticipant Approves or rejects the knocking participant in the lobby. ```javascript api.executeCommand('answerKnockingParticipant', id: string, // the participant id approved: boolean ); ``` ### toggleCamera Sets the camera facing mode as `user` or `environment` on mobile web. If the `facingMode` param is not sent, a toggle between back and front camera happens on subsequent calls. ```javascript api.executeCommand('toggleCamera', 'facingMode'); ``` ### toggleCameraMirror Toggles the mirroring of the local video. ```javascript api.executeCommand('toggleCameraMirror'); ``` ### toggleVirtualBackgroundDialog Toggles the virtual background selection dialog. ```javascript api.executeCommand('toggleVirtualBackgroundDialog'); ``` ### pinParticipant Pins a conference participant. ```javascript api.executeCommand('pinParticipant', id?: string // The ID of the conference participant to pin or null to unpin all ); ``` ### setParticipantVolume Change volume of the participant with the given participant ID. ```javascript api.executeCommand('setParticipantVolume', participantID: string, volume: number // number between 0 and 1 ); ``` ### toggleParticipantsPane Changes the visibility status of the participants pane. ```javascript api.executeCommand('toggleParticipantsPane', enabled: boolean // The visibility status of the participants pane. ); ``` ### toggleModeration Changes moderation status of the given media type. This command requires two arguments: `enable` - whether to enable it or not, and `mediaType` - the media type for which to change moderation. ```javascript api.executeCommand('toggleModeration', enable: Boolean, mediaType: String // can be 'audio' (default) or 'video' ); ``` ### askToUnmute Asks the participant with the given ID to unmute. If audio moderation is on it also approves the participant for audio. ```javascript api.executeCommand('askToUnmute', participantId: String ); ``` ### approveVideo If video moderation is on it approves the participant with the given ID for video. ```javascript api.executeCommand('approveVideo', participantId: String ); ``` ### rejectParticipant Rejects the participant with the given ID from moderation of the given media type. ```javascript api.executeCommand('rejectParticipant', participantId: String, mediaType: String // can be 'audio' (default) or 'video' ); ``` ### addBreakoutRoom Creates a breakout room. This command can only be executed by the meeting moderator. ```javascript api.executeCommand('addBreakoutRoom', name: String // Optional. The name or subject of the new room. ); ``` ### autoAssignToBreakoutRooms Auto-assigns the participants to breakout rooms. This command can only be executed by the meeting moderator. ```javascript api.executeCommand('autoAssignToBreakoutRooms'); ``` ### closeBreakoutRoom Closes the breakout room and sends participants to the main room. This command can only be executed by the meeting moderator. ```javascript api.executeCommand('closeBreakoutRoom', roomId: String // The id of the room to close. ); ``` ### joinBreakoutRoom Joins a breakout room. If the argument is omitted, joins the main room. ```javascript api.executeCommand('joinBreakoutRoom', roomId: String // Optional. The id of the room to join. ); ``` ### removeBreakoutRoom Removes the breakout room. This command can only be executed by the meeting moderator. ```javascript api.executeCommand('removeBreakoutRoom', breakoutRoomJid: String // The jid of the breakout room to remove. ); ``` ### resizeFilmStrip Resizes the filmstrip. ```javascript api.executeCommand('resizeFilmStrip', { width: number // The desired filmstrip width }); ``` ### resizeLargeVideo Resizes the large video container based on the dimensions provided. ```javascript api.executeCommand('resizeLargeVideo', width: number, // The desired width height: number // The desired height ); ``` ### sendParticipantToRoom Sends a participant to a room. This command can only be executed by the meeting moderator. ```javascript api.executeCommand('sendParticipantToRoom', participantId: String, // The id of the participant. roomId: String // The id of the room. ); ``` ### overwriteNames Overwrites the names of the given participants to the given names. (locally for the participant that send the command) ```javascript api.executeCommand('overwriteNames', [{ id: String, // The id of the participant. name: String // The new name. }] ); ``` ### showNotification Shows a custom notification. This affects only the local user. If `uid` is provided, the notification will replace existing notification with the same `uid`. The `uid` can also be passed to the `hideNotification` command to programmatically hide the notification. If `customActions` is provided, when triggered, the actions will fire a [customNotificationActionTriggered](https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-iframe-events#customnotificationactiontriggered) event with their corresponding uuid ```javascript api.executeCommand('showNotification', { title: String, // Title of the notification. description: String, // Content of the notification. customActions: Object(label: String, uuid: String)[], // Optional. Define custom actions to be displayed on the notification uid: String, // Optional. Unique identifier for the notification. type: String, // Optional. Can be 'normal', 'success', 'warning' or 'error'. Defaults to 'normal'. timeout: String // optional. Can be 'short', 'medium', 'long', or 'sticky'. Defaults to 'short'. }); ``` ### hideNotification Hides the notification which has the given `uid`. ```javascript api.executeCommand('hideNotification', uid: String // Unique identifier for the notification to be removed. ); ``` ### toggleWhiteboard Toggles the whiteboard to open, repeated toggling hidden the whiteboard ```javascript api.executeCommand('toggleWhiteboard'); ``` ### setAssumedBandwidthBps Sets the assumed bandwidth bps. ```javascript api.executeCommand('setAssumedBandwidthBps', assumedBandwidthBps: number // Required. The value to set as assumed bandwidth expressed in bps. ); ``` ### setBlurredBackground Sets or removes the blurred virtual background to the user camera. ```javascript api.executeCommand('setBlurredBackground', blurType: String // Required. Blur type to apply. Accepted values are 'slight-blur', 'blur' or 'none'. ); ``` ### setAudioOnly Enables or disables the audio only mode. ```javascript api.executeCommand('setAudioOnly', enable: boolean // Required. true for enable and false for disable ); ``` ### setVirtualBackground Set your virtual background with a base64 image. ```javascript api.executeCommand('setVirtualBackground', enabled: boolean, // Required. Enable or disable the virtual background. backgroundImage: string // Required. Base64 image string, eg. "data:image/png;base64, iVBOR...". ); ``` ================================================ FILE: docs/dev-guide/iframe-events.md ================================================ --- id: dev-guide-iframe-events title: Events --- The `JitsiMeetExternalAPI` object implements the [EventEmitter] API for emitting and listening for events. You can add event listeners to the embedded Jitsi Meet using the **`addListener`** method: ```javascript api.addListener(event, listener); ``` If you want to remove a listener you can use the **`removeListener`** method: ```javascript api.removeListener(event, listener); ``` The **`event`** parameter is a string object with the name of the event. The **`listener`** parameter is a function object with one argument that creates a notification when the event occurs along with related event data. The following events are currently supported: ### cameraError Provides event notifications about Jitsi Meet having failed to access the meeting camera. The listener receives an object with the following structure: ```javascript { type: string, // A constant representing the overall type of the error. message: string // Additional information about the error. } ``` ### avatarChanged Provides event notifications about changes to a participant's avatar. The listener receives an object with the following structure: ```javascript { id: string, // the id of the participant that changed his avatar. avatarURL: string // the new avatar URL. } ``` ### audioAvailabilityChanged Provides event notifications about changes to audio availability status. The listener receives an object with the following structure: ```javascript { available: boolean // new available status - boolean } ``` ### audioMuteStatusChanged Provides event notifications about changes to audio mute status. The listener receives an object with the following structure: ```javascript { muted: boolean // new muted status - boolean } ``` ### breakoutRoomsUpdated Provides notifications about breakout rooms changes. The listener receives an object with the following structure: ```javascript { [roomId]: { id: string, jid: string, name: string, isMainRoom: true | undefined, participants: { [participantJid]: { displayName: string, jid: string, role: string } } }, ... } ``` ### browserSupport Provides event notifications about the current browser support. The listener receives an object with the following structure: ```javascript { supported: boolean } ``` ### contentSharingParticipantsChanged Provides real-time list of currently screen sharing participant ID's. The listener receives an object with the following structure: ```javascript { data: ["particId1", "particId2", ...] } ``` ### customNotificationActionTriggered Callback that triggers for custom actions defined for the [showNotification](https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-iframe-commands/#shownotification) command The listener receives an object with the following structure: ```javascript { data: { id: string // uuid of the triggered action } } ``` ### dataChannelOpened Indicates the data channel is open and thus messages can be sent over it. ### endpointTextMessageReceived Provides event notifications about a text messages received through data channels. The listener receives an object with the following structure: ```javascript { senderInfo: { jid: string, // the jid of the sender id: string // the participant id of the sender }, eventData: { name: string, // the name of the datachannel event: `endpoint-text-message` text: string // the received text from the sender } } ``` ### nonParticipantMessageReceived Provides event notifications about a messages sent by a non-participant, e.g. a custom prosody message. The listener receives an object with the following structure: ```javascript { id: string, // the id of the message, may be null message: string // the message received } ``` ### faceLandmarkDetected Provides event notifications when a face landmark is detected The listener receives an object with the following structure: ```javascript { faceBox: { left: number, // face bounding box distance as percentage from the left video edge right: number // face bounding box distance as percentage from the right video edge width: number // face bounding box width as percentage of the total video width }, // this might be undefined if config.faceLandmarks.faceCenteringThreshold is not passed faceExpression: string // check https://github.com/jitsi/jitsi-meet/blob/master/react/features/face-landmarks/constants.js#L3 for available values } ``` ### errorOccurred Provides event notifications about an error which has occurred. The listener receives an object with the following structure: ```javascript { details: Object?, // additional error details message: string?, // the error message name: string, // the coded name of the error type: string, // error type/source, one of : 'CONFIG', 'CONNECTION', 'CONFERENCE' isFatal: boolean // whether this is a fatal error which triggered a reconnect overlay or not } ``` ### knockingParticipant Provides event notifications about a knocking participant in the lobby. The listener receives an object with the following structure: ```javascript { participant: { // the id and name of the participant that is currently knocking in the lobby id: string, name: string } } ``` ### largeVideoChanged Provides event notifications about changes in the large video display. The listener receives an object with the following structure: ```javascript { id: string // id of the participant that is now on large video in the stage view. } ``` ### log Provides log event notifications with the log level being one of the values specified in the [config.js] file in the **`apiLogLevels`** property (if not specified the event does not fire). The listener receives an object with the following structure: ```javascript { logLevel: string, // A constant representing the log type (info, error, debug, warn). args: string // Additional log information. } ``` ### micError Provides event notifications about Jitsi Meet issues with mic access. The listener receives an object with the following structure: ```javascript { type: string, // A constant representing the overall type of the error. message: string // Additional information about the error. } ``` ### screenSharingStatusChanged Provides event notifications about either turning on or off local user screen sharing. The listener receives an object with the following structure: ```javascript { on: boolean, //whether screen sharing is on details: { // From where the screen sharing is capturing, if known. Values which are // passed include 'window', 'screen', 'proxy', 'device'. The value undefined // will be passed if the source type is unknown or screen share is off. sourceType: string|undefined } } ``` ### dominantSpeakerChanged Provides event notifications about dominant speaker changes. The listener receives an object with the following structure: ```javascript { id: string //participantId of the new dominant speaker } ``` ### raiseHandUpdated Provides event notifications about the participant raising/lowering the hand. The listener will receive an object with the following structure: ```javascript { id: string, // participantId of the user who raises/lowers the hand handRaised: number // 0 when hand is lowered and the hand raised timestamp when raised. } ``` ### tileViewChanged Provides event notifications about entrance or exit from the tile view layout mode. The listener receives an object with the following structure: ```javascript { enabled: boolean, // whether tile view is not displayed or not } ``` ### chatUpdated Provides event notifications about chat state being updated. The listener receives an object with the following structure: ```javascript { isOpen: boolean, // Whether the chat panel is open or not unreadCount: number // The unread messages counter } ``` ### incomingMessage Provides event notifications about incoming chat messages. The listener receives an object with the following structure: ```javascript { from: string, // the id of the user that sent the message nick: string, // the nickname of the user that sent the message privateMessage: boolean, // whether this is a private or group message message: string // the text of the message stamp: string // the message timestamp as string (ISO-8601) } ``` ### mouseEnter Provides event notifications when mouse enters the iframe. The listener receives an object with the following structure based on [MouseEvent]: ```javascript { event: { clientX, clientY, movementX, movementY, offsetX, offsetY, pageX, pageY, x, y, screenX, screenY } } ``` ### mouseLeave Provides event notifications when mouse leaves the iframe. The listener receives an object with the following structure based on [MouseEvent]: ```javascript { event: { clientX, clientY, movementX, movementY, offsetX, offsetY, pageX, pageY, x, y, screenX, screenY } } ``` ### mouseMove Provides event notifications when mouse moves inside the iframe. Tis event is triggered on an interval which can be configured by overriding the config.js mouseMoveCallbackInterval property. The listener receives an object with the following structure based on [MouseEvent]: ```javascript { event: { clientX, clientY, movementX, movementY, offsetX, offsetY, pageX, pageY, x, y, screenX, screenY } } ``` ### participantMenuButtonClick Provides event notifications about a participant context menu button being clicked. The listener receives an object with the following structure: ```javascript { key: string, // the pressed button's key. The key is as defined in `toolbarButtons` config, participantId: string, // the id of the participant for which the button was clicked, preventExecution: boolean // whether the execution of the button click was prevented or not } ``` ### toolbarButtonClicked Provides event notifications about a toolbar button being clicked and whether the click routine was executed or not. To enable this notification you need to add the button to [`buttonsWithNotifyClick` config](/handbook/docs/dev-guide/dev-guide-configuration#buttonswithnotifyclick). The listener receives an object with the following structure: ```javascript { key: string, // the pressed button's key. The key is as defined in `toolbarButtons` config, preventExecution: boolean // whether the click routine execution was prevented or not. } ``` ### outgoingMessage Provides event notifications about outgoing chat messages. The listener receives an object with the following structure: ```javascript { message: string, // the text of the message privateMessage: boolean // whether this is a private or group message } ``` ### displayNameChange Provides event notifications about display name changes. The listener receives an object with the following structure: ```javascript { id: string, // the id of the participant that changed their display name displayname: string // the new display name } ``` ### deviceListChanged Provides event notifications about device list changes. The listener receives an object with the following structure: ```javascript { devices: Object // the new list of available devices. } ``` **NOTE:** The **`device`** object has the same format as the **`getAvailableDevices`** result format. ### emailChange Provides event notifications about email changes. The listener receives an object with the following structure: ```javascript { id: string, // the id of the participant that changed his email email: string // the new email } ``` ### feedbackSubmitted Provides event notifications about conference feedback submissions: ```javascript { error: string // The error which occurred during submission, if any. } ``` ### fileDeleted Provides event notifications when a file is deleted from the meeting. The listener receives an object with the following structure: ```javascript { fileId: string // The ID of the deleted file } ``` ### fileUploaded Provides event notifications when a file is uploaded to the meeting. The listener receives an object with the following structure: ```javascript { file: { authorParticipantId: string, // ID of participant who uploaded the file authorParticipantJid: string, // Full JID of participant who uploaded the file authorParticipantName: string, // Display name of participant who uploaded the file conferenceFullName: string, // Full conference JID fileId: string, // Unique ID of the file fileName: string, // Name of the file fileSize: number, // Size of the file in bytes fileType: string, // File extension/type timestamp: number // Upload timestamp in milliseconds } } ``` ### filmstripDisplayChanged Provides event visibility notifications for the filmstrip that is being updated: ```javascript { visible: boolean // Whether or not the filmstrip is displayed or hidden. } ``` ### toolbarVisibilityChanged Provides event notifications when the in-page Jitsi Meet toolbar (toolbox) is shown or hidden. The listener receives an object with the following structure: ```javascript { visible: boolean // Whether the toolbar is currently visible. } ``` ### moderationStatusChanged Provides event notifications about changes to moderation status. ```javascript { mediaType: string, // The media type for which moderation changed. enabled: boolean // Whether or not moderation changed to enabled. } ``` ### moderationParticipantApproved Provides event notifications about participants approvals for moderation. ```javascript { id: string, // The ID of the participant that got approved. mediaType: string // The media type for which the participant was approved. } ``` ### moderationParticipantRejected Provides event notifications about participants rejections for moderation. ```javascript { id: string, // The ID of the participant that got rejected. mediaType: string // The media type for which the participant was rejected. } ``` ### notificationTriggered Provides event notifications when an application notification occurs. ```javascript { title: string, // The notification title. description: string // The notification description. } ``` ### participantJoined Provides event notifications about new participants who join the room. The listener receives an object with the following structure: ```javascript { id: string, // the id of the participant displayName: string, // the display name of the participant userContext: { id: string // the JWT id of the participant } } ``` ### participantKickedOut Provides event notifications about participants being removed from the room. The listener receives an object with the following structure: ```javascript { kicked: { id: string, // the id of the participant removed from the room local: boolean // whether or not the participant is the local particiapnt }, kicker: { id: string // the id of the participant who kicked out the other participant } } ``` ### participantLeft Provides event notifications about participants that leave the meeting room. The listener receives an object with the following structure: ```javascript { id: string // the id of the participant } ``` ### participantRoleChanged Provides event notifications that fire when the local user role has changed (e.g., none, moderator, participant). The listener receives an object with the following structure: ```javascript { id: string // the id of the participant role: string // the new role of the participant } ``` ### participantsPaneToggled Provides event notifications that fire when the participants pane status changes. The listener receives an object with the following structure: ```javascript { open: boolean // whether the pane is open or not } ``` ### participantMuted Provides event notifications about participant mute state changes. The listener receives an object with the following structure: ```javascript { participantId: string, // the id of the participant whose mute state changed isMuted: boolean, // whether the participant is now muted mediaType: string // the media type: 'audio' or 'video' } ``` ### passwordRequired Provides event notifications that fire when participants fail to join a password protected room. ### videoConferenceJoined Provides event notifications that fire when the local user has joined the video conference. The listener receives an object with the following structure: ```javascript { roomName: string, // the room name of the conference id: string, // the id of the local participant displayName: string, // the display name of the local participant avatarURL: string, // the avatar URL of the local participant breakoutRoom: boolean, // whether the current room is a breakout room visitor: boolean // whether the current user is a visitor } ``` ### videoConferenceLeft Provides event notifications that fire when the local user has left the video conference. The listener receives an object with the following structure: ```javascript { roomName: string // the room name of the conference } ``` ### conferenceCreatedTimestamp Provides notification of the start time of the video conference. The listener receives an object with the following structure: ```javascript { timestamp: timestamp // time the conference started } ``` ### videoAvailabilityChanged Provides event notifications about video availability status changes. The listener receives an object with the following structure: ```javascript { available: boolean // new available status - boolean } ``` ### videoMuteStatusChanged Provides event notifications about video mute status changes. The listener receives an object with the following structure: ```javascript { muted: boolean // new muted status - boolean } ``` ### videoQualityChanged Provides event notifications about changes to video quality settings. The listener receives an object with the following structure: ```javascript { videoQuality: number // the height of the resolution related to the new video quality setting. } ``` ### readyToClose Provides event notifications that fire when Jitsi Meet is ready to be closed (i.e., hangup operations are completed). ### recordingLinkAvailable Provides event notifications about recording link becoming available. The listener receives an object with the following structure: ```javascript { link: string, // the recording link ttl: number // the time to live of the recording link } ``` ### recordingStatusChanged Provides event notifications about recording status changes. The listener receives an object with the following structure: ```javascript { on: boolean // new recording status - boolean, mode: string // recording mode, `local`, `stream` or `file`, error: string | undefined // error type if recording fails, undefined otherwise transcription: boolean // whether a transcription is active or not } ``` ### subjectChange Provides event notifications regarding the change of subject for a conference. The listener receives an object with the following structure: ```javascript { subject: string // the new subject } ``` ### suspendDetected Provides notifications about detecting suspended events in the host computer. ### peerConnectionFailure Notify the external application that a PeerConnection lost connectivity. This event is fired only if a PC `failed` but connectivity to the rtcstats server is still maintained signaling that there is a problem establishing a link between the app and the JVB server or the remote peer in case of P2P. Will only fire if rtcstats is enabled. ```javascript { // Type of PC, Peer2Peer or JVB connection. isP2P: boolean, // Was this connection previously connected. If it was it could mean // that connectivity was disrupted, if not it most likely means that the app could not reach // the JVB server, or the other peer in case of P2P. wasConnected: boolean } ``` ### transcribingStatusChanged Provides event notifications about status changes in the transcribing process. The listener receives an object with the following structure: ```javascript { on: boolean, } ``` ### transcriptionChunkReceived Provides event notifications about new transcription chunks being available. The listener receives an object with the following structure: ```javascript { // Transcription language language: string, // ID for this chunk. messageID: string, // participant info participant: { avatarUrl: string, id: string name: string, }, // If the transcription is final, the text will be here. final: string, // If the transcription is not final but has high accuracy the text will be here. stable: string, // If the transcription is not final but has low accuracy the text will be here. unstable: string, } ``` ### whiteboardStatusChanged Provides event notifications about changes to the whiteboard. The listener receives an object with the following structure: ```javascript { status: string // new whiteboard status } ``` ### p2pStatusChanged Provides event notifications about changes to the connection type. The listener receives an object with the following structure: ```javascript { isP2p: boolean|null // whether the new connection type is P2P } ``` ### audioOnlyChanged Provides event notifications about changes to the audio only mode status. The listener receives an object with the following structure: ```javascript { audioOnlyChanged: boolean // whether the audio only is enabled or disabled. } ``` [config.js]: https://github.com/jitsi/jitsi-meet/blob/master/config.js [interface_config.js]: https://github.com/jitsi/jitsi-meet/blob/master/interface_config.js [EventEmitter]: https://nodejs.org/api/events.html [MouseEvent]: https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent ================================================ FILE: docs/dev-guide/iframe-functions.md ================================================ --- id: dev-guide-iframe-functions title: Functions --- Use the following API functions to control your embedded Jitsi Meet Conference. ### captureCameraPicture Mobile browsers only. Captures a high quality picture using the device's camera. All parameters are optional. ```javascript api.captureCameraPicture( cameraFacingMode, // the facing mode: environment/user. Defaults to environment. descriptionText, // a custom description text to replace the default text on the consent dialog. titleText // a custom title to replace the default title on the consent dialog. ).then(data => { // data is an Object with only one param, either dataURL on success or error on failure. // - dataURL is the base64 string of the taken picture // - error is a string, a verbose explanation of the problem // data.dataURL = "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAABQAA..." }); ``` ### captureLargeVideoScreenshot Captures a screenshot for the participant in the large video view (on stage). ```javascript api.captureLargeVideoScreenshot().then(data => { // data is an Object with only one param, dataURL // data.dataURL = "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAABQAA..." }); ``` ### getAvailableDevices Retrieves a list of available 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' // },....] // } ... }); ``` ### getContentSharingParticipants Returns a promise which resolves with an array of currently sharing participants ID's. ```javascript api.getContentSharingParticipants().then(res => { //res.sharingParticipantIds = [particId1, particId2, ...] }); ``` ### getCurrentDevices Retrieves a list of currently selected 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' // } // } ... }); ``` ### getDeploymentInfo Retrieves an object containing information about the deployment. ```javascript api.getDeploymentInfo().then(deploymentInfo => { // deploymentInfo = { // region: 'deployment-region', // shard: 'deployment-shard', // ... // } ... }); ``` ### getLivestreamUrl Retrieves an object containing information about livestreamUrl of the current live stream. ```javascript api.getLivestreamUrl().then(livestreamData => { // livestreamData = { // livestreamUrl: 'livestreamUrl' // } ... }); ``` ### getParticipantsInfo __DEPRECATED__ Use `getRoomsInfo` instead. Returns an array containing participant information such as ID, display name, avatar URL, and email. ```javascript api.getParticipantsInfo(); ``` ### getRoomsInfo Returns an array of available rooms and details of it: - `isMainRoom` (true,false), `id`, `jid` - participants: `Participant[]` - `id` - `jid` - `role` - `displayName` - `userContext` ```javascript api.getRoomsInfo().then(rooms => { ... // see response example structure }) ``` Response example structure: ```json { "rooms": [ { "isMainRoom": true, "id": "room_name@conference.jitsi", "jid": "room_name@conference.jitsi/aaaaaa", "participants": [ { "jid": "room_name@conference.jitsi/bbbbbb", "role": "participant", "displayName": "p1", "id": "bbbbbb", "userContext": { "id": "google-oauth2|12345678901234567890" } }, { "jid": "room_name@conference.jitsi/cccccc", "role": "participant", "displayName": "p2", "id": "cccccc", "userContext": { "id": "400e45d607256777df4e0f3a6a447901" } } ] }, { "isMainRoom": false, "id": "aaaaaa-bbb-cccc-dddd-qwertyuiopas", "jid": "aaaaaa-bbb-cccc-dddd-qwertyuiopas@breakout.jitsi", "participants": [{ "jid": "aaaaaa-cccc-dddd-eeee-qwertyuiopas@jitsi/abcd1234", "role": "moderator", "displayName": "Participant name", "avatarUrl": "", "id": "abcd1234", "userContext": { "id": "73317803a589aaa027132696dd77ac34" } }] }, ] } ``` ### getSessionId Returns the meting's unique Id (`sessionId`). Please note that the `sessionId` is not available when in prejoin screen and it's not guaranteed to be available immediately after joining - in which cases it will be empty. ```javascript api.getSessionId().then(sessionId => { //sessionId: string ... }); ``` ### getSharedDocumentUrl Returns the meeting's unique etherpad shared document url (`sharedDocumentUrl`). Please note that the `sharedDocumentUrl` is not available when in prejoin screen and it's not guaranteed to be available immediately after joining - in which cases it will be empty. ```javascript api.getSharedDocumentUrl().then(sharedDocumentUrl => { //sharedDocumentUrl: string ... }); ``` ### getVideoQuality Returns the current video quality setting. ```javascript api.getVideoQuality(); ``` ### getSupportedCommands Returns array of commands supported by `api.executeCommand(command, ...arguments)`; ```javascript api.getSupportedCommands(); ``` ### getSupportedEvents Returns array of events supported by `api.addListener(event, listener)`; ```javascript api.getSupportedEvents(); ``` ### isDeviceChangeAvailable Resolves to true if the device change is available and to false if not. ```javascript // The accepted deviceType values are - 'output', 'input' or undefined. api.isDeviceChangeAvailable(deviceType).then(isDeviceChangeAvailable => { ... }); ``` ### isDeviceListAvailable Resolves to true if the device list is available and to false if not. ```javascript api.isDeviceListAvailable().then(isDeviceListAvailable => { ... }); ``` ### isMultipleAudioInputSupported Resolves to true if multiple audio input is supported and to false if not. ```javascript api.isMultipleAudioInputSupported().then(isMultipleAudioInputSupported => { ... }); ``` ### pinParticipant Selects the participant ID to be the pinned participant in order to always receive video for this participant. The second parameter is optional and can be used to specify a `videoType`. When multistream support is enabled by passing this parameter you can specify whether the desktop or the camera video for the specified participant should be pinned. The accepted values are `'camera'` and `'desktop'`. The default is `'camera'`. Any invalid values will be ignored and default will be used. ```javascript api.pinParticipant(participantId, videoType); ``` ### resizeLargeVideo Resizes the large video container per the provided dimensions. ```javascript api.resizeLargeVideo(width, height); ``` ### setAudioInputDevice Sets the audio input device to the one with the passed label or ID. ```javascript api.setAudioInputDevice(deviceLabel, deviceId); ``` ### setAudioOutputDevice Sets the audio output device to the one with the passed label or ID. ```javascript api.setAudioOutputDevice(deviceLabel, deviceId); ``` ### setLargeVideoParticipant Displays the participant with the given participant ID on the large video. If no participant ID is given, a participant is picked based on the dominant, pinned speaker settings. ```javascript api.setLargeVideoParticipant(participantId); ``` ### setVideoInputDevice Sets the video input device to the one with the passed label or ID. ```javascript api.setVideoInputDevice(deviceLabel, deviceId); ``` ### setVirtualBackground Set your virtual background with a base64 image. ```javascript /** * @param {boolean} enabled - Enable or disable the virtual background. * @param {string} backgroundImage - Base64 image string, eg. "data:image/png;base64, iVBOR...". */ api.setVirtualBackground(enabled, backgroundImage); ``` ### startRecording Starts a file recording or streaming session. See the `startRecording` command for more details. ```javascript api.startRecording(options); ``` ### stopRecording Stops an ongoing file recording, streaming session or transcription. See the `stopRecording` command for more details. ```javascript api.stopRecording(mode, transcription); ``` ### getNumberOfParticipants Returns the number of conference participants: ```javascript const numberOfParticipants = api.getNumberOfParticipants(); ``` ### getAvatarURL __DEPRECATED__ Use `getRoomsInfo` instead. Returns a participant's avatar URL: ```javascript const avatarURL = api.getAvatarURL(participantId); ``` ### getDisplayName Returns a participant's display name: ```javascript const displayName = api.getDisplayName(participantId); ``` ### getEmail Returns a participant's email: ```javascript const email = api.getEmail(participantId); ``` ### getIFrame Returns the IFrame HTML element which is used to load the Jitsi Meet conference: ```javascript const iframe = api.getIFrame(); ``` ### isAudioDisabled Returns a Promise which resolves to the current audio disabled state: ```javascript api.isAudioDisabled().then(disabled => { ... }); ``` ### isAudioMuted Returns a Promise which resolves to the current audio muted state: ```javascript api.isAudioMuted().then(muted => { ... }); ``` ### isVideoMuted Returns a Promise which resolves to the current video muted state: ```javascript api.isVideoMuted().then(muted => { ... }); ``` ### isAudioAvailable Returns a Promise which resolves to the current audio availability state: ```javascript api.isAudioAvailable().then(available => { ... }); ``` ### isVideoAvailable Returns a Promise which resolves to the current video availability state: ```javascript api.isVideoAvailable().then(available => { ... }); ``` ### isVisitor Returns a whether the current user is a visitor or not. ```javascript const isVisitor = api.isVisitor(); ``` ### isModerationOn Returns a Promise which resolves to the current moderation state of the given media type. `mediaType` can be either `audio` (default) or `video`. ```javascript api.isModerationOn(mediaType).then(isModerationOn => { ... }); ``` ### isP2pActive Returns a Promise which resolves to a Boolean or null, when there is no conference. ```javascript api.isP2pActive().then(isP2p => { ... }); ``` ### isParticipantForceMuted Returns a Promise which resolves to the current force mute state of the given participant for the given media type. `mediaType` can be either `audio` (default) or `video`. Force muted - moderation is on and participant is not allowed to unmute the given media type. ```javascript api.isParticipantForceMuted(participantId, mediaType).then(isForceMuted => { ... }); ``` ### isParticipantsPaneOpen Returns a Promise which resolves with the current participants pane state. ```javascript api.isParticipantsPaneOpen().then(state => { ... }); ``` ### isStartSilent Returns a Promise which resolves with whether meeting was started in view only. ```javascript api.isStartSilent().then(startSilent => { ... }); ``` ### listBreakoutRooms Returns a Promise which resolves with the map of breakout rooms. ```javascript api.listBreakoutRooms().then(breakoutRooms => { ... }); ``` ### invite Invite the given array of participants to the meeting: ```javascript api.invite([ {...}, {...}, {...} ]).then(() => { // success }).catch(() => { // failure }); ``` **NOTE:** The invitee format in the array depends on the invite service used in the deployment. PSTN invite objects have the following structure: ```javascript { type: 'phone', number: // the phone number in E.164 format (ex. +31201234567) } ``` SIP invite objects have the following structure: ```javascript { type: 'sip', address: // the sip address } ``` ### dispose Removes the embedded Jitsi Meet conference: ```javascript api.dispose(); ``` **NOTE:** Jitsi recommends removing the conference before the page is unloaded. ================================================ FILE: docs/dev-guide/iframe.md ================================================ --- id: dev-guide-iframe title: IFrame API --- Embedding the Jitsi Meet API into your site or app enables you to host and provide secure video meetings with your colleagues, teams, and stakeholders. The Meet API provides a full complement of comprehensive meeting features. Your Jitsi meetings can be hosted and attended using any device while keeping your data and privacy protected. You can reach your meeting participants anywhere in the world eliminating the need for travel and the associated inconvenience. The IFrame API enables you to embed Jitsi Meet functionality into your meeting application so you can experience the full functionality of the globally distributed and highly available deployment available with [meet.jit.si](https://meet.jit.si/). You can also embed and integrate the globally distributed and highly available deployment on the [meet.jit.si](https://meet.jit.si/) platform itself. :::note NOTE JaaS customers, please make sure you also read [this](https://developer.8x8.com/jaas/docs/iframe-api-overview)! ::: :::tip If you use React in your web application you might want to use our [React SDK](dev-guide-react-sdk) instead. ::: ## Integration To enable the Jitsi Meet API in your application you must use one of the following JavaScript (JS) Jitsi Meet API library scripts and integrate it into your application: For self-hosting in your domain: ```javascript ``` meet.jit.si: ```javascript ``` ## Mobile support The iframe API works on mobile browsers the same way as it does on desktop browsers. ### Opening meetings in the Jitsi Meet app In order to open meetings with the Jitsi Meet app you can use our custom URL scheme as follows: (let's assume the meeting is https://meet.jit.si/test123) * Android: `intent://meet.jit.si/test123#Intent;scheme=org.jitsi.meet;package=org.jitsi.meet;end` * iOS: `org.jitsi.meet://meet.jit.si/test123` This works with custom servers too, just replace `meet.jit.si` with your custom server URL. ## Creating the Jitsi Meet API object After you have integrated the Meet API library, you must then create the Jitsi Meet API object. The Meet API object takes the following form: **`api = new JitsiMeetExternalAPI(domain, options)`** The API object constructor uses the following options: * `domain`: The domain used to build the conference URL (e.g., **`meet.jit.si`**). * `options`: The object with properties. IFrame arguments include: * `roomName`: The name of the room to join. * `width`: _Optional._ The created IFrame width. The width argument has the following characteristics: - A numerical value indicates the width in pixel units. - If a string is specified the format is a number followed by **`px`**, **`em`**, **`pt`**, or **`%`**. * `height`: _Optional._ The height for the created IFrame. The height argument has the following characteristics: - A numerical value indicates the height in pixel units. - If a string is specified the format is a number followed by **`px`**, **`em`**, **`pt`**, or **`%`**. * `parentNode`: The HTML DOM Element where the IFrame is added as a child. * `configOverwrite`: _Optional._ The JS object with overrides for options defined in the [config.js] file. * `interfaceConfigOverwrite`: _Optional._ The JS object with overrides for options defined in the [interface_config.js] file. * `jwt`: _Optional._ The [JWT](https://jwt.io/) token. * `onload`: _Optional._ The IFrame onload event handler. * `invitees`: _Optional._ Object arrays that contain information about participants invited to a call. * `devices`: _Optional._ Information map about the devices used in a call. * `userInfo`: _Optional._ The JS object that contains information about the participant starting or joining the meeting (e.g., email). * `lang`: _Optional._ The default meeting language. * `iceServers`: _Optional._ Object with rules that will be used to modify/remove the existing ice server configuration. **NOTE: This property is currently experimental and may be removed in the future!** For example: ```javascript const domain = 'meet.jit.si'; const options = { roomName: 'JitsiMeetAPIExample', width: 700, height: 700, parentNode: document.querySelector('#meet'), lang: 'de' }; const api = new JitsiMeetExternalAPI(domain, options); ``` You can set the initial media devices for the call using the following: ```javascript const domain = 'meet.jit.si'; const options = { ... devices: { audioInput: '', audioOutput: '', videoInput: '' }, ... }; const api = new JitsiMeetExternalAPI(domain, options); ``` You can override options set in the [config.js] file and the [interface_config.js] file using the **`configOverwrite`** and **`interfaceConfigOverwrite`** objects, respectively. For example: ```javascript const options = { ... configOverwrite: { startWithAudioMuted: true }, interfaceConfigOverwrite: { DISABLE_DOMINANT_SPEAKER_INDICATOR: true }, ... }; const api = new JitsiMeetExternalAPI(domain, options); ``` To pass a JWT token to Jitsi Meet use the following: ```javascript const options = { ... jwt: '', ... }; const api = new JitsiMeetExternalAPI(domain, options); ``` You can set the **`userInfo`** (e.g., email, display name) for the call using the following: ```javascript var domain = "meet.jit.si"; var options = { ... userInfo: { email: 'email@jitsiexamplemail.com', displayName: 'John Doe' } } var api = new JitsiMeetExternalAPI(domain, options); ``` export const Anchor = ({children, name}) => ( {children} ); You can modify the default ice servers configuration with the **`iceServers`** property (**NOTE: This property is currently experimental and may be removed in the future!**) using the following: ```javascript var domain = "meet.jit.si"; var options = { ... iceServers: { replace: [ { // replace the URL of all existing ice servers with type matching targetType targetType: 'turn', urls: 'turn:example.com:443' }, { // replace the URL of all existing ice servers with type matching targetType targetType: 'turns', urls: 'turns:example.com:443?transport=tcp' }, { // remove all existing ice servers with type matching targetType targetType: 'stun', urls: null } ] }, ... } var api = new JitsiMeetExternalAPI(domain, options); ``` Configuring the tile view: You can configure the maximum number of columns in the tile view by overriding the **`TILE_VIEW_MAX_COLUMNS`** property from the [interface_config.js] file via the **`interfaceConfigOverwrite`** object: ```javascript const options = { ... interfaceConfigOverwrite: { TILE_VIEW_MAX_COLUMNS: 2 }, ... }; const api = new JitsiMeetExternalAPI(domain, options); ``` :::note **`TILE_VIEW_MAX_COLUMNS`** accepts values from 1 to 5. The default value is 5. ::: ## Functions All functions are documented [here](/handbook/docs/dev-guide/dev-guide-iframe-functions) now. ## Commands All commands are documented [here](/handbook/docs/dev-guide/dev-guide-iframe-commands) now. ## Events All events are documented [here](/handbook/docs/dev-guide/dev-guide-iframe-events) now. [config.js]: https://github.com/jitsi/jitsi-meet/blob/master/config.js [interface_config.js]: https://github.com/jitsi/jitsi-meet/blob/master/interface_config.js ================================================ FILE: docs/dev-guide/ios-sdk.md ================================================ --- id: dev-guide-ios-sdk title: iOS SDK --- The Jitsi Meet iOS SDK provides the same user experience as the Jitsi Meet app, in a customizable way which you can embed in your apps. :::important iOS 15.1 or higher is required. ::: ## Sample applications using the SDK If you want to see how easy integrating the Jitsi Meet SDK into a native application is, take a look at the [sample applications repository](https://github.com/jitsi/jitsi-meet-sdk-samples#ios). ## Usage There are 2 ways to integrate the SDK into your project: - Using CocoaPods - Building it yourself ### Using CocoaPods The recommended way for using the SDK is by using CocoaPods. In order to do so, add the `JitsiMeetSDK` dependency to your existing `Podfile` or create a new one following this example: ```ruby platform :ios, '15.1' workspace 'JitsiMeetSDKTest.xcworkspace' target 'JitsiMeetSDKTest' do project 'JitsiMeetSDKTest.xcodeproj' pod 'JitsiMeetSDK' end ``` Replace `JitsiMeetSDKTest` with your project and target names. Since the SDK requests camera and microphone access, make sure to include the required entries for `NSCameraUsageDescription` and `NSMicrophoneUsageDescription` in your `Info.plist` file. In order for app to properly work in the background, select the "audio" and "voip" background modes. Last, since the SDK shows and hides the status bar based on the conference state, you may want to set `UIViewControllerBasedStatusBarAppearance` to `NO` in your `Info.plist` file. ### Building it yourself 1. Install all required [dependencies](https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-mobile-jitsi-meet). 2. Build it: ```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 ``` After successfully building Jitsi Meet SDK for iOS, the resulting XCFramework(s) will be in the ios/sdk/out directory. If you are embedding the Framework directly into your project you'll also need to add the generated `hermes.xcframework`. NOTE: Your app will need to depend on the JitsiWebRTC CocoaPod. ## API JitsiMeet is an iOS framework which embodies the whole Jitsi Meet experience and makes it reusable by third-party apps. To get started: 1. Add a `JitsiMeetView` to your app using a Storyboard or Interface Builder, for example. 2. Then, once the view has loaded, set the delegate in your controller and load the desired URL: ```objc - (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]; } ``` ### JitsiMeetView class The `JitsiMeetView` class is the entry point to the SDK. It a subclass of `UIView` which renders a full conference in the designated area. #### delegate Property to get/set the `JitsiMeetViewDelegate` on `JitsiMeetView`. #### join:JitsiMeetConferenceOptions Joins the conference specified by the given options. ```objc JitsiMeetConferenceOptions *options = [JitsiMeetConferenceOptions fromBuilder:^(JitsiMeetConferenceOptionsBuilder *builder) { builder.serverURL = [NSURL URLWithString:@"https://meet.jit.si"]; builder.room = @"test123testing"; builder.audioOnly = NO; builder.audioMuted = NO; builder.videoMuted = NO; builder.welcomePageEnabled = NO; [builder setConfigOverride:@"requireDisplayName" withBoolean:YES]; [builder setConfigOverride:@"customToolbarButtons" withArray:@[ @{ @"icon": @"ICON_URL", @"id": @"CUSTOM_BTN_ID" }, @{ @"icon": @"ICON_URL", @"id": @"CUSTOM_BTN_ID" }, @{ @"icon": @"ICON_URL", @"id": @"CUSTOM_BTN_ID" }, @{ @"icon": @"ICON_URL", @"id": @"CUSTOM_BTN_ID" }, @{ @"backgroundColor": @"CUSTOM_BTN_BACKGROUND_COLOR", @"icon": @"ICON_URL", @"id": @"CUSTOM_BTN_ID" } ]]; [builder setConfigOverride:@"toolbarButtons" withArray:@[@"CUSTOM_BTN_ID", @"CUSTOM_BTN_ID", @"CUSTOM_BTN_ID", @"CUSTOM_BTN_ID", @"CUSTOM_BTN_ID", @"overflowmenu", @"hangup"]]; }]; [jitsiMeetView join:options]; ``` #### leave Leaves the currently active conference. #### hangUp The localParticipant leaves the current conference. #### setAudioMuted Sets the state of the localParticipant audio muted according to the `muted` parameter. #### setVideoMuted Sets the state of the localParticipant video muted according to the `muted` parameter. #### sendEndpointTextMessage Sends a message via the data channel to one particular participant or to all of them. If the `to` param is empty, the message will be sent to all the participants in the conference. In order to get the participantId, the `PARTICIPANT_JOINED` event should be listened for, which `data` includes the id and this should be stored somehow. #### toggleScreenShare Sets the state of the localParticipant screen sharing according to the `enabled` parameter. #### openChat Opens the chat dialog. If `to` contains a valid participantId, the private chat with that particular participant will be opened. #### sendChatMessage Sends a chat message via to one particular participant or to all of them. If the `to` param is empty, the message will be sent to all the participants in the conference. In order to get the participantId, the `PARTICIPANT_JOINED` event should be listened for, which `data` includes the id and this should be stored somehow. #### closeChat Closes the chat dialog. #### retrieveParticipantsInfo Retrieves the participants information in the completionHandler sent as parameter. #### Universal / deep linking In order to support Universal / deep linking, `JitsiMeet` offers 2 class methods that you app's delegate should call in order for the app to follow those links. If these functions return NO it means the URL wasn't handled by the SDK. This is useful when the host application uses other SDKs which also use linking. ```objc - (BOOL)application:(UIApplication *)application continueUserActivity:(NSUserActivity *)userActivity restorationHandler:(void (^)(NSArray *restorableObjects))restorationHandler { return [[JitsiMeet sharedInstance] application:application continueUserActivity:userActivity restorationHandler:restorationHandler]; } ``` And also one of the following: ```objc // See https://developer.apple.com/documentation/uikit/uiapplicationdelegate/1623073-application?language=objc - (BOOL)application:(UIApplication *)app openURL:(NSURL *)url options:(NSDictionary *)options { return [[JitsiMeet sharedInstance] application:app openURL:url options: options]; } ``` ### JitsiMeetViewDelegate This delegate is optional, and can be set on the `JitsiMeetView` instance using the `delegate` property. It provides information about the conference state: was it joined, left, did it fail? All methods in this delegate are optional. #### conferenceJoined Called when a conference was joined. `data` contains the following information: - `url`: the conference URL #### conferenceTerminated Called when the active conference ends, be it because of user choice or because of a failure. `data` contains the following information: - `url`: the conference URL - `error`: missing if the conference finished gracefully, otherwise contains the error message #### conferenceWillJoin Called before a conference is joined. `data` contains the following information: - `url`: the conference URL #### enterPictureInPicture Called when entering Picture-in-Picture is requested by the user. The app should now activate its Picture-in-Picture implementation (and resize the associated `JitsiMeetView`. The latter will automatically detect its new size and adjust its user interface to a variant appropriate for the small size ordinarily associated with Picture-in-Picture.) The `data` dictionary is empty. #### participantJoined Called when a participant has joined the conference. `data` contains the following information: - `email`: the email of the participant. It may not be set if the remote participant didn't set one. - `name`: the name of the participant. - `role`: the role of the participant. - `participantId`: the id of the participant. #### participantLeft Called when a participant has left the conference. `data` contains the following information: - `participantId`: the id of the participant that left. #### audioMutedChanged Called when the local participant's audio is muted or unmuted. `data` contains the following information: - `muted`: a boolean indicating whether the audio is muted or not. #### videoMutedChanged Called when the local participant's video is muted or unmuted. `data` contains the following information: - `muted`: an integer indicating whether the video is muted or not. 0 means unmuted, 4 means muted. #### endpointTextMessageReceived Called when an endpoint text message is received. The `data` dictionary contains a `senderId` key with the participantId of the sender and a `message` key with the content. #### screenShareToggled Called when a participant starts or stops sharing his screen. The `data` dictionary contains a `participantId` key with the id of the participant and a 'sharing' key with boolean value. #### chatMessageReceived Called when a chat text message is received. `data` contains the following information: - `senderId`: the id of the participant that sent the message. - `message`: the content of the message. - `isPrivate`: true if the message is private, false otherwise. - `timestamp`: the (optional) timestamp of the message. #### chatToggled Called when the chat dialog is opened or closed. `data` contains the following information: - `isOpen`: true if the chat dialog is open, false otherwise. #### readyToClose Called when the SDK is ready to be closed. No meeting is happening at this point. #### customButtonPressed Called when custom buttons are added to the overflow menu. `data` contains the following information: - `id`: the id of the pressed custom button. - `text`: the label of the pressed custom button. #### conferenceUniqueIdSet Called when a meeting unique id was set. `data` contains the following information: - `sessionId`: the unique conference id. #### recordingStatusChanged Called when current recording status is changing. `data` contains the following information: - `error` - `id` - `initiator` - `liveStreamViewURL` - `mode` - `status` - `terminator` - `timestamp` ### Picture-in-Picture `JitsiMeetView` will automatically adjust its UI when presented in a Picture-in-Picture style scenario, in a rectangle too small to accommodate its "full" UI. Jitsi Meet SDK does not currently implement native Picture-in-Picture on iOS. If desired, apps need to implement non-native Picture-in-Picture themselves and resize `JitsiMeetView`. If `delegate` implements `enterPictureInPicture:`, the in-call toolbar will render a button to afford the user to request entering Picture-in-Picture. ## Dropbox integration To setup the Dropbox integration, follow these steps: 1. Add the following to the app's Info.plist and change `` to your Dropbox app key: ``` CFBundleURLTypes CFBundleURLName CFBundleURLSchemes db- LSApplicationQueriesSchemes dbapi-2 dbapi-8-emm ``` 2. Make sure your app calls the Jitsi Meet SDK universal / deep linking delegate methods. ## Screen Sharing integration The screen sharing functionality for iOS was added to Jitsi starting with JitsiMeetSDK version 3.3.0. It is available for applications running on iOS 14 or newer. For achieving this we are using the `Broadcast Upload Extension` for capturing the contents of the user's screen. Passing the frames to the RN WebRTC is done using Unix stream-oriented sockets communication, the extension acting as the client and the React Native WebRTC being the server. The following documentation covers the code provided in the [sample app](https://github.com/jitsi/jitsi-meet-sdk-samples/tree/master/ios/swift-screensharing/JitsiSDKScreenSharingTest). ### Creating the Broadcast Upload Extension The `Broadcast Upload Extension` is one of the App Extensions types defined in iOS and is used for capturing the contents of the user's screen. For creating the extension you need to add a new target to your application, selecting the `Broadcast Upload Extension` template. Fill in the desired name, change the language to Swift, make sure `Include UI Extension` is not selected, as we don't need custom UI for our case, then press Finish (screenshot 1). You will see that a new folder with the extension's name was added to the project's tree, containing the `SampleHandler.swift` class. Also, make sure to update the `Deployment Info`, for the newly created extension, to iOS 14 or newer. To learn more about creating App Extensions check the [official documentation](https://developer.apple.com/library/archive/documentation/General/Conceptual/ExtensibilityPG/ExtensionCreation.html). ![screenshot 1](../assets/iOS_screensharing_1.png "screenshot 1") With the extension created the next steps are to set up the socket connection, add the functionality for handling the received frames, and send them to RN WebRTC for processing. We will be using the code provided with the sample project for this. Copy `SampleUploader.swift`, `SocketConnection.swift`, `DarwinNotificationCenter.swift`, and `Atomic.swift` files to your extension's folder and make sure they're added to the target. ### Setting up the socket connection Sending the recorded frames to RN WebRTC is done via Unix SOCK_STREAM sockets. The extension needs to be set up as the client endpoint for this. We will update `SampleHandler.swift` to initiate the socket connection with RN WebRTC, using the `SocketConnection` class. But before, we have to set up the file that the sockets will use for communication. Even though an app extension bundle is nested within its containing app’s bundle, the running app extension and containing app have no direct access to each other’s containers. We will address this by enabling data sharing. To enable data sharing, use Xcode or the Developer portal to enable app groups for the containing app and its contained app extensions. Next, register the app group in the portal and specify the app group to use in the containing app. To learn about working with app groups, see [Adding an App to an App Group](https://developer.apple.com/library/archive/documentation/Miscellaneous/Reference/EntitlementKeyReference/Chapters/EnablingAppSandbox.html#//apple_ref/doc/uid/TP40011195-CH4-SW19). Now, add a `private var socketFilePath: String` to your `SampleHandler` class and set it up with a shared file named `rtc_SSFD`, using the newly registered app group, like this: ```swift private enum Constants { static let appGroupIdentifier = "my.custom.app.group" } private var socketFilePath: String { let sharedContainer = FileManager.default.containerURL(forSecurityApplicationGroupIdentifier: Constants.appGroupIdentifier) return sharedContainer?.appendingPathComponent("rtc_SSFD").path ?? "" } ``` Next, we will configure the `SocketConnection` to use the shared file. Add a `private var clientConnection: SocketConnection?` to the `SampleHandler` class and override `init` to set it up, like this: ```swift override init() { super.init() if let connection = SocketConnection(filePath: socketFilePath) { clientConnection = connection } } ``` In order for this to work, the RN WebRTC end needs to know about the app group identifier we have configured the app with. We are doing this by adding a new key named `RTCAppGroupIdentifier` to the app's `Info.plist` with the app group identifier as the value. ### Opening the socket connection For starting screen sharing JitsiMeet SDK provides the UI to present the `RPSystemBroadcastPickerView` to the user. By default, the picker will display a list of all the available broadcast providers. In order to limit the picker to our particular broadcast provider, we have to set `preferredExtension` to the bundle identifier of the broadcast extension. We are doing this by adding a new key named `RTCScreenSharingExtension` to the app's Info.plist and setting the broadcast extension bundle identifier as the value. Once screen recording has started ReplayKit invokes the methods to handle video buffers, as well as the methods to handle starting and stopping the broadcast, from the `SampleHandler` class. The `broadcastStarted(withSetupInfo:)` method is our entry point for opening the socket connection with the RN WebRTC server. To do this we have to post the `broadcastStarted` notification the server is listening for, in order to start the connection, and we are ready to connect. Add a new method `openConnection()` to the `SampleHandler` class which will repeatedly attempt connecting to the server, for cases when the server connection start is delayed: ```swift func openConnection() { let queue = DispatchQueue(label: "broadcast.connectTimer") let timer = DispatchSource.makeTimerSource(queue: queue) timer.schedule(deadline: .now(), repeating: .milliseconds(100), leeway: .milliseconds(500)) timer.setEventHandler { [weak self] in guard self?.clientConnection?.open() == true else { return } timer.cancel() } timer.resume() } ``` Next, update the `broadcastStarted(withSetupInfo:)` method to post the notification and connect: ```swift override func broadcastStarted(withSetupInfo setupInfo: [String: NSObject]?) { DarwinNotificationCenter.shared.postNotification(.broadcastStarted) openConnection() } ``` `DarwinNotificationCenter` is a simple helper class for broadcasting system-wide notifications, instead of delivering only within a single program, as `NSNotificationCenter` does. This mechanism allows the app to register for notifications sent from the extension. Now we are ready to start sending video frames. ### Sending video frames RN WebRTC is designed to work with jpeg encoded images framed in a `CFHTTPMessage` object. The following header fields are required: - `Content-Length` - the size of the jpeg data - `Buffer-Width` - the width of the buffer, in pixels - `Buffer-Height` - the buffer height, in pixels - `Buffer-Orientation` - the value for the `RPVideoSampleOrientationKey` that describes the video orientation. We are going to prepare and send our video frames using the `SampleUploader` class. Add a new `private var uploader: SampleUploader?` to the SampleHandler class and update `init()` to initialize it: ```swift override init() { super.init() if let connection = SocketConnection(filePath: socketFilePath) { clientConnection = connection uploader = SampleUploader(connection: connection) } } ``` Next, we are going to update the `processSampleBuffer(_ sampleBuffer: CMSampleBuffer, with sampleBufferType: RPSampleBufferType)` method to send our video frames. For performance reasons, we'll also implement a very simple mechanism for adjusting the frame rate by using every third frame. Add a new `private var frameCount = 0` and update the above-mentioned method like this: ```swift override func processSampleBuffer(_ sampleBuffer: CMSampleBuffer, with sampleBufferType: RPSampleBufferType) { switch sampleBufferType { case .video: // very simple mechanism for adjusting frame rate by using every third frame frameCount += 1 if frameCount % 3 == 0 { uploader?.send(sample: sampleBuffer) } default: break } } ``` Also, update `broadcastStarted(withSetupInfo setupInfo: [String: NSObject]?)` to reset the `frameCount` every time screen sharing is started: ```swift override func broadcastStarted(withSetupInfo setupInfo: [String: NSObject]?) { frameCount = 0 DarwinNotificationCenter.shared.postNotification(.broadcastStarted) openConnection() } ``` With this, we've concluded sending the video frames and we can move to the last step, handling stop screen sharing. ### Handling stop screen sharing Besides the in-meeting UI (screenshot 2), ReplayKit integration with iOS provides support for stopping screen recording outside of the app's control, from the status bar (screenshot 3) or using the Control Center (screenshot 4). ![ios-screensharing](../assets/iOS_screensharing_2.png "screenshot 2") ![ios-screensharing](../assets/iOS_screensharing_3.png "screenshot 3") ![ios-screensharing](../assets/iOS_screensharing_4.png "screenshot 4") Any of these actions will trigger `broadcastFinished` in our `SampleHandler` implementation. This is our entry point for closing the connection and cleaning up. We will update `broadcastFinished` to post a `DarwinNotification.broadcastStopped` system-wide notification and close the connection: ```swift override func broadcastFinished() { DarwinNotificationCenter.shared.postNotification(.broadcastStopped) clientConnection?.close() } ``` Another scenario we need to take care of is when the server connection is dropped, like when leaving a meeting while screen sharing or an error is encountered. We will address this by handling `clientConnection.didClose` event. Add a new method `setupConnection` to the `SampleHandler` class and update `init` to call it: ```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) } } ``` Now, that we are done writing the implementation, we just need to enable the functionality in Jitsi. We are doing this by configuring `JitsiMeetConferenceOptionsBuilder` with the `ios.screensharing.enabled feature` flag, like this: ```swift let options = JitsiMeetConferenceOptions.fromBuilder { [weak self] builder in ... builder.setFeatureFlag("ios.screensharing.enabled", withBoolean: true) } meetView.join(options) ``` Finally, we are ready to test the implementation. Before doing so, make sure voip is added to `UIBackgroundModes`, in the app's `Info.playlist`, in order to work when the app is in the background. ### TL;DR - Add a `Broadcast Upload Extension`, without UI, to your app. Update deployment info to run in iOS 14 or newer. - Copy `SampleUploader.swift`, `SocketConnection.swift`, `DarwinNotificationCenter.swift` and `Atomic.swift` files from the sample project to your extension. Make sure they are added to the extension's target. - Add both the app and the extension to the same App Group. Next, add the app group id value to the app's `Info.plist` for the `RTCAppGroupIdentifier` key. - Add a new key `RTCScreenSharingExtension` to the app's `Info.plist` with the extension's `Bundle Identifier` as the value. - Update `SampleHandler.swift` with the code from the sample project. Update `appGroupIdentifier` constant with the App Group name your app and extension are both registered to. - Update `JitsiMeetConferenceOptions` to enable screen sharing using the `ios.screensharing.enabled` feature flag. - Make sure `voip` is added to `UIBackgroundModes`, in the app's `Info.plist`, in order to work when the app is in the background. ## Debugging - If you choose `Console` app for debugging, please be sure that you select: `Action`(tab) -> `Include Info Messages` `Action`(tab) -> `Include Debug Messages` - In the Search filter please type `JitsiMeetSDK`, press Return key and replace `ANY` with `Category`. This will show you all the real time logs related to our SDK. ================================================ FILE: docs/dev-guide/ljm-api.md ================================================ --- id: dev-guide-ljm-api title: lib-jitsi-meet API (low level) --- You can use Jitsi Meet API to create Jitsi Meet video conferences with a custom GUI. ## Installation To embed Jitsi Meet API in your application you need to source the Jitsi Meet API library. **It should be sourced from your deployment.** ```html ``` Now you can access Jitsi Meet API through the `JitsiMeetJS` global object. ## Getting Started 1. The first thing you must do in order to use Jitsi Meet API is to initialize `JitsiMeetJS` object: ```javascript JitsiMeetJS.init(); ``` 2. Then you must create the connection object: ```javascript var connection = new JitsiMeetJS.JitsiConnection(null, null, options); ``` 3. Now we can attach some listeners to the connection object 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(); ``` 4. After you receive the `CONNECTION_ESTABLISHED` event you are to create the `JitsiConference` object and also you may want to attach listeners for conference events (we are going to add handlers for remote track, conference joined, etc. ): ```javascript room = connection.initJitsiConference("conference1", confOptions); room.on(JitsiMeetJS.events.conference.TRACK_ADDED, onRemoteTrack); room.on(JitsiMeetJS.events.conference.CONFERENCE_JOINED, onConferenceJoined); ``` 5. You also may want to get your local tracks from the camera and microphone: ```javascript JitsiMeetJS.createLocalTracks().then(onLocalTracks); ``` NOTE: Adding listeners and creating local streams are not mandatory steps. 6. Then you are ready to create / join a conference : ```javascript room.join(); ``` After that step you are in the conference. Now you can continue with adding some code that will handle the events and manage the conference. ## API Reference ### setReceiverConstraints Configures the video quality for remote participant streams. ```javascript conference.setReceiverConstraints(videoConstraints); ``` **Parameters:** `videoConstraints` - Object containing the following properties: | Property | Type | Description | |----------|------|-------------| | `lastN` | number | Maximum number of video streams to receive | | `selectedSources` | array | Source names to receive (e.g., `['abc123-v0', 'def456-v0']`) | | `onStageSources` | array | Source names for participants on stage | | `defaultConstraints` | object | Default quality for all sources `{ maxHeight: 360 }` | | `constraints` | object | Per-source quality `{ 'abc123-v0': { maxHeight: 720 } }` | **Example:** ```javascript // Basic usage - receive up to 20 videos at 360p conference.setReceiverConstraints({ lastN: 20, defaultConstraints: { maxHeight: 360 } }); ``` Common `maxHeight` values: `180` (low), `360` (medium), `720` (HD), `1080` (Full HD). :::warning DEPRECATED `setReceiverVideoConstraint(resolution)` is deprecated. Use `setReceiverConstraints()` instead. ::: ### setEffect Applies effects to local tracks (e.g., background blur, virtual backgrounds). ```javascript track.setEffect(effect); ``` **Parameters:** `effect` - Object with the following methods, or `undefined` to remove effect: | Method | Description | |--------|-------------| | `isEnabled(track)` | Returns true if effect can be applied to this track | | `startEffect(stream)` | Processes stream and returns modified MediaStream | | `stopEffect()` | Cleans up effect resources | **Example:** ```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); ``` ## Components See [the full API docs](https://jitsi.github.io/lib-jitsi-meet/). ## Usage :::note NOTE JaaS customers, please follow [this example](https://github.com/jitsi/ljm-jaas-example) or check out the [live demo](https://jitsi.github.io/ljm-jaas-example). ::: ================================================ FILE: docs/dev-guide/ljm.md ================================================ --- id: dev-guide-ljm title: Modifying lib-jitsi-meet --- # Modifying `lib-jitsi-meet` By default the library is referenced as a prebuilt artifact in a GitHub release. Packages are NOT published to npm. The default dependency path in package.json is: ```json "lib-jitsi-meet": "https://github.com/jitsi/lib-jitsi-meet/releases/download/v+/lib-jitsi-meet.tgz)", ``` To work with local copy you may change the path to: ```json "lib-jitsi-meet": "file:///Users/name/local-lib-jitsi-meet-packed-copy.tgz", ``` In order to create the packed file run `npm pack` in the lib-jitsi-meet project directory. To make the project you must force it to take the sources as 'npm update': ``` npm install lib-jitsi-meet --force && make ``` Or if you are making only changes to the library: ``` npm install lib-jitsi-meet --force && make deploy-lib-jitsi-meet ``` Alternative way is to use [npm link](https://docs.npmjs.com/cli/link). It allows to link `lib-jitsi-meet` dependency to local source in few steps: ```bash cd lib-jitsi-meet #### create global symlink for lib-jitsi-meet package npm link cd ../jitsi-meet #### create symlink from the local node_modules folder to the global lib-jitsi-meet symlink npm link lib-jitsi-meet ``` :::note Linking will not work when building the mobile applications. ::: After changes in your local `lib-jitsi-meet` repository, you can rebuild it with `npm run build` and your `jitsi-meet` repository will use that modified library: ```bash cd node_modules/lib-jitsi-meet npm run build ``` If you do not want to use local repository anymore you should run: ```bash cd jitsi-meet npm unlink lib-jitsi-meet npm install ``` ================================================ FILE: docs/dev-guide/mobile-dropbox.md ================================================ --- id: mobile-dropbox title: Setting up Dropbox integration --- 1. Create a Dropbox app. 2. Add the following to ```ios/app/src/Info.plist``` by replacing `` with your own Dropbox app key (which can be found in the [App Console](https://www.dropbox.com/developers/apps)): ``` CFBundleURLTypes CFBundleURLName CFBundleURLSchemes db- LSApplicationQueriesSchemes dbapi-2 dbapi-8-emm ``` **NOTE:** Both Android and iOS builds of the apps will parse the Dropbox app key from ```ios/app/src/Info.plist```. **NOTE:** See [Dropbox developer guide](https://www.dropbox.com/developers/reference/developer-guide) for more information ================================================ FILE: docs/dev-guide/mobile-feature-flags.md ================================================ --- id: mobile-feature-flags title: Feature flags --- The mobile SDK supports a number of feature flags which allow for customizing certain UI aspects and behavior. All flags are defined [here](https://github.com/jitsi/jitsi-meet/blob/master/react/features/base/flags/constants.ts). ================================================ FILE: docs/dev-guide/mobile-google-auth.md ================================================ --- id: mobile-google-auth title: Setting up Google sign-in integration --- - Create a Firebase project here: https://firebase.google.com/. You'll need a signed Android build for that, that can be a debug self-signed build too, just retrieve the signing hash. The key hash of an already signed ap can be obtained as follows (on macOS): ```keytool -list -printcert -jarfile the-app.apk``` - Place the generated ```google-services.json``` file in ```android/app``` for Android and the ```GoogleService-Info.plist``` into ```ios/app``` for iOS (you can stop at that step, no need for the driver and the code changes they suggest in the wizard). - You may want to exclude these files in YOUR GIT config (do not exclude them in the ```.gitignore``` of the application itself!). - Your web client ID is auto generated during the Firebase project creation. Find them in the Google Developer console (https://console.developers.google.com/) - Make sure your config reflects this ID by setting ```googleApiApplicationClientID``` in config.js. - Add your iOS client ID (the REVERSED_CLIENT_ID in the plist file) as an application URL schema into ```ios/app/src/Info.plist``` (replacing placeholder). - Enable YouTube API access on the developer console (see above) to enable live streaming. ================================================ FILE: docs/dev-guide/mobile-jitsi-meet.md ================================================ --- id: dev-guide-mobile-jitsi-meet title: Developer Guide for Jitsi Meet sidebar_label: Jitsi Meet development --- This guide will help you setup a development environment to start working on the Jitsi Meet mobile app itself. :::caution Building the apps / SDKs is not supported on Windows. ::: ## Overview :::note This guide is about building the Jitsi Meet apps themselves. If you want to integrate the Jitsi Meet SDK into your own application check the dedicated page on the sidebar. ::: Jitsi Meet can be built as a standalone app for Android or iOS. It uses the [React Native] framework. First make sure the following dependencies are installed: * `watchman` * `nodejs` * `npm` :::warning Node version Node 20.x and npm 10.x are required. Any other version may result in runtime errors. ::: :::note Xcode Xcode 15 or higher is required. ::: ## iOS 1. Install dependencies - Install main dependencies: ```bash npm install ``` - Install the required pods (CocoaPods must be installed first, it can be done with Homebrew: `brew install cocoapods`) ```bash cd ios pod install cd .. ``` 2. Build the app using Xcode - Open `ios/jitsi-meet.xcworkspace` in Xcode. Make sure it's the workspace file! - Select your device from the top bar and hit the **Play ▶️** button. When the app is launched from Xcode, the Debug Console will show the application output logs. 3. Other remarks It's likely you'll need to change the bundle ID for deploying to a device. This can be changed in the **General** tab. Under **Identity** set **Bundle Identifier** to a different value, and adjust the **Team** in the **Signing** section to match your own. ## Android ### Building and running with Android Studio 1. Install [Android Studio]. 2. Set the JDK to at least Java 11: **Android Studio → Settings → Build, Execution, Deployment → Build Tools → Gradle → Gradle JDK**. See also: https://developer.android.com/studio/intro/studio-config#jdk 3. Install JavaScript dependencies from the **repository root**: ```bash npm install ``` 4. Open the project in Android Studio: - Choose **Open** and select the `android/` folder inside the repository. - Wait for the Gradle sync to complete. Android Studio will download all required SDK components automatically on the first run. :::tip If Gradle sync fails, go to **File → Invalidate Caches / Restart** and try again. Make sure your JDK is set correctly (step 2). ::: 5. Select your target device from the device drop-down in the top toolbar (a connected physical device or a configured AVD emulator). 6. Click the **Run ▶️** button (or press `Shift + F10`). Android Studio will build the APK and deploy it to the selected device. 7. Start the Metro bundler from the **repository root**: ```bash npm start ``` The app will automatically connect to Metro once it launches on the device. :::note If the app cannot find the Metro bundler (e.g., on a physical device), run: ```bash adb reverse tcp:8081 tcp:8081 ``` ::: ### Building and running without Android Studio :::note This section describes a fully command-line based workflow that works on **Linux**, **macOS**, and **WSL** (Windows Subsystem for Linux). You do not need Android Studio installed. ::: #### 1. Download the Android SDK command-line tools Download the **Command-line tools only** package (not Android Studio) from the [official Android developer site](https://developer.android.com/studio#command-tools). After extracting the archive, the expected directory structure should look like this: ``` ~/Android/Sdk/ └── cmdline-tools/ └── latest/ ← rename the extracted folder to "latest" if it isn't already ├── bin/ ├── lib/ ├── NOTICE.txt └── source.properties ``` :::tip If the extracted folder has a name like `cmdline-tools-`, rename it to `latest` so that `sdkmanager` and other tools resolve paths correctly: ```bash mv ~/Android/Sdk/cmdline-tools/cmdline-tools- ~/Android/Sdk/cmdline-tools/latest ``` ::: #### 2. Configure environment variables Add the following lines to your `~/.bashrc` or `~/.zshrc`, then reload the shell: ```bash export ANDROID_HOME="$HOME/Android/Sdk" export PATH="$ANDROID_HOME/cmdline-tools/latest/bin:$ANDROID_HOME/platform-tools:$PATH" ``` ```bash source ~/.bashrc # or source ~/.zshrc ``` #### 3. Install required SDK packages and accept licenses Use `sdkmanager` to install the necessary SDK components: ```bash sdkmanager "platform-tools" "platforms;android-34" "build-tools;34.0.0" sdkmanager --licenses ``` Accept all prompts by pressing `y` when asked. #### 4. Install JavaScript dependencies From the **repository root**, run: ```bash npm install ``` #### 5. Build and install on a physical device 1. Enable **USB debugging** on your Android device (**Settings → Developer options → USB debugging**). 2. Connect the device via USB and verify it is detected: ```bash adb devices ``` You should see your device listed with the status `device`. If it shows `unauthorized`, unlock your phone and accept the RSA key fingerprint prompt. 3. Navigate to the `android/` directory and run: ```bash cd android ./gradlew installDebug ``` This will build the debug APK, install it on the connected device, and automatically start the Metro bundler. You do not need to run `npm start` separately. :::note The first build may take several minutes as Gradle downloads its own dependencies. Subsequent builds are faster due to caching. ::: ### Adding extra dependencies Due to how our project is structured, React Native's automatic linking won't work so Android dependencies need to be manually linked. First, add your project to `android/settings.gradle` like so: ```gradle title="android/settings.gradle" include ':react-native-mydependency' project(':react-native-mydependency').projectDir = new File(rootProject.projectDir, '../node_modules/@somenamespace/react-native-mydependency/android') ``` Then add a dependency on `android/sdk/build.gradle` like so: ```gradle title="android/sdk/build.gradle" implementation project(':react-native-mydependency') ``` Last, link it in the `getReactNativePackages` method in `android/sdk/src/main/java/org/jitsi/meet/sdk/ReactInstanceManagerHolder.java` like so: ```java title="android/sdk/src/main/java/org/jitsi/meet/sdk/ReactInstanceManagerHolder.java" new com.companyname.library.AwesomeLibraryPackage(), ``` Make sure you adjust the fully qualified package name. ## Debugging The official documentation on [debugging] is quite extensive and specifies the preferred method for debugging. :::note When using Chrome Developer Tools for debugging the JavaScript source code is being interpreted by Chrome's V8 engine, instead of JSCore which React Native uses. It's important to keep this in mind due to potential differences in supported JavaScript features. Also note Jitsi Meet does not support Flipper. ::: ## Enabling extra features - [Dropbox Integration](mobile-dropbox.md) - [Google Sign-In Integration (For YouTube Live Streaming)](mobile-google-auth.md) [Android Studio]: https://developer.android.com/studio/index.html [debugging]: https://facebook.github.io/react-native/docs/debugging/ [React Native]: https://facebook.github.io/react-native/ ================================================ FILE: docs/dev-guide/react-native-sdk.md ================================================ --- id: dev-guide-react-native-sdk title: React Native SDK --- The Jitsi React Native SDK provides the same user experience as the Jitsi Meet app, in a customizable way which you can embed in your React Native apps. ## Sample application using the React Native SDK If you want to see how easy integrating the Jitsi React Native SDK into a React Native application is, take a look at the
[sample applications repository](https://github.com/jitsi/jitsi-meet-sdk-samples#react-native). ## Usage While this is a published library, you can `npm i @jitsi/react-native-sdk`.
Dependency conflicts may occur between RNSDK and your app.
If that is the case, please run `npm i @jitsi/react-native-sdk --force`.
To check if some dependencies need to be added, please run the following script `node node_modules/@jitsi/react-native-sdk/update_dependencies.js`.
This will sync all of our peer dependencies with your dependencies.
Next you will need to do `npm install`. Because our SDK uses SVG files, you will need to update your metro bundler configuration accordingly: ```config title="metro.config" const { getDefaultConfig } = require('metro-config'); module.exports = (async () => { const { resolver: { sourceExts, assetExts } } = await getDefaultConfig(); return { transformer: { babelTransformerPath: require.resolve('react-native-svg-transformer'), getTransformOptions: async () => ({ transform: { experimentalImportSupport: false, inlineRequires: true, }, }), }, resolver: { assetExts: assetExts.filter(ext => ext !== 'svg'), sourceExts: [...sourceExts, 'svg'] } } })(); ``` ### Android #### Permissions - In `android/app/src/debug/AndroidManifest.xml` and `android/app/src/main/AndroidManifest.xml`, above the `` tag, please include ```xml ``` - Starting Android 14, specific foreground service types permissions require to be added in the manifest file: ```xml ``` #### Services - To enables the screen share feature you now need to go to your `MainApplication.java` file and: 1. `import com.oney.WebRTCModule.WebRTCModuleOptions;` that comes from `react-native-webrtc` dependency. 2. `WebRTCModuleOptions options = WebRTCModuleOptions.getInstance();` instance it. 3. `options.enableMediaProjectionService = true;` enable foreground service that takes care of screen-sharing feature. #### API - Our app use `react-native-orientation-locker` dependency that uses API 33 features. Make sure that your app, in `android\build.gradle`, targets, at least, that version: ```markdown buildscript { ext { compileSdkVersion = 33 targetSdkVersion = 33 } } ``` ### iOS #### Permissions - React Native SDK requests camera and microphone access, make sure to include the required entries for `NSCameraUsageDescription` and `NSMicrophoneUsageDescription`in your `Info.plist` file. - React Native SDK shows and hides the status bar based on the conference state, you may want to set `UIViewControllerBasedStatusBarAppearance` to `NO` in your `Info.plist` file. - For starting screen sharing React Native SDK provides the UI to present the `RPSystemBroadcastPickerView` to the user. By default, the picker will display a list of all the available broadcast providers. In order to limit the picker to our particular broadcast provider, we have to set `preferredExtension` to the bundle identifier of the broadcast extension. We are doing this by adding a new key named `RTCScreenSharingExtension` to the app's Info.plist and setting the broadcast extension bundle identifier as the value. - Make sure `voip` is added to `UIBackgroundModes`, in the app's `Info.plist`, in order to work when the app is in the background. #### Build Phases ##### Run Script Phases - For the sounds to work, please add the following script in Xcode: ```shell SOUNDS_DIR="${PROJECT_DIR}/../node_modules/@jitsi/react-native-sdk/sounds" cp $SOUNDS_DIR/* ${CONFIGURATION_BUILD_DIR}/${UNLOCALIZED_RESOURCES_FOLDER_PATH}/ ``` ## JitsiMeeting props Our JitsiMeeting component renders the full meeting experience. This has some customizable properties: ### config `Object` - Overwrite different [config](https://github.com/jitsi/jitsi-meet/blob/master/config.js) options. - For example: ```javascript ``` ### flags `Object` - Add different feature [flags](https://github.com/jitsi/jitsi-meet/blob/master/react/features/base/flags/constants.ts) that your meeting experience would like to have. - For example: ```javascript ``` ### eventListeners `Object` - Options that personalize your meeting experience: - onConferenceBlurred `Function` - Takes a function that gets triggered when ```CONFERENCE_BLURRED``` action is dispatched, more exactly when a conference screen is out of focus, more exactly when navigation to another screen is initiated. - onConferenceFocused `Function` - Takes a function that gets triggered when ```CONFERENCE_FOCUSED``` action is dispatched, more exactly when a conference screen is focused. - onAudioMutedChanged `Function` - Takes a function that gets triggered when ```SET_AUDIO_MUTED``` action is dispatched, more exactly when audio mute state is changed. - onConferenceJoined `Function` - Takes a function that gets triggered when ```CONFERENCE_JOINED``` action is dispatched, more exactly when a conference was joined. - onConferenceLeft `Function` - Takes a function that gets triggered when ```CONFERENCE_LEFT``` action is dispatched, more exactly when a conference was left. - onConferenceWillJoin `Function` - Takes a function that gets triggered when ```CONFERENCE_WILL_JOIN``` action is dispatched, more exactly when a conference will be joined. - onEnterPictureInPicture `Function` - Takes a function that gets triggered when ```ENTER_PICTURE_IN_PICTURE``` action is dispatched, more exactly when entering picture-in-picture is initiated. - onParticipantJoined `Function` - Takes a function that gets triggered when ```PARTICIPANT_JOINED``` action is dispatched, more exactly when a specific participant joined a conference. - onReadyToClose `Function` - Takes a function that gets triggered when ```READY_TO_CLOSE``` action is dispatched, more exactly when one exits a conference. - onVideoMutedChanged `Function` - Takes a function that gets triggered when ```SET_VIDEO_MUTED``` action is dispatched, more exactly when video mute state is changed. ### room `string` - Name of the room where the conference takes place. ### serverURL `string` - Server where the conference should take place. ### style `Object` - CSS your meeting experience. ### token `string` - JWT token used for authentication. ### userInfo - avatarUrl `string` - Path to participant's avatar. - displayName `string` - Default participant name to be displayed. - email `string` - Default email for participant. ================================================ FILE: docs/dev-guide/react-sdk.md ================================================ --- id: dev-guide-react-sdk title: React SDK --- The Jitsi Meet React SDK provides the same user experience as the Jitsi Meet app, in a customizable way which you can embed in your apps. :::important React 16 or higher is required. ::: ## Sample application using the SDK If you want to see how easy integrating the Jitsi Meet React SDK into a React application is, take a look at our [example](https://github.com/jitsi/jitsi-meet-react-sdk/tree/main/example). ## Installation To access the React SDK modules in your application you need to install it as a dependency: ```bash npm install @jitsi/react-sdk ``` ## Modules The SDK exposes two components with similar properties, intended for different use-cases. ### JitsiMeeting To be used with custom domains as-it-is in React projects: ```jsx { // here you can attach custom event listeners to the Jitsi Meet External API // you can also store it locally to execute commands } } getIFrameRef = { (iframeRef) => { iframeRef.style.height = '400px'; } } /> ``` #### Properties specific to the `JitsiMeeting` component * `domain`: Optional. Field used to retrieve the external_api.js file that initializes the IFrame. If omitted, defaults to `meet.jit.si`. ### JaaSMeeting To be used with the `8x8.vc` domain as-it-is in React projects: ```jsx { ... } } /> ``` ...or with the `stage.8x8.vc` domain: ```js ``` #### Properties specific to the `JaaSMeeting` component * `appId`: Required. Provides an isolated context and prefixes the room name. * `useStaging`: Optional. Tells whether to use the staging environment or not. ## Common properties The component modules support a similar kind of customization to the Jitsi Meet IFrame. The following properties can be passed down to your instances of `JitsiMeeting` or `JaaSMeeting`. * `roomName`: Required. The name of the room to join. * `configOverwrite`: Optional. The JS object with overrides for options defined in the [config.js] file. * `interfaceConfigOverwrite`: Optional. The JS object with overrides for options defined in the [interface_config.js] file. * `jwt`: Optional. The [JWT](https://jwt.io/) token. * `invitees`: Optional. Object arrays that contain information about participants invited to a call. * `devices`: Optional. Information map about the devices used in a call. * `userInfo`: Optional. The JS object that contains information about the participant starting or joining the meeting (e.g., email). * `release`: Optional. Information regarding the `stage.8x8.vc` or `8x8.vc` release version. Expects the following format: `release-1234`. * `spinner`: Optional. The custom spinner to be displayed while the IFrame is loading. * `onApiReady`: Optional. The external API reference for events and commands. * `onReadyToClose`: Optional. The callback for when the meeting is ready to be closed. * `getIFrameRef`: Optional. The parent node used by the IFrame. [config.js]: https://github.com/jitsi/jitsi-meet/blob/master/config.js [interface_config.js]: https://github.com/jitsi/jitsi-meet/blob/master/interface_config.js ================================================ FILE: docs/dev-guide/web-integrations.md ================================================ --- id: dev-guide-web-integrations title: Web integrations sidebar_label: Integrations --- ## Creating the Google API client for Google Calendar and YouTube integration 1. Log into a Google admin account. 1. Go to Google cloud platform dashboard. https://console.cloud.google.com/apis/dashboard 1. In the Select a Project dropdown, click New Project. 1. Give the project a name. 1. Proceed to the Credentials settings of the new project. 1. In the Credentials tab of the Credentials settings, click Create Credentials and select the type OAuth client ID. 1. Proceed with creating a Web application and add the domains (origins) on which the application will be hosted. Local development environments (http://localhost:8000 for example) can be added here. 1. While still in the Google cloud platform dashboard, click the Library settings for the calendar project. 1. Search for the Google Calendar API (used for calendar accessing), click its result, and enable it. 1. Do the same for YouTube Data API v3 ## Creating the Microsoft app for Microsoft Outlook integration 1. Go to https://apps.dev.microsoft.com/ 1. Proceed through the "Add an app" flow. Once created, a page with several Graph Permissions fields should display. 1. Under "Platforms" add "Web" 1. Add a redirect URL for the Microsoft auth flow to visit once a user has confirmed authentication. Target domain if available is just 'yourdomain.com' (the deployment address) and the redirect URL is `https://yourdomain.com/static/msredirect.html`. 1. Add Microsoft Graph delegated permissions, if this option is available: Calendars.Read, Calendars.ReadWrite, Calendars.Read.Shared, Calendars.ReadWrite.Shared. 1. Check `Allow Implicit Flow` (and `Restrict token issuing to this app` if available). 1. Save the changes. ## Creating the Dropbox app for Dropbox recording integration 1. You need a Dropbox account (If you don't already have one, you can sign up for a free account [here](https://www.dropbox.com/register).) 2. Create new App as described in [Getting Started Guide](https://www.dropbox.com/developers/reference/getting-started?_tk=guides_lp&_ad=guides2&_camp=get_started#app%20console) in App Console section. 3. Choose 1. 'Dropbox API - For apps that need to access files in Dropbox.' 1. 'App folder– Access to a single folder created specifically for your app.' 1. Fill in the name of your app 4. You need only, the newly created App key, goes in `/etc/jitsi/meet/yourdeployment.com-config.js` in ``` title="/etc/jitsi/meet/yourdeployment.com-config.js" dropbox: { appKey: '__dropbox_app_key__', redirectURI: 'https://yourdeployment.com/static/oauth.html' } ``` 5. Add your Dropbox Redirect URIs in the Dropbox form `https://yourdeployment.com/static/oauth.html` 6. Fill in Branding ================================================ FILE: docs/dev-guide/web-jitsi-meet.md ================================================ --- id: dev-guide-web-jitsi-meet title: Developer Guide for Jitsi Meet sidebar_label: Jitsi Meet development --- This guide will help you setup a development environment to start working on the Jitsi Meet web app itself. ## Building the sources :::note Node.js >= 22 and npm >= 10 are required. ::: :::caution Windows is not supported natively. If you are on Windows, see [Running Jitsi Meet on Windows](dev-guide-windows) for workarounds using Linux-based environments. ::: Make sure you have Node.js installed. If you don't, follow [these instructions](https://nodejs.org/en/download/). Then go ahead: ```bash # Clone the repository 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 ``` :::warning **DO NOT** run `npm update` or use `yarn` or delete `package-lock.json`. Dependencies are pinned for a reason. ::: ### Running with webpack-dev-server for development Use the following command in your terminal: ```bash make dev ``` By default the backend deployment used is `alpha.jitsi.net`. You can point the Jitsi Meet app at a different backend by using a proxy server. To do this, set the WEBPACK_DEV_SERVER_PROXY_TARGET variable: ```bash export WEBPACK_DEV_SERVER_PROXY_TARGET=https://your-example-server.com make dev ``` The app should be running at https://localhost:8080/ #### Certificate Error Browsers may show a certificate error since the development certificate is self-signed. It's safe to disregard those warning and continue to your site. ### Building .debs To make a deb you can easily deploy to a public test server, ensure you have the lib-jitsi-meet sources you wish, then: ``` npm install make dpkg-buildpackage -A -rfakeroot -us -uc -tc ``` You'll have a bunch of .deb files in the parent directory, and can push the updated source to your server and install it with the jitsi-meet-web deb file. ### Running from source on existing deployment Follow the document https://community.jitsi.org/t/how-to-how-to-build-jitsi-meet-from-source-a-developers-guide/75422 ================================================ FILE: docs/dev-guide/windows.md ================================================ --- id: dev-guide-windows title: Running Jitsi Meet on Windows sidebar_label: Windows --- :::caution Windows is **not** natively supported for Jitsi Meet development or deployment. The methods described below rely on running a Linux environment on your Windows machine. ::: This guide describes ways to build and run [Jitsi Meet](dev-guide-web-jitsi-meet) on a Windows machine. All approaches work by providing a Linux environment where the standard Linux-based instructions apply. ## Prerequisites - Windows 10 (version 2004 or later) or Windows 11 - Hardware virtualization enabled in BIOS/UEFI - At least 8 GB of RAM (16 GB recommended) - A stable internet connection for cloning repositories and installing dependencies ## Method 1: WSL2 (Recommended) [Windows Subsystem for Linux 2 (WSL2)](https://learn.microsoft.com/en-us/windows/wsl/) runs a real Linux kernel on Windows and provides the closest experience to native Linux development. It has near-native performance, low resource overhead, and integrates well with Windows-based editors such as VS Code. ### Install WSL2 Open **PowerShell as Administrator** and run: ```bash wsl --install ``` This installs WSL2 with Ubuntu as the default distribution. Restart your computer when prompted. After restarting, open **Ubuntu** from the Start menu. On first launch you will be asked to create a Linux username and password. Complete the setup, then update the system packages: ```bash sudo apt update && sudo apt upgrade -y ``` ### Install nvm [nvm](https://github.com/nvm-sh/nvm) (Node Version Manager) lets you install and switch between multiple versions of Node.js. The Jitsi Meet repository includes an `.nvmrc` file that specifies the exact Node.js version the project requires. When you run `nvm install` or `nvm use` inside the project directory, nvm reads this file and automatically installs or switches to the correct version. This means you do not need to look up which version to install and the setup stays correct even when the project updates its Node.js requirement. Install nvm by running: ```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 ``` ### Install build tools Some dependencies require native compilation: ```bash sudo apt install -y build-essential git ``` ### Clone and build Jitsi Meet :::tip Always clone the repository inside the **Linux filesystem** (your home directory `~/`) rather than under `/mnt/c/`. The `/mnt/c/` path mounts your Windows `C:\` drive and cross-filesystem operations are significantly slower, which causes long build times and unreliable file watching. ::: ```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 ``` The development server will start at `https://localhost:8080/`. Open this URL in your Windows browser (Chrome, Edge, etc.). WSL2 automatically forwards `localhost` to Windows. You can also use `http://localhost:8080/` which avoids the certificate warning below. :::note If you access the development server over `https://`, your browser will show a certificate error because the server uses a self-signed certificate. It is safe to accept the warning and proceed. Alternatively, use `http://localhost:8080/` to avoid the warning entirely. ::: For the full list of build commands and configuration options, see the [Jitsi Meet web development guide](dev-guide-web-jitsi-meet). ## Method 2: Docker Desktop If your goal is to **self-host** a Jitsi Meet instance rather than develop the web application, Docker Desktop is a convenient option. It runs Linux containers on Windows using the WSL2 backend. ### Install Docker Desktop 1. Download [Docker Desktop for Windows](https://docs.docker.com/desktop/install/windows-install/) and run the installer. 2. During installation, ensure **"Use WSL 2 instead of Hyper-V"** is selected. 3. After installation, launch Docker Desktop and wait for the engine to start. Open **PowerShell** or **Command Prompt** and verify: ```bash docker --version docker compose version ``` Both commands should print version information without errors. ### Download the Jitsi Docker setup Open **PowerShell** and download the latest release: ```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\* ``` ### Configure and start the containers ```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 ``` Access the Jitsi Meet instance at [https://localhost:8443](https://localhost:8443). :::note The Docker-based setup is designed for **deployment and testing**, not for active development of the Jitsi Meet web application source code. For development, use WSL2 (Method 1) or a Linux VM (Method 3). ::: For the full Docker deployment guide including TLS, authentication, and recording configuration, see the [Self-Hosting Guide: Docker](../devops-guide/devops-guide-docker). ## Method 3: Linux Virtual Machine Running a full Linux virtual machine provides complete isolation and the broadest compatibility. This approach works exactly like developing on a native Linux machine. ### Install a hypervisor Download and install one of the following: - [VirtualBox](https://www.virtualbox.org/) (free, open source) - [VMware Workstation Player](https://www.vmware.com/products/workstation-player.html) (free for personal use) ### Create a virtual machine 1. Download an [Ubuntu LTS](https://ubuntu.com/download/desktop) ISO (22.04 or newer recommended). 2. Create a new virtual machine with the following recommended settings: | Setting | Recommended Value | |---------|-------------------| | RAM | 4 GB minimum, 8 GB preferred | | CPU Cores | 2 minimum, 4 preferred | | Disk Space | 30 GB minimum | | Network | NAT or Bridged Adapter | 3. Mount the Ubuntu ISO and complete the installation. ### Install dependencies and build After Ubuntu is installed and running, open a terminal and follow the same steps described in [Method 1: WSL2](#method-1-wsl2-recommended) starting from [Install nvm](#install-nvm). The setup is identical since the VM runs a full Linux environment. Once dependencies are installed, follow the [Jitsi Meet web development guide](dev-guide-web-jitsi-meet) to clone and build the project. The development server will be available at `https://localhost:8080/` inside the VM's browser. :::tip If you want to access the development server from your Windows browser, configure the VM's network as **Bridged Adapter** and use the VM's IP address instead of `localhost`. You can find the IP by running `ip addr show` inside the VM. ::: For the full list of build commands and configuration options, see the [Jitsi Meet web development guide](dev-guide-web-jitsi-meet). ## Tips and Caveats **Filesystem performance (WSL2).** The location of your project files matters significantly. Working inside the Linux filesystem (`~/jitsi-meet`) gives native Linux I/O speed, while working under the mounted Windows filesystem (`/mnt/c/Users/.../jitsi-meet`) adds cross-OS translation overhead and is much slower. Always use the Linux filesystem for builds and file watching. **Networking.** In WSL2, `localhost` on Windows automatically maps to WSL2, so the development server at `https://localhost:8080/` is accessible from your Windows browser. Docker Desktop containers bind to `localhost` by default and the web UI is at `https://localhost:8443`. For a virtual machine, use a Bridged Adapter network mode if you need to access the VM from Windows. **Resource usage.** Both WSL2 and VMs consume system memory. By default WSL2 may use up to 50% of your system RAM. You can limit this by creating a `.wslconfig` file at `C:\Users\\.wslconfig`: ```ini [wsl2] memory=4GB processors=2 ``` After saving, restart WSL2 with `wsl --shutdown` in PowerShell. **Official support.** These workarounds are not officially supported. If you encounter issues, verify that the same problem occurs on a native Linux environment before reporting it upstream. The [Jitsi Community Forum](https://community.jitsi.org/) is a good place to ask for community help with Windows-specific issues. ================================================ FILE: docs/devops-guide/authentication.md ================================================ --- id: authentication title: Authentication sidebar_label: Authentication --- It is possible to allow only authenticated users to create new conference rooms. Whenever a new room is about to be created, Jitsi Meet will prompt for a user name and password. After the room is created, others will be able to join from anonymous domain. Here's what has to be configured: ## Keycloak install and configure Install docker and prepare keycloak user. ``` 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 <`. ## OpenBSD OpenBSD provides ports for [Jitsi](https://cvsweb.openbsd.org/cgi-bin/cvsweb/ports/meta/jitsi/), along with a pkg-readme which details how to configure Jitsi for a single host install, located at [/usr/local/share/docs/pkg-readme/jitsi](https://cvsweb.openbsd.org/cgi-bin/cvsweb/ports/meta/jitsi/pkg/). The meta port can be installed by the command `pkg_add jitsi`, which pulls in the individual ports, Jitsi Videobridge, Jicofo and Jitsi Meet Web UI, along with prosody, Jitsi prosody plugins and other required dependencies. ## Limitations - Jigasi and Jibri have not yet been ported to work with any BSD systems. ================================================ FILE: docs/devops-guide/cloud-api.md ================================================ --- id: cloud-api title: Cloud API --- The Jitsi Meet Cloud API is a specification for services which can support the integration of Jitsi Meet into other applications, for mapping conferences for dial-in support, and for supporting directory search and user invitations to conferences. The swagger for these services is provided in [cloud-api.swagger](https://github.com/jitsi/jitsi-meet/blob/master/resources/cloud-api.swagger). ## Sample conference mapper application https://github.com/luki-ev/conferencemapper ================================================ FILE: docs/devops-guide/devops-guide.md ================================================ --- id: devops-guide-start title: Self-Hosting Guide - Overview sidebar_label: Overview --- :::note These guides help you to ___host your own Jitsi-Meet server___. If you want to have a video conference without setting up any infrastructure, use https://meet.jit.si instead. ::: ## First, a bit of general advice Jitsi Meet being based on [WebRTC](https://en.wikipedia.org/wiki/WebRTC), an encrypted communication link (https) is ___necessary___ to get working multimedia, and the setup is not always trivial. The best option is an Internet server with a certificate for a domain registered in the [DNS](https://en.wikipedia.org/wiki/Domain_Name_System#Domain_name_registration). While it's possible to setup a server on a private network and/or a self-signed certificate, it can be less straightforward and you can expect difficulties, first if you want access both from the private network and the public internet, and second when using phones as these clients often don't accept self-signed certificates. In case of trouble with clients using phones, [check your certificate](https://whatsmychaincert.com).
import DocCardList from '@theme/DocCardList'; ================================================ FILE: docs/devops-guide/docker.md ================================================ --- id: devops-guide-docker title: Self-Hosting Guide - Docker sidebar_label: Docker --- ## Quick start In order to quickly run Jitsi Meet on a machine running Docker and Docker Compose, follow these steps: 1. Download and extract the [latest release]. **DO NOT** clone the git repository. See below if you are interested in running test images: ```bash wget $(wget -q -O - https://api.github.com/repos/jitsi/docker-jitsi-meet/releases/latest | grep zip | cut -d\" -f4) ``` 1. Unzip the package, and enter the new folder: ```bash unzip cd ``` 1. Create a `.env` file by copying and adjusting `env.example`: ```bash cp env.example .env ``` 1. Set strong passwords in the security section options of `.env` file by running the following bash script ```bash ./gen-passwords.sh ``` 1. Create required `CONFIG` directories * For linux: ```bash mkdir -p ~/.jitsi-meet-cfg/{web,transcripts,prosody/config,prosody/prosody-plugins-custom,jicofo,jvb,jigasi,jibri} ``` * For Windows: ```bash echo web,transcripts,prosody/config,prosody/prosody-plugins-custom,jicofo,jvb,jigasi,jibri ``` ```bash mkdir "~/.jitsi-meet-cfg/$_" ``` 1. Run ``docker compose up -d`` 1. Access the web UI at [``https://localhost:8443``](https://localhost:8443) (or a different port, in case you edited the `.env` file). :::note HTTP (not HTTPS) is also available (on port 8000, by default), but that's e.g. for a reverse proxy setup; direct access via HTTP instead HTTPS leads to WebRTC errors such as _Failed to access your microphone/camera: Cannot use microphone/camera for an unknown reason. Cannot read property 'getUserMedia' of undefined_ or _navigator.mediaDevices is undefined_. ::: **IMPORTANT**: When deploying Jitsi Meet for real use you must set the `PUBLIC_URL` env variable to the real domain where your setup is running. If you want to use jigasi too, first configure your env file with SIP credentials and then run Docker Compose as follows: ```bash docker compose -f docker-compose.yml -f jigasi.yml up ``` If you want to enable document sharing via [Etherpad], configure it and run Docker Compose as follows: ```bash docker compose -f docker-compose.yml -f etherpad.yml up ``` If you want to enable a virtual collaborative whiteboard via [Excalidraw], configure it and run Docker Compose as follows: ```bash docker compose -f docker-compose.yml -f whiteboard.yml up ``` If you want to use jibri too, first configure a host as described in Jitsi Broadcasting Infrastructure configuration section and then run Docker Compose as follows: ```bash docker compose -f docker-compose.yml -f jibri.yml up -d ``` or to use jigasi too: ```bash docker compose -f docker-compose.yml -f jigasi.yml -f jibri.yml up -d ``` To include a transcriber component, run Docker Compose as follows: ```bash docker compose -f docker-compose.yml -f transcriber.yml up -d ``` Or for them all together: ```bash docker compose -f docker-compose.yml -f transcriber.yml -f jigasi.yml -f jibri.yml up -d ``` For the log analysis project, you will need both log-analyser.yml and grafana.yml files. This project allows you to analyze docker logs in grafana. If you want to run the log analyzer, run the Docker files as follows: ```bash docker-compose -f docker-compose.yml -f log-analyser.yml -f grafana.yml up -d ``` Follow [this](https://jitsi.github.io/handbook/docs/devops-guide/devops-guide-log-analyser) document for detailed information on log analysis. ### Updating If you want to update, simply run ```bash wget $(wget -q -O - https://api.github.com/repos/jitsi/docker-jitsi-meet/releases/latest | grep zip | cut -d\" -f4) ``` again (just like how you initially downloaded Jitsi). Then unzip and overwrite all when being asked: ```bash unzip ``` ### Testing development / unstable builds Download the latest code: ```bash git clone https://github.com/jitsi/docker-jitsi-meet && cd docker-jitsi-meet ``` :::note The code in `master` is designed to work with the unstable images. Do not run it with release images. ::: Run `docker compose up` as usual. Every day a new "unstable" image build is uploaded. ### Building your own images Download the latest code: ```bash git clone https://github.com/jitsi/docker-jitsi-meet && cd docker-jitsi-meet ``` The provided `Makefile` provides a comprehensive way of building the whole stack or individual images. To build all images: ```bash make ``` To build a specific image (the web image for example): ```bash make build_web ``` Once your local build is ready make sure to add `JITSI_IMAGE_VERSION=latest` to your `.env` file. ### Security note This setup used to have default passwords for internal accounts used across components. In order to make the default setup secure by default these have been removed and the respective containers won't start without having a password set. Strong passwords may be generated as follows: `./gen-passwords.sh` This will modify your `.env` file (a backup is saved in `.env.bak`) and set strong passwords for each of the required options. Passwords are generated using `openssl rand -hex 16` . DO NOT reuse any of the passwords. ## Architecture A Jitsi Meet installation can be broken down into the following components: * A web interface * An XMPP server * A conference focus component * A video router (could be more than one) * A SIP gateway for audio calls * A Broadcasting Infrastructure for recording or streaming a conference. ![](../assets/docker-jitsi-meet.png) The diagram shows a typical deployment in a host running Docker. This project separates each of the components above into interlinked containers. To this end, several container images are provided. ### External Ports The following external ports must be opened on a firewall: * `80/tcp` for Web UI HTTP (really just to redirect, after uncommenting `ENABLE_HTTP_REDIRECT=1` in `.env`) * `443/tcp` for Web UI HTTPS * `10000/udp` for RTP media over UDP Also `20000-20050/udp` for jigasi, in case you choose to deploy that to facilitate SIP access. E.g. on a CentOS/Fedora server this would be done like this (without SIP access): ```bash sudo firewall-cmd --permanent --add-port=80/tcp sudo firewall-cmd --permanent --add-port=443/tcp sudo firewall-cmd --permanent --add-port=10000/udp sudo firewall-cmd --reload ``` See [the corresponding section in the debian/ubuntu setup guide](https://jitsi.github.io/handbook/docs/devops-guide/devops-guide-quickstart#setup-and-configure-your-firewall). ### Images * **base**: Debian stable base image with the [S6 Overlay] for process control and the [Jitsi repositories] enabled. All other images are based on this one. * **base-java**: Same as the above, plus Java (OpenJDK). * **web**: Jitsi Meet web UI, served with nginx. * **prosody**: [Prosody], the XMPP server. * **jicofo**: [Jicofo], the XMPP focus component. * **jvb**: [Jitsi Videobridge], the video router. * **jigasi**: [Jigasi], the SIP (audio only) gateway. * **jibri**: [Jibri], the broadcasting infrastructure. ### Design considerations Jitsi Meet uses XMPP for signaling, thus the need for the XMPP server. The setup provided by these containers does not expose the XMPP server to the outside world. Instead, it's kept completely sealed, and routing of XMPP traffic only happens on a user-defined network. The XMPP server can be exposed to the outside world, but that's out of the scope of this project. ## Configuration The configuration is performed via environment variables contained in a ``.env`` file. You can copy the provided ``env.example`` file as a reference. Variable | Description | Example --- | --- | --- `CONFIG` | Directory where all configuration will be stored | /opt/jitsi-meet-cfg `TZ` | System Time Zone | Europe/Amsterdam `HTTP_PORT` | Exposed port for HTTP traffic | 8000 `HTTPS_PORT` | Exposed port for HTTPS traffic | 8443 `JVB_ADVERTISE_IPS` | IP addresses of the Docker host (comma separated), needed for LAN environments | 192.168.1.1 `PUBLIC_URL` | Public URL for the web service | https://meet.example.com :::note The mobile apps won't work with self-signed certificates (the default). See below for instructions on how to obtain a proper certificate with Let's Encrypt. ::: ### TLS Configuration #### Let's Encrypt configuration If you want to expose your Jitsi Meet instance to the outside traffic directly, but don't own a proper TLS certificate, you are in luck because Let's Encrypt support is built right in. Here are the required options: Variable | Description | Example --- | --- | --- `ENABLE_LETSENCRYPT` | Enable Let's Encrypt certificate generation | 1 `LETSENCRYPT_DOMAIN` | Domain for which to generate the certificate | meet.example.com `LETSENCRYPT_EMAIL` | E-Mail for receiving important account notifications (mandatory) | alice@atlanta.net In addition, you will need to set `HTTP_PORT` to 80 and `HTTPS_PORT` to 443 and PUBLIC_URL to your domain. You might also consider to redirect HTTP traffic to HTTPS by setting `ENABLE_HTTP_REDIRECT=1`. **Let's Encrypt rate limit warning**: Let's Encrypt has a limit to how many times you can submit a request for a new certificate for your domain name. At the time of writing, the current limit is five new (duplicate) certificates for the same domain name every seven days. Because of this, it is recommended that you disable the Let's Encrypt environment variables from `.env` if you plan on deleting the `.jitsi-meet-cfg` folder. Otherwise, you might want to consider moving the `.jitsi-meet-cfg` folder to a different location so you have a safe place to find the certificate that already Let's Encrypt issued. Or do initial testing with Let's Encrypt disabled, then re-enable Let's Encrypt once you are done testing. :::note When you move away from `LETSENCRYPT_USE_STAGING`, you will have to manually clear the certificates from `.jitsi-meet-cfg/web`. ::: For more information on Let's Encrypt's rate limits, visit: https://letsencrypt.org/docs/rate-limits/ #### Using existing TLS certificate and key If you own a proper TLS certificate and don't need a Let's Encrypt certificate, you can configure Jitsi Meet container to use it. Unlike Let's Encrypt certificates, this is not configured through the `.env`file, but by telling Jitsi Meet's `web` service to mount the following two volumes: * mount `/path/to/your/cert.key` file to `/config/keys/cert.key` mount point * mount `/path/to/your/cert.fullchain` file to the `/config/keys/cert.crt` mount point. Doing it in `docker-compose.yml` file should look like this: ```yaml services: web: ... volumes: ... - /path/to/your/cert.fullchain:/config/keys/cert.crt - /path/to/your/cert.key:/config/keys/cert.key ``` ### Features configuration (config.js) Variable | Description | Example --- | --- | --- `TOOLBAR_BUTTONS` | Configure toolbar buttons. Add the buttons name separated with comma(no spaces between comma) | | `HIDE_PREMEETING_BUTTONS` | Hide the buttons at pre-join screen. Add the buttons name separated with comma | | `ENABLE_LOBBY` | Control whether the lobby feature should be enabled or not | 1 `ENABLE_AV_MODERATION` | Control whether the A/V moderation should be enabled or not | 1 `ENABLE_PREJOIN_PAGE` | Show a prejoin page before entering a conference | 1 `ENABLE_WELCOME_PAGE` | Enable the welcome page | 1 `ENABLE_CLOSE_PAGE` | Enable the close page | 0 `DISABLE_AUDIO_LEVELS` | Disable measuring of audio levels | 0 `ENABLE_NOISY_MIC_DETECTION` | Enable noisy mic detection | 1 `ENABLE_BREAKOUT_ROOMS` | Enable breakout rooms | 1 ### Jigasi SIP gateway (audio only) configuration If you want to enable the SIP gateway, these options are required: Variable | Description | Example --- | --- | --- `JIGASI_SIP_URI` | SIP URI for incoming / outgoing calls | test@sip2sip.info `JIGASI_SIP_PASSWORD` | Password for the specified SIP account | `` `JIGASI_SIP_SERVER` | SIP server (use the SIP account domain if in doubt) | sip2sip.info `JIGASI_SIP_PORT` | SIP server port | 5060 `JIGASI_SIP_TRANSPORT` | SIP transport | UDP #### Display Dial-In information Variable | Description | Example --- | --- | --- `DIALIN_NUMBERS_URL` | URL to the JSON with all Dial-In numbers | https://meet.example.com/dialin.json `CONFCODE_URL` | URL to the API for checking/generating Dial-In codes | https://jitsi-api.jitsi.net/conferenceMapper The JSON with the Dial-In numbers should look like this: ```json {"message":"Dial-In numbers:","numbers":{"DE": ["+49-721-0000-0000"]},"numbersEnabled":true} ``` ### Recording / live streaming configuration with Jibri
If you are using a release older than 7439 some extra setup is necessary. Before running Jibri **on releases older than 7439**, you need to set up an ALSA loopback device on the host. This **will not** work on a non-Linux host. For CentOS 7, the module is already compiled with the kernel, so just run: ```bash # 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-load.d/snd_aloop.conf # load the module modprobe snd-aloop # check that the module is loaded lsmod | grep snd_aloop ``` For Ubuntu: ```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 ``` :::note If you are running on AWS you may need to reboot your machine to use the generic kernel instead of the "aws" kernel. If after reboot, your machine is still using the "aws" kernel, you'll need to manually update the grub file. So just run: ::: ```bash # open the grub file in editor nano /etc/default/grub # Modify the value of GRUB_DEFAULT from "0" to "1>2" # Save and exit from file # Update grub update-grub # Reboot the machine reboot now ``` For using multiple Jibri instances, you have to select different loopback interfaces for each instance manually. Default the first instance has: ``` ... slave.pcm "hw:Loopback,0,0" ... slave.pcm "hw:Loopback,0,1" ... slave.pcm "hw:Loopback,1,1" ... slave.pcm "hw:Loopback,1,0" ... ``` To setup the second instance, run container with changed `/home/jibri/.asoundrc`: ``` ... slave.pcm "hw:Loopback_1,0,0" ... slave.pcm "hw:Loopback_1,0,1" ... slave.pcm "hw:Loopback_1,1,1" ... slave.pcm "hw:Loopback_1,1,0" ... ``` Also you can use numbering id for set loopback interface. The third instance will have `.asoundrc` that looks like: ``` ... slave.pcm "hw:2,0,0" ... slave.pcm "hw:2,0,1" ... slave.pcm "hw:2,1,1" ... slave.pcm "hw:2,1,0" ... ```
If you want to enable Jibri these options are required: Variable | Description | Example --- | --- | --- `ENABLE_RECORDING` | Enable recording / live streaming | 1 Extended Jibri configuration: Variable | Description | Example --- | --- | --- `JIBRI_RECORDER_USER` | Internal recorder user for Jibri client connections | recorder `JIBRI_RECORDER_PASSWORD` | Internal recorder password for Jibri client connections | `` `JIBRI_RECORDING_DIR` | Directory for recordings inside Jibri container | /config/recordings `JIBRI_FINALIZE_RECORDING_SCRIPT_PATH` | The finalizing script. Will run after recording is complete | /config/finalize.sh `JIBRI_XMPP_USER` | Internal user for Jibri client connections. | jibri `JIBRI_STRIP_DOMAIN_JID` | Prefix domain for strip inside Jibri (please see env.example for details) | muc `JIBRI_BREWERY_MUC` | MUC name for the Jibri pool | jibribrewery `JIBRI_PENDING_TIMEOUT` | MUC connection timeout | 90 ### Jitsi Meet configuration Jitsi-Meet uses two configuration files for changing default settings within the web interface: ``config.js`` and ``interface_config.js``. The files are located within the ``CONFIG/web/`` directory configured within your environment file. These files are re-created on every container restart. If you'd like to provide your own settings, create your own config files: ``custom-config.js`` and ``custom-interface_config.js``. It's enough to provide your relevant settings only, the docker scripts will append your custom files to the default ones! ### Authentication Authentication can be controlled with the environment variables below. If guest access is enabled, unauthenticated users will need to wait until a user authenticates before they can join a room. If guest access is not enabled, every user will need to authenticate before they can join. If authentication is enabled, once an authenticated user logged in, it is always logged in before the session timeout. You can set `ENABLE_AUTO_LOGIN=0` to disable this default auto login feature or you can set `JICOFO_AUTH_LIFETIME` to limit the session lifetime. Variable | Description | Example --- | --- | --- `ENABLE_AUTH` | Enable authentication | 1 `ENABLE_GUESTS` | Enable guest access | 1 `AUTH_TYPE` | Select authentication type (internal, jwt or ldap) | internal `ENABLE_AUTO_LOGIN` | Enable auto login | 1 `JICOFO_AUTH_LIFETIME` | Select session timeout value for an authenticated user | 3 hours #### Internal authentication The default authentication mode (`internal`) uses XMPP credentials to authenticate users. To enable it you have to enable authentication with `ENABLE_AUTH` and set `AUTH_TYPE` to `internal`, then configure the settings you can see below. Internal users must be created with the ``prosodyctl`` utility in the ``prosody`` container. In order to do that, first, execute a shell in the corresponding container: ```bash docker compose exec prosody /bin/bash ``` Once in the container, run the following command to create a user: ```bash prosodyctl --config /config/prosody.cfg.lua register TheDesiredUsername meet.jitsi TheDesiredPassword ``` Note that the command produces no output. To delete a user, run the following command in the container: ```bash prosodyctl --config /config/prosody.cfg.lua unregister TheDesiredUsername meet.jitsi ``` To list all users, run the following command in the container: ```bash find /config/data/meet%2ejitsi/accounts -type f -exec basename {} .dat \; ``` #### Authentication using LDAP You can use LDAP to authenticate users. To enable it you have to enable authentication with `ENABLE_AUTH` and set `AUTH_TYPE` to `ldap`, then configure the settings you can see below. Variable | Description | Example --- | --- | --- `LDAP_URL` | URL for ldap connection | ldaps://ldap.domain.com/ `LDAP_BASE` | LDAP base DN. Can be empty. | DC=example,DC=domain,DC=com `LDAP_BINDDN` | LDAP user DN. Do not specify this parameter for the anonymous bind. | CN=binduser,OU=users,DC=example,DC=domain,DC=com `LDAP_BINDPW` | LDAP user password. Do not specify this parameter for the anonymous bind. | LdapUserPassw0rd `LDAP_FILTER` | LDAP filter. | (sAMAccountName=%u) `LDAP_AUTH_METHOD` | LDAP authentication method. | bind `LDAP_VERSION` | LDAP protocol version | 3 `LDAP_USE_TLS` | Enable LDAP TLS | 1 `LDAP_TLS_CIPHERS` | Set TLS ciphers list to allow | SECURE256:SECURE128 `LDAP_TLS_CHECK_PEER` | Require and verify LDAP server certificate | 1 `LDAP_TLS_CACERT_FILE` | Path to CA cert file. Used when server certificate verification is enabled | /etc/ssl/certs/ca-certificates.crt `LDAP_TLS_CACERT_DIR` | Path to CA certs directory. Used when server certificate verification is enabled. | /etc/ssl/certs `LDAP_START_TLS` | Enable START_TLS, requires LDAPv3, URL must be ldap:// not ldaps:// | 0 #### Authentication using JWT tokens You can use JWT tokens to authenticate users. To enable it you have to enable authentication with `ENABLE_AUTH` and set `AUTH_TYPE` to `jwt`, then configure the settings you can see below. Variable | Description | Example --- | --- | --- `JWT_APP_ID` | Application identifier | my_jitsi_app_id `JWT_APP_SECRET` | Application secret known only to your token | my_jitsi_app_secret `JWT_ACCEPTED_ISSUERS` | (Optional) Set asap_accepted_issuers as a comma separated list | my_web_client,my_app_client `JWT_ACCEPTED_AUDIENCES` | (Optional) Set asap_accepted_audiences as a comma separated list | my_server1,my_server2 `JWT_ASAP_KEYSERVER` | (Optional) Set asap_keyserver to a url where public keys can be found | https://example.com/asap> `JWT_ALLOW_EMPTY` | (Optional) Allow anonymous users with no JWT while validating JWTs when provided | 0 `JWT_AUTH_TYPE` | (Optional) Controls which module is used for processing incoming JWTs | token `JWT_TOKEN_AUTH_MODULE` | (Optional) Controls which module is used for validating JWTs | token_verification This can be tested using the [jwt.io] debugger. Use the following sample payload: ```json { "context": { "user": { "avatar": "https://robohash.org/john-doe", "name": "John Doe", "email": "jdoe@example.com" } }, "aud": "my_jitsi_app_id", "iss": "my_jitsi_app_id", "sub": "meet.jitsi", "room": "*" } ``` #### Authentication using Matrix For more information see the documentation of the "Prosody Auth Matrix User Verification" [here](https://github.com/matrix-org/prosody-mod-auth-matrix-user-verification). Variable | Description | Example --- | --- | --- `MATRIX_UVS_URL` | Base URL to the matrix user verification service (without ending slash) | `https://uvs.example.com:3000` `MATRIX_UVS_ISSUER` | (optional) The issuer of the auth token to be passed through. Must match what is being set as `iss` in the JWT. | issuer (default) `MATRIX_UVS_AUTH_TOKEN` | (optional) user verification service auth token, if authentication enabled | changeme `MATRIX_UVS_SYNC_POWER_LEVELS` | (optional) Make Matrix room moderators owners of the Prosody room. | 1 #### Authentication using Hybrid Matrix Token You can use `Hybrid Matrix Token` to authenticate users. It supports `Matrix` and `JWT Token` authentications on the same setup. To enable it you have to enable authentication with `ENABLE_AUTH` and set `AUTH_TYPE` to `hybrid_matrix_token`, then configure the settings you can see below. For more information see the documentation of the "Hybrid Matrix Token" [here](https://github.com/jitsi-contrib/prosody-plugins/tree/main/auth_hybrid_matrix_token). Variable | Description | Example --- | --- | --- `MATRIX_UVS_URL` | Base URL to the matrix user verification service (without ending slash) | `https://uvs.example.com:3000` `MATRIX_UVS_ISSUER` | (optional) The issuer of the auth token to be passed through. Must match what is being set as `iss` in the JWT. It allows all issuers (`*`) by default. | my_issuer `MATRIX_UVS_AUTH_TOKEN` | (optional) user verification service auth token, if authentication enabled | my_matrix_secret `MATRIX_UVS_SYNC_POWER_LEVELS` | (optional) Make Matrix room moderators owners of the Prosody room. | 1 `MATRIX_LOBBY_BYPASS` | (optional) Allow Matrix room members to bypass Jitsi lobby check. | 1 `JWT_APP_ID` | Application identifier | my_jitsi_app_id `JWT_APP_SECRET` | Application secret known only to your token | my_jitsi_app_secret `JWT_ALLOW_EMPTY` | (Optional) Allow anonymous users with no JWT while validating JWTs when provided | 0 #### External authentication Variable | Description | Example --- | --- | --- `TOKEN_AUTH_URL` | Authenticate using external service or just focus external auth window if there is one already. | https://auth.meet.example.com/{room}> ### Shared document editing using Etherpad You can collaboratively edit a document via [Etherpad]. In order to enable it, set the config options below and run Docker Compose with the additional config file `etherpad.yml`. Here are the required options: Variable | Description | Example --- | --- | --- `ETHERPAD_URL_BASE` | Set etherpad-lite URL | `http://etherpad.meet.jitsi:9001` ### Virtual collaborative whiteboard using Excalidraw You can use a virtual collaborative whiteboard via [Excalidraw]. In order to enable set `WHITEBOARD_ENABLED` and run Docker Compose with the additional config file `whiteboard.yml`. Here are the required options: Variable | Description | Default value --- | --- | --- `WHITEBOARD_ENABLED` | Enable whiteboard addon | false These options are also available Variable | Description | Example --- | --- | --- `WHITEBOARD_COLLAB_SERVER_PUBLIC_URL` | Set whiteboard URL | http://whiteboard.meet.jitsi:3000 ### Transcription configuration If you want to enable the Transcribing function, set the config options below and run Docker Compose with the additional config file transcriber.yml. Variable | Description | Example --- | --- | --- `ENABLE_TRANSCRIPTIONS` | Enable Jigasi transcription in a conference | 1 In addition, the following are options are used to configure the various transcription backends and features: Variable | Description | Default --- | --- | --- `GC_PROJECT_ID` | `project_id` from Google Cloud Credentials `GC_PRIVATE_KEY_ID` | `private_key_id` from Google Cloud Credentials `GC_PRIVATE_KEY` | `private_key` from Google Cloud Credentials `GC_CLIENT_EMAIL` | `client_email` from Google Cloud Credentials `GC_CLIENT_ID` | `client_id` from Google Cloud Credentials `GC_CLIENT_CERT_URL` | `client_x509_cert_url` from Google Cloud Credentials `JIGASI_TRANSCRIBER_ADVERTISE_URL` | Jigasi will post an url to the chat with transcription file | true `JIGASI_TRANSCRIBER_CUSTOM_SERVICE` | Jigasi will use this class for custom transcriptions instead of google cloud `JIGASI_TRANSCRIBER_CUSTOM_TRANSLATION_SERVICE` | Jigasi will use this class for custom transctions instead of google cloud `JIGASI_TRANSCRIBER_ENABLE_SAVING` | Jigasi will save results to a transcription file | true `JIGASI_TRANSCRIBER_FILTER_SILENCE` | Jigasi will filter silent audio and not forward to backends `JIGASI_TRANSCRIBER_LIBRETRANSLATE_URL` | URL for libretranslate services `JIGASI_TRANSCRIBER_OCI_COMPARTMENT` | OCI compartment for use with Oracle Cloud Speech AI services `JIGASI_TRANSCRIBER_OCI_REGION` | OCI region name for use with Oracle Cloud Speech AI services `JIGASI_TRANSCRIBER_RECORD_AUDIO` | Jigasi will record audio when transcriber is on | true `JIGASI_TRANSCRIBER_REMOTE_CONFIG_URL` | URL to control transcriber custom service based on conference details `JIGASI_TRANSCRIBER_SEND_TXT` | Jigasi will send transcribed text to the chat when transcriber is on | true `JIGASI_TRANSCRIBER_USER` | Jigasi XMPP user `JIGASI_TRANSCRIBER_VOSK_URL` | URL for use with vosk backend `JIGASI_TRANSCRIBER_WHISPER_URL` | URL for use with whisper backend `JIGASI_TRANSCRIBER_WHISPER_PRIVATE_KEY_NAME` | Private Key ID of the private key to use with whisper `JIGASI_TRANSCRIBER_WHISPER_PRIVATE_KEY` | Private Key material to use with whisper, without newlines or START/END delimiters For setting the Google Cloud Credentials please read https://cloud.google.com/text-to-speech/docs/quickstart-protocol > section "Before you begin" paragraph 1 to 5. ### Sentry logging configuration Variable | Description | Default value --- | --- | --- `JVB_SENTRY_DSN` | Sentry Data Source Name (Endpoint for Sentry project) | `https://public:private@host:port/1` `JICOFO_SENTRY_DSN` | Sentry Data Source Name (Endpoint for Sentry project) | `https://public:private@host:port/1` `JIGASI_SENTRY_DSN` | Sentry Data Source Name (Endpoint for Sentry project) | `https://public:private@host:port/1` `SENTRY_ENVIRONMENT` | Optional environment info to filter events | production `SENTRY_RELEASE` | Optional release info to filter events | 1.0.0 ### TURN server configuration Configure external TURN servers. Variable | Description | Default value --- | --- | --- `TURN_CREDENTIALS` | Credentials for TURN servers | `TURN_HOST` | TURN server hostnames as a comma separated list (UDP or TCP transport) | `TURN_PORT` | TURN server port (UDP or TCP transport) | 443 `TURN_TRANSPORT` | TURN server protocols as a comma separated list (UDP or TCP or both) | tcp `TURNS_HOST` | TURN server hostnames as a comma separated list (TLS transport) | `TURNS_PORT` | TURN server port (TLS transport) | 443 `TURN_TLL`| TURN max allocation duration (sec) | 86400 ### Advanced configuration These configuration options are already set and generally don't need to be changed. Variable | Description | Default value --- | --- | --- `XMPP_DOMAIN` | Internal XMPP domain | meet.jitsi `XMPP_AUTH_DOMAIN` | Internal XMPP domain for authenticated services | auth.meet.jitsi `XMPP_SERVER` | Internal XMPP server name xmpp.meet.jitsi | xmpp.meet.jitsi `XMPP_BOSH_URL_BASE` | Internal XMPP server URL for BOSH module | `http://xmpp.meet.jitsi:5280` `XMPP_MUC_DOMAIN` | XMPP domain for the MUC | muc.meet.jitsi `XMPP_INTERNAL_MUC_DOMAIN` | XMPP domain for the internal MUC | internal-muc.meet.jitsi `XMPP_GUEST_DOMAIN` | XMPP domain for unauthenticated users | guest.meet.jitsi `XMPP_RECORDER_DOMAIN` | Domain for the jibri recorder | recorder.meet.jitsi `XMPP_MODULES` | Custom Prosody modules for XMPP_DOMAIN (comma separated) | info,alert `XMPP_MUC_MODULES` | Custom Prosody modules for MUC component (comma separated) | info,alert `XMPP_INTERNAL_MUC_MODULES` | Custom Prosody modules for internal MUC component (comma separated) | info,alert `GLOBAL_MODULES` | Custom prosody modules to load in global configuration (comma separated) | statistics,alert `GLOBAL_CONFIG` | Custom configuration string with escaped newlines | foo = bar;\nkey = val; `RESTART_POLICY` | Container restart policy | defaults to `unless-stopped` `DISABLE_HTTPS` | Handle TLS connections outside of this setup | 0 `ENABLE_HTTP_REDIRECT` | Redirect HTTP traffic to HTTPS | 0 `LOG_LEVEL` | Controls which logs are output from prosody and associated modules | info `ENABLE_HSTS` | Send a `strict-transport-security` header to force browsers to use a secure and trusted connection. Recommended for production use. | 1 `ENABLE_IPV6` | Provides means to disable IPv6 in environments that don't support it | 1 `ENABLE_COLIBRI_WEBSOCKET_UNSAFE_REGEX` | Enabled older unsafe regex for JVB colibri-ws URLs. WARNING: Enable with caution, this regex allows connections to arbitrary internal IP addresses and is not recommended for production use. Unsafe regex is defined as `[a-zA-Z0-9-\._]+` | 0 `COLIBRI_WEBSOCKET_JVB_LOOKUP_NAME` | DNS name to look up JVB IP address, used for default value of `COLIBRI_WEBSOCKET_REGEX` | jvb `COLIBRI_WEBSOCKET_REGEX` | Overrides the colibri regex used for proxying to JVB. Recommended to override in production with values matching possible JVB IP ranges | defaults to `dig $COLIBRI_WEBSOCKET_JVB_LOOKUP_NAME` unless `DISABLE_COLIBRI_WEBSOCKET_JVB_LOOKUP` is set to true `DISABLE_COLIBRI_WEBSOCKET_JVB_LOOKUP` | Controls whether to run `dig $COLIBRI_WEBSOCKET_JVB_LOOKUP_NAME` when defining COLIBRI_WEBSOCKET_REGEX | 0 #### Advanced Prosody options Variable | Description | Default value --- | --- | --- `PROSODY_RESERVATION_ENABLED` | Enable Prosody's reservation REST API | false `PROSODY_RESERVATION_REST_BASE_URL` | Base URL of Prosody's reservation REST API | `PROSODY_AUTH_TYPE` | Select authentication type for Prosody (internal, jwt or ldap) | `AUTH_TYPE` `PROSODY_ENABLE_METRICS` | Enables the http_openmetrics module which exposes Prometheus metrics at `/metrics` | false `PROSODY_METRICS_ALLOWED_CIDR` | CIDR block permitted to access metrics | 172.16.0.0/12 #### Advanced Jicofo options Variable | Description | Default value --- | --- | --- `JICOFO_COMPONENT_SECRET` | XMPP component password for Jicofo | s3cr37 `JICOFO_AUTH_USER` | XMPP user for Jicofo client connections | focus `JICOFO_AUTH_PASSWORD` | XMPP password for Jicofo client connections | `` `JICOFO_ENABLE_AUTH` | Enable authentication in Jicofo | `ENABLE_AUTH` `JICOFO_AUTH_TYPE` | Select authentication type for Jicofo (internal, jwt or ldap) | `AUTH_TYPE` `JICOFO_AUTH_LIFETIME` | Select session timeout value for an authenticated user | 24 hours `JICOFO_ENABLE_HEALTH_CHECKS` | Enable health checks inside Jicofo, allowing the use of the REST api to check Jicofo's status | false #### Advanced JVB options Variable | Description | Default value --- | --- | --- `JVB_AUTH_USER` | XMPP user for JVB MUC client connections | jvb `JVB_AUTH_PASSWORD` | XMPP password for JVB MUC client connections | `` `JVB_STUN_SERVERS` | STUN servers used to discover the server's public IP | stun.l.google.com:19302, stun1.l.google.com:19302, stun2.l.google.com:19302 `JVB_PORT` | UDP port for media used by Jitsi Videobridge | 10000 `JVB_COLIBRI_PORT` | COLIBRI REST API port of JVB exposed to localhost | 8080 `JVB_BREWERY_MUC` | MUC name for the JVB pool | jvbbrewery `COLIBRI_REST_ENABLED` | Enable the COLIBRI REST API | true `SHUTDOWN_REST_ENABLED` | Enable the shutdown REST API | true #### Advanced Jigasi options Variable | Description | Default value --- | --- | --- `JIGASI_ENABLE_SDES_SRTP` | Enable SDES srtp | 0 `JIGASI_SIP_KEEP_ALIVE_METHOD` | Keepalive method | OPTIONS `JIGASI_HEALTH_CHECK_SIP_URI` | Health-check extension | `JIGASI_HEALTH_CHECK_INTERVAL` | Health-check interval | 300000 `JIGASI_XMPP_USER` | XMPP user for Jigasi MUC client connections | jigasi `JIGASI_XMPP_PASSWORD` | XMPP password for Jigasi MUC client connections | `` `JIGASI_BREWERY_MUC` | MUC name for the Jigasi pool | jigasibrewery `JIGASI_PORT_MIN` | Minimum port for media used by Jigasi | 20000 `JIGASI_PORT_MAX` | Maximum port for media used by Jigasi | 20050 ### Running behind NAT or on a LAN environment When running running in a LAN environment, or on the public Internet via NAT, the ``JVB_ADVERTISE_IPS`` env variable should be set. This variable allows to control which IP addresses and ports the JVB will advertise for WebRTC media traffic. It is necessary to set it regardless of the use of a reverse proxy, since it's the IP address that will receive the media (audio / video) and not HTTP traffic, hence it's oblivious to the reverse proxy. :::note This variable used to be called ``DOCKER_HOST_ADDRESS`` but it got renamed for clarity and to support a list of IPs. ::: If your users are coming in over the Internet (and not over LAN), this will likely be your public IP address. If this is not set up correctly, calls will crash when more than two users join a meeting. The public IP address is attempted to be discovered via [STUN]. STUN servers can be specified with the ``JVB_STUN_SERVERS`` option. :::note Due to a bug in the docker version currently in the Debian repos (20.10.5), [Docker does not listen on IPv6 ports](https://forums.docker.com/t/docker-doesnt-open-ipv6-ports/106201/2), so for that combination you will have to [manually obtain the latest version](https://docs.docker.com/engine/install/debian/). ::: #### Split horizon If you are running in a split horizon environemt (LAN internal clients connect to a local IP and other clients connect to a public IP) you can specify multiple advertised IPs by separating them with commas: ``` JVB_ADVERTISE_IPS=192.168.1.1,1.2.3.4 ``` #### Advertising Ports If your external port differs from the internal `JVB_PORT`, you can specify the advertised port along with the advertised IP: ``` JVB_ADVERTISE_IPS=192.168.1.1#12345,fe80::1#12345 ``` :::note Since IPv6 addresses use `:` in their representation, the `#` character is used to separate the IP from the port. ::: #### Offline / airgapped installation If your setup does not have access to the Internet you'll need to disable STUN on the JVB since discovering its own IP address will fail, but that is not necessary on that type of environment. ``` JVB_DISABLE_STUN=true ``` ### Adjust UDP buffers If you are experiencing issues with UDP traffic, like synchronization issues, skipping frames and similar, or if you expect a high traffic and big conferences, you might want to adjust the UDP buffer sizes. You need to do that on the host system, that hosts the jvb container. To do so you can get this [sysctl config file](https://github.com/jitsi/jitsi-videobridge/blob/master/config/20-jvb-udp-buffers.conf) and save it in `/etc/sysctl.d` and load it via: `sysctl --system`. ## Accessing server logs The default bahavior of `docker-jitsi-meet` is to log to `stdout`. While the logs are sent to `stdout`, they are not lost: unless configured to drop all logs, Docker keeps them available for future retrieval and processing. If you need to access the container's logs you have multiple options. Here are the main ones: * run `docker compose logs -t -f ` from command line, where `` is one of `web`, `prosody`,`jvb`, `jicofo`. This command will output the logs for the selected service to stdout with timestamps. * use a standard [docker logging driver](https://docs.docker.com/config/containers/logging/configure/) to redirect the logs to the desired target (for instance `syslog` or `splunk`). * search [docker hub](https://hub.docker.com/search?q=) for a third party [docker logging driver plugin](https://docs.docker.com/config/containers/logging/plugins/) * or [write your own driver plugin](https://docs.docker.com/engine/extend/plugins_logging/) if you have a very specific need. For instance, if you want to have all logs related to a `` written to `/var/log/jitsi/` as `json` output, you could use [docker-file-log-driver](https://github.com/deep-compute/docker-file-log-driver) and configure it by adding the following block in your `docker-compose.yml` file, at the same level as the `image` block of the selected ``: ```yaml services: : image: ... ... logging: driver: file-log-driver options: fpath: "/jitsi/.log" ``` If you want to only display the `message` part of the log in `json` format, simply execute the following command (for instance if `fpath` was set to `/jitsi/jvb.log`) which uses `jq` to extract the relevant part of the logs: ``` sudo cat /var/log/jitsi/jvb.log | jq -r '.msg' | jq -r '.message' ``` ## Build Instructions Building your images allows you to edit the configuration files of each image individually, providing more customization for your deployment. The docker images can be built by running the `make` command in the main repository folder. If you need to overwrite existing images from the remote source, use `FORCE_REBUILD=1 make`. If you are on the unstable branch, build the images with `FORCE_REBUILD=1 JITSI_RELEASE=unstable make`. You are now able to run `docker compose up` as usual. ## Running behind a reverse proxy When running behing a reverse proxy from the same host, the communication between the proxy and Jitsi Meet is often in HTTP and not HTTPS since we generally don't have valid certificates for `localhost`. :::note Jitsi Meet does not currently work well when deployed in a subdirectory. ::: ### Disable HTTPS HTTPS can be disabled in the Docker Compose configuration (since HTTPS will probably not work on localhost): ```bash DISABLE_HTTPS=1 ENABLE_HTTP_REDIRECT=0 ENABLE_LETSENCRYPT=0 ``` ### Do not expose the Jitsi Meet's ports publicly By default, the `HTTP_PORT` and `HTTPS_PORT` are binding to any ip address, so are publicly open unless a firewall blocks them. When using a reverse proxy, this is not necessary. This can be changed by updating the web container's ports configuration: ```yaml - '127.0.0.1:${HTTP_PORT}:80' - '127.0.0.1:${HTTPS_PORT}:443' ``` instead of ```yaml - '${HTTP_PORT}:80' - '${HTTPS_PORT}:443' ``` ### Reverse proxy configuration By default this setup is using WebSocket connections for 2 core components: * Signalling (XMPP) * Bridge channel (colibri) Due to the hop-by-hop nature of WebSockets the reverse proxy must properly terminate and forward WebSocket connections. There 2 routes require such treatment: * `/xmpp-websocket` * `/colibri-ws` The other HTTP requests must be handled by the web container. In the following configuration examples, `http://localhost:8000/` is the url of the web service's ingress (`8000` corresponds to `HTTP_PORT`). #### nginx With nginx, these routes can be forwarded using the following config snippet: ```nginx location /xmpp-websocket { proxy_pass http://localhost:8000/xmpp-websocket; proxy_http_version 1.1; proxy_set_header Upgrade $http_upgrade; proxy_set_header Connection "upgrade"; } location /colibri-ws { proxy_pass http://localhost:8000/colibri-ws; proxy_http_version 1.1; proxy_set_header Upgrade $http_upgrade; proxy_set_header Connection "upgrade"; } location / { proxy_pass http://localhost:8000/; proxy_http_version 1.1; } ``` #### Apache With Apache, `mod_proxy`, `mod_proxy_http` and `mod_proxy_wstunnel` need to be enabled. The reverse proxy can be configured using the following config snippet: ```apache ProxyTimeout 900 ProxyPass /xmpp-websocket ws://localhost:8000/xmpp-websocket ProxyPass /colibri-ws/ ws://localhost:8000/colibri-ws/ ProxyPass / http://localhost:8000/ ProxyPassReverse / http://localhost:8000/ ``` ### Disabling WebSocket connections :::note This is not the recommended setup. ::: If using WebSockets is not an option, these environment variables can be set to fallback to HTTP polling and WebRTC datachannels: ```bash ENABLE_SCTP=1 ENABLE_COLIBRI_WEBSOCKET=0 ENABLE_XMPP_WEBSOCKET=0 ``` [S6 Overlay]: https://github.com/just-containers/s6-overlay [Jitsi repositories]: https://jitsi.org/downloads/ [Prosody]: https://prosody.im/ [Jicofo]: https://github.com/jitsi/jicofo [Jitsi Videobridge]: https://github.com/jitsi/jitsi-videobridge [Jigasi]: https://github.com/jitsi/jigasi [STUN]: https://en.wikipedia.org/wiki/STUN [jwt.io]: https://jwt.io/#debugger-io [Etherpad]: https://github.com/ether/etherpad-lite [Excalidraw]: https://github.com/excalidraw/excalidraw [Jibri]: https://github.com/jitsi/jibri [latest release]: https://github.com/jitsi/docker-jitsi-meet/releases/latest ================================================ FILE: docs/devops-guide/faq.md ================================================ --- id: faq title: FAQ --- ## How to migrate away from multiplexing and enable bridge websockets For a while, we were using nginx multiplexing to serve Jitsi Meet's content on https(port 443) and use the same port for running a turn server. This proved to be problematic(you cannot use websockets with this setup) and we moved away from it. Here is how to remove multiplexing and enable websockets in favor of WebRTC Data Channels. 1. Dropping multiplexing in nginx - delete `/etc/nginx/modules-enabled/60-jitsi-meet.conf` - Then go to `/etc/nginx/sites-available/your-conf` and change your virtual host to listen on 443 instead of 4444. 2. Edit turnserver config - make sure your turnserver is listening on standard port tls port `5349`. Make sure in `/etc/turnserver.conf` you have the following: `tls-listening-port=5349` - In `/etc/prosody/conf.avail/your-conf.cfg.lua` prosody is instructed to announce `turns` turn server on port `5349` by having this line: `{ type = "turns", host = "your-domain", port = "5349", transport = "tcp" }`. Make sure you replace `your-domain` with the DNS of your deployment. 3. Add the bridge websocket location in your nginx config (add it after the `location = /xmpp-websocket` section): ``` # colibri (JVB) websockets for jvb1 location ~ ^/colibri-ws/default-id/(.*) { proxy_pass http://127.0.0.1:9090/colibri-ws/default-id/$1$is_args$args; proxy_http_version 1.1; proxy_set_header Upgrade $http_upgrade; proxy_set_header Connection "upgrade"; tcp_nodelay on; } ``` 4. Enable the websockets in Jitsi Videobridge. Make sure in `/etc/jitsi/videobridge/jvb.conf` you have: ``` videobridge { http-servers { public { port = 9090 host = "localhost" } } websockets { enabled = true domain = "your-domain:443" tls = true } } ``` Make sure you replace `your-domain` with the DNS of your deployment. 5. After restarting the bridge (`systemctl restart jitsi-videobridge2`) and nginx (`systemctl restart nginx`) you are good to go! ================================================ FILE: docs/devops-guide/file-sharing.md ================================================ --- id: file-sharing title: File sharing --- ## Deploying and configuring a demo file sharing service for Jitsi Meet The Jitsi Meet UI can use a file sharing service which implements the following [API](https://github.com/jitsi/jitsi-meet/blob/master/resources/file-sharing.yaml). There is an example implementation of such a service in the [jitsi-meet-file-sharing](https://github.com/jitsi/jitsi-meet-file-sharing-service). That is a simple implementation using local filesystem storage. ### Setup On an existing deployment or after installing jitsi-meet following the [Self-Hosting Guide](https://jitsi.org/qi) you need to install the file sharing service and configure jitsi-meet to use it. - Download and install nvm ``` curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.4/install.sh | bash ``` - Clone the repository and deploy the service ```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 ``` - Setup sign material for short-lived tokens ```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 ``` - Enable short-lived token in your prosody config. Add its configuration to `/etc/prosody/conf.avail/your-domain.cfg.lua`: ```lua short_lived_token = { issuer = 'prosody'; accepted_audiences = { 'file-sharing' }; key_path = '/etc/jitsi/file-sharing-service/short_lived_token.key'; key_id = 'jitsi/short_lived_token_2025'; ttl_seconds = 30; }; ``` Enable it in the `modules_enabled` section under the main virtual host: ```lua modules_enabled = { ... 'short_lived_token'; ... }; ``` - restart prosody: ```bash systemctl restart prosody ``` - Configure the file sharing service in config.js, add to the end: ```javascript config.fileSharing = { apiUrl :"https://your-domain/file-service/v1/documents", enabled: true, }; ``` Configure nginx by adding the following to your nginx configuration file (e.g., `/etc/nginx/sites-available/your-domain.conf`): ```nginx client_max_body_size 50M; location ^~ /file-service/ { # Remove /file-service prefix when forwarding rewrite ^/file-service(/.*)$ $1 break; # Add CORS headers add_header Access-Control-Allow-Origin "$http_origin" always; add_header Access-Control-Allow-Methods "GET, POST, PUT, DELETE, OPTIONS" always; add_header Access-Control-Allow-Headers "Authorization, Content-Type, X-Requested-With" always; add_header Access-Control-Allow-Credentials "true" always; # Handle preflight requests if ($request_method = OPTIONS) { return 204; } proxy_pass http://localhost:3000/; proxy_http_version 1.1; proxy_set_header Upgrade $http_upgrade; proxy_set_header Connection 'upgrade'; proxy_set_header Host $host; proxy_set_header X-Real-IP $remote_addr; proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; proxy_set_header X-Forwarded-Proto $scheme; proxy_cache_bypass $http_upgrade; proxy_connect_timeout 60s; proxy_send_timeout 60s; proxy_read_timeout 60s; } ``` - restart nginx ```bash systemctl restart nginx ``` - Setup the environment variables for the file sharing service in `/srv/jitsi-meet-file-sharing-service/.env`: ```bash JWT_PUBLIC_KEY_PATH=/etc/jitsi/file-sharing-service/short_lived_token.pem UPLOAD_DIR=/var/www/jitsi-meet-file-sharing-service/uploads ``` - restart the file sharing service: ```bash cd /srv/jitsi-meet-file-sharing-service nvm use pm2 delete jitsi-meet-file-sharing-service pm2 start ecosystem.config.js --env production ``` ### Authentication Configuration - If you are using **JWT authentication**, make sure you pass 'file-upload' feature in `context.features` in the jwt. ``` { ..., "context": { "user": { "id": "....", ... }, "features": { "file-upload": true, ... }, ... } } ``` - If you are using **internal authentication** (e.g. `prosodyctl register`) or other authentication methods without tokens, you need to configure `jitsi_default_permissions` in your Prosody config (e.g. `/etc/prosody/conf.avail/your-domain.cfg.lua`) to include `file-upload`. ```lua jitsi_default_permissions = { livestreaming = true; recording = true; transcription = true; ['outbound-call'] = true; ['create-polls'] = true; ['file-upload'] = true; ['send-groupchat'] = true; flip = true; }; ``` If you change prosody configuration, make sure to restart it. ### Usage - To rebuild the app: `npm run build` - To restart the service: `pm2 restart file-sharing-service` - To watch the logs: `pm2 logs file-sharing-service` ================================================ FILE: docs/devops-guide/ldap-authentication.md ================================================ --- id: ldap-authentication title: LDAP Authentication sidebar_label: Authentication (LDAP) --- :::note This is a first draft and might not work on your system. It has been tested on Debian 11 installation with prosody 0.11 and authenticates against an OpenLDAP directory, and on Ubuntu 24.04 with Prosody 0.12 against an Active Directory. ::: If you want to authenticate your users against an LDAP directory instead of the local Prosody user database, you can use the Cyrus SASL package. Using this package you might be able to validate user-supplied credentials against other sources, such as PAM, SQL and more - but this is beyond this article. ## Prerequisites Before following this article, make sure you have set up Prosody as described in [Authentication (Secure Domain)](secure-domain.md) first. ### Required packages On Debian systems you need to install some required packages: ``` 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 ``` The first two packages are necessary for Cyrus' `saslauthd` and allow it to connect to an LDAP directory. The `lua-cyrussasl`-package allows Prosody to access Cyrus SASL. Installing the [mod_auth_cyrus](https://modules.prosody.im/mod_auth_cyrus) module is neccessary because support for Cyrus SASL has been [removed](https://prosody.im/doc/cyrus_sasl) from mainline Prosody and placed in the community module repository. ## Install and set up Cyrus SASL The following options define a basic LDAP configuration. A full set of possible options can be found in [LDAP_SASLAUTHD](https://github.com/winlibs/cyrus-sasl/blob/master/saslauthd/LDAP_SASLAUTHD). By default Cyrus' `saslauthd` searches for its LDAP configuration in `/etc/saslauthd.conf`. So create this file and enter something similar to define your LDAP environment: ``` ldap_servers: ldaps://ldap.example.com ldap_bind_dn: admin@example.com ldap_bind_pw: topsecret ldap_auth_method: bind ldap_search_base: ou=people,dc=example,dc=com ``` :::note One omitted option you might want to look into is `ldap_filter` which defaults to `uid=%u` and should work for a lot of systems. If you are using a Samba or Microsoft AD instance as your LDAP server you may need to change this to `ldap_filter: (sAMAccountName=%U)` as `uid` is NULL by default many configurations. You can also use the `ldap_filter` to allow only specific users access. For more details on this and other options see the `LDAP_SASLAUTHD` document linked above. Please note that Prosody may experience issues with usernames containing the "@"-symbol. You can work around this issue by changing `uid=%u` to `uid=%U`, which is [defined](https://github.com/winlibs/cyrus-sasl/blob/d933c030ce12ec0668469d79ab8378e347a1b3ba/saslauthd/LDAP_SASLAUTHD#L126) as the "user portion of %u (%U = test when %u = test@domain.tld)" ::: ### Test LDAP authentication To test if the LDAP configuration is working, you can start `saslauthd` in debug mode while specifying the mandatory LDAP authentication mechanism: ``` sudo saslauthd -d -a ldap ``` The test utility for the SASL authentication server can then be used in a secondary terminal. Replace `user` and `password` with credentials stored in LDAP. ``` sudo testsaslauthd -u user -p password 0: OK "Success." sudo testsaslauthd -u user -p wrongpassword 0: NO "authentication failed" ``` After testing, you can stop `saslauthd` using `ctrl-c`. ### Enable the `saslauthd` service You will need to edit the `/etc/default/saslauthd` to enable the `saslauthd` service to run at boot and have it use LDAP for authentication. You can use sed to do this quickly. ``` sudo sed -i -e "s/START=.*/START=yes/" -e "s/MECHANISMS=.*/MECHANISMS=\"ldap\"/" /etc/default/saslauthd ``` This will make the following changes to `/etc/default/saslauthd`. ``` [...] # Should saslauthd run automatically on startup? (default: no) START=yes [...] # Example: MECHANISMS="pam" MECHANISMS="ldap" [...] ``` It is not necessary to point `MECH_OPTIONS` to the LDAP configuration file since this is the default for this mechanism. Now you can start, restart and stop `saslauthd` using the `service` scripts: ``` sudo service saslauthd restart ``` If you experience issues, check `/var/log/auth.log` for `saslauthd` entries. ### Cyrus SASL Configuration file Cyrus SASL requires a configuration file in order to know how to check user credentials. For Prosody, the file is named `prosody.conf` by default. Its location varies by OS and distribution as shown in the following table: | Platform | Location | | ----------------- | ---------- | | Debian and Ubuntu | /etc/sasl | | Arch, RHEL/CentOS | /etc/sasl2 | So for Debian systems, create the file `/etc/sasl/prosody.conf`. The directory `/etc/sasl` might not yet exist. ``` sudo mkdir /etc/sasl/ cat << 'EOF' |sudo tee /etc/sasl/prosody.conf > /dev/null pwcheck_method: saslauthd mech_list: PLAIN EOF ``` :::note The filename `prosody.conf` corresponds to a value for `cyrus_application_name` in the Prosody config. Since we have not changed the default this has a value of `prosody`. ::: The Prosody documentation has more details on a [Cyrus SASL-related setup](https://prosody.im/doc/cyrus_sasl). ## Set up Prosody If you have tested the LDAP authentication successfully and enabled the `saslauthd` service, you can change Prosody's authentication to the Cyrus backend by changing the `authentication` setting in `/etc/prosody/conf.avail/$(hostname -f).cfg.lua` via the command: ``` sed -i -E -e "/^ *VirtualHost \"$(hostname -f)\"/,/^ *VirtualHost/ {s/authentication ?=.*$/authentication = \"cyrus\"/}" /etc/prosody/conf.avail/$(hostname -f).cfg.lua ``` You might also have to add the `allow_unencrypted_plain_auth` option to allow plain-text passwords to be sent over the network. *This is not recommended* as it makes the setup less secure. So please try without this line first and only add it if you have problems authenticating. ``` authentication = "cyrus" allow_unencrypted_plain_auth = true ``` ### Set Permissions Prosody will now try to access the saslauthd socket in `/var/run/saslauthd/` to communicate with the authentication daemon. This folder only allows access to user `root` and group `sasl` while prosody runs as the system user/group `prosody`. The easiest solution is to add the `sasl` group to the `prosody` user and restart the service. ``` sudo adduser prosody sasl sudo service prosody restart ``` ================================================ FILE: docs/devops-guide/log-analyser.md ================================================ --- id: devops-guide-log-analyser title: Self-Hosting Guide - Log Analyser sidebar_label: Log Analyser --- Welcome to the Jitsi Meet Log Analyser project! This integration leverages Grafana Loki and OpenTelemetry to enable effective log management and analysis for Jitsi Meet components. ## Overview This project offers a streamlined setup for collecting, parsing, and visualizing log data generated by Jitsi Meet components. The integration includes: - A Docker Compose setup file (`log-analyser.yml`) for configuring Loki and OpenTelemetry Collector. - A Docker Compose setup file (`grafana.yml`) for configuring Grafana. - A unified Docker Compose command that initiates all services concurrently. - Instructions on configuring Grafana with Loki as a log data source for enhanced visualization and analysis. ## Getting Started ### Prerequisites Before you begin, ensure you have the following installed on your system: - [Docker](https://docs.docker.com/get-docker/) - [Docker Compose](https://docs.docker.com/compose/install/) ### Setup To set up the project, follow these steps: 1. **Clone the repository:** Clone the Jitsi Meet repository that contains the necessary Docker Compose files. ```bash git clone https://github.com/jitsi/docker-jitsi-meet.git cd docker-jitsi-meet ``` 2. **Update Jitsi Meet Docker Compose Configuration:** To enable log collection and analysis, you need to modify the `docker-compose.yml` file for Jitsi Meet components. Add the following configuration to each Jitsi service within the `docker-compose.yml` file: ```yaml logging: driver: "json-file" options: labels: "service" ``` This configuration ensures that logs are collected in JSON format and tagged with service labels, which is essential for Loki to properly ingest and index the logs. 3. **Start the Docker containers:** Use the following command to start all required services, including the Jitsi Meet components, Grafana, Loki, and OpenTelemetry: ```bash docker-compose -f docker-compose.yml -f log-analyser.yml -f grafana.yml up -d ``` - **Explanation:** - The command combines multiple Docker Compose files to launch the entire stack: - `docker-compose.yml` launches the Jitsi Meet components. - `log-analyser.yml` sets up the log analysis tools, including Loki and OpenTelemetry. - `grafana.yml` initializes Grafana for log visualization. - Logs generated by the Jitsi Meet components are automatically forwarded to Loki via the OpenTelemetry Collector, making them available for analysis in Grafana. - **Note:** If you only want to use Grafana for log visualization without the log analysis tools, you can run `grafana.yml` independently. However, for the complete log analysis setup, both `log-analyser.yml` and `grafana.yml` are required. ### Access Grafana After starting the services, follow these steps to access Grafana: 1. **Open Grafana in your web browser:** Navigate to [http://localhost:3000](http://localhost:3000) to access the Grafana interface. 2. **Log in to Grafana:** Use the default login credentials provided below: - **Username:** `admin` - **Password:** `admin` (It is recommended to change these credentials after the first login for security purposes.) ### Pre-configured Dashboards Grafana comes with several pre-configured dashboards specifically designed for monitoring different Jitsi Meet components. These dashboards will be automatically available once you log in to Grafana. **Important❗️:** For data to appear in these dashboards, logs need to be generated by the Jitsi Meet components. Here are the available dashboards: - **Jicofo Dashboard:** Visualizes logs related to Jitsi Conference Focus (Jicofo), which handles media and signaling in Jitsi Meet. - **JVB Dashboard:** Focuses on Jitsi Videobridge (JVB) logs, showing details on video streaming and performance metrics. - **Prosody Dashboard:** Monitors Prosody, the XMPP server used by Jitsi Meet for signaling. - **Web Dashboard:** Displays logs and metrics related to the web frontend of Jitsi Meet. - **Jitsi All Dashboard:** A comprehensive dashboard that aggregates logs from all Jitsi Meet components. ![Jitsi Meet Log Analyser Dashboard](https://github.com/user-attachments/assets/2e54833e-4906-4429-81ce-7e56b7bf38d1) ### Filtering Logs with LogQL Beyond the pre-configured dashboards, you can explore and filter logs in Grafana's "Explore" section using LogQL, a powerful query language designed for Loki. Here’s how you can filter and analyze logs: 1. **Access the Explore section:** In Grafana, navigate to the **Explore** tab from the left sidebar. This section allows you to run queries on your logs in real-time. 2. **Select the Loki Data Source:** In the Explore section, ensure that the **Data Source** is set to **Loki**. This is essential because Loki is the backend that stores and manages the log data collected from Jitsi Meet components. 3. **Using LogQL for Filtering:** LogQL enables you to create complex queries to filter specific logs. For example, the following LogQL query filters logs for the `jitsi-jicofo` component and parses them: ```logql {exporter="OTLP"} | json | attributes_attrs_service="jitsi-jicofo" ``` - **Explanation:** - `{exporter="OTLP"}`: Selects logs that are exported via OpenTelemetry. - `| json`: Parses the log data as JSON, making attributes accessible for filtering. - `attributes_attrs_service="jitsi-jicofo"`: Filters logs where the `attributes_attrs_service` field equals `"jitsi-jicofo"`. You can modify the query to filter logs from other components or adjust the criteria according to your needs. For more details and advanced usage of LogQL, you can refer to the official [LogQL documentation](https://grafana.com/docs/loki/latest/logql/) from Grafana. ![LogQL Query Example](https://github.com/user-attachments/assets/f75c77a6-6f7b-41ae-9efe-855a5b426bdf) ## Usage Once the setup is complete, you can start exploring your log data in Grafana. The pre-configured dashboards provide an insightful visualization of the logs collected from Jitsi Meet components. Use these dashboards to: - **Parse Logs:** View detailed logs collected from various components. - **Visualize Logs:** Analyze log data through various charts, graphs, and panels to gain insights into system performance and issues. ### Customizing Dashboards While the pre-configured dashboards provide a solid starting point, you may want to customize them or create new dashboards to suit your specific needs. Here's how you can do that: 1. **Create a New Dashboard:** - Go to the Grafana home page, click on the "+" icon on the left sidebar, and select "Dashboard." - Add panels to visualize different metrics or logs by selecting the appropriate data source (Loki) and using LogQL queries. 2. **Customize Existing Dashboards:** - Navigate to an existing dashboard and click on the "Edit" button (pencil icon) on any panel. - Adjust the LogQL query, visualization type, and panel settings to match your requirements. 3. **Save and Share Dashboards:** - After customizing, save the dashboard. You can also export it as a JSON file to share with others or for backup. - To export the dashboard: - Click on the dashboard title to open the options menu. - Select **"Dashboard settings"** > **"JSON Model"**. - Click **"Download JSON"** to save the file locally. 4. **Contribute to Jitsi Meet Dashboards:** - If you've created or customized a dashboard that could benefit the wider Jitsi community, you can contribute by updating the relevant dashboard JSON file. - Here’s how to do it: - Export the JSON file of your customized dashboard as described above. - Locate the corresponding Jitsi component dashboard JSON file in the repository (e.g., `jicofo-dashboard.json`, `jvb-dashboard.json`). - Update the existing JSON file with your changes. - Submit a pull request to the repository with the updated JSON file and a brief description of the changes you made. - This helps improve the pre-configured dashboards and makes your contributions available to all users. 5. **Grafana Provisioning:** - The Jitsi Meet Log Analyser uses Grafana provisioning to manage dashboards. When you update a dashboard JSON file in the repository, it will be automatically provisioned in Grafana when the stack is deployed. - This ensures that everyone using the repository gets the latest version of the dashboards without needing to manually import them. By following these steps, you can not only customize your own monitoring setup but also contribute improvements back to the Jitsi community. ### Troubleshooting If you encounter issues while setting up or using the Jitsi Meet Log Analyser, here are some common problems and their solutions: 1. **Grafana Not Starting:** - Check if the Grafana container is running with `docker ps` and inspect logs using `docker logs grafana` for any errors. 2. **No Logs in Grafana Dashboards:** - Ensure that Jitsi Meet components are generating logs. Clear browser cache, reload Grafana. Ensure OpenTelemetry, Loki, and Grafana containers are all running with `docker ps`, and inspect each container's logs for issues using `docker logs `. 3. **OpenTelemetry Collector Not Forwarding Logs:** - Check OpenTelemetry's logs with `docker logs otel`, ensure it's connected to the correct endpoints, and verify the log format is correct. 4. **Authentication Failures in Grafana:** - Restart Grafana with `docker restart grafana otel`. If still unsuccessful, delete the data volume with `docker-compose down -v` and restart to reset to default credentials (admin/admin). 5. **Slow Queries:** - If LogQL queries are slow, try optimizing the query in Grafana. 6. **Permission Issues:** - If you encounter permission issues, make sure that Docker has the necessary access rights to the directories where logs are stored. 7. **Docker Network Issues:** - Verify Docker network connections, IP range, and restart the network if necessary. 8. **OpenTelemetry Collector Not Forwarding Logs:** - Check OpenTelemetry logs, verify configuration, and ensure log format compatibility. 9. **Docker Containers Failing to Start:** - Use `docker-compose logs` to view detailed startup errors, and check for common issues like incorrect configurations. ## Acknowledgements We appreciate your interest in the Jitsi Meet Log Analyser project! If you encounter any issues or have questions, feel free to reach out to the project maintainers or contribute to the repository. ================================================ FILE: docs/devops-guide/opensuse.md ================================================ --- id: devops-guide-opensuse title: Self-Hosting Guide - openSUSE sidebar_label: openSUSE --- This document describes the steps for a quick Jitsi-Meet installation, paired with a single Videobridge and a single Jicofo on openSUSE Leap 15.2. :::note Many of the installation steps require root access. ::: ## Installation 1. Add the OBS repository: __Note:__ When Jitsi-Meet is merged into openSUSE Factory, this will be obsolete. ```shell zypper addrepo https://download.opensuse.org/repositories/home:/SchoolGuy:/jitsi/openSUSE_Leap_15.2/home:SchoolGuy:jitsi.repo ``` 2. Refresh the repositories: ```shell zypper refresh ``` 3. Install Jitsi-Meet and its dependencies: ```shell zypper install nginx prosody lua51-zlib jitsi-meet jitsi-videobridge jitsi-jicofo ``` ### optional Add-Ons * Install the Jibri Add-On: `zypper install jitsi-jibri` * Install the Jigasi Add-On: `zypper install jitsi-jigasi` ## Configuration The following sections describe how to configure the different packages. Replace `` with your domain name and `YOURSECRET3` with a strong password. ### Prosody * Open and adjust the Prosody configuration file under `/etc/prosody/prosody.cfg.lua`: ```lua ---------- Server-wide settings ---------- admins = { "focus@auth." } cross_domain_bosh = true; modules_enabled = { -- HTTP modules "bosh"; -- Enable BOSH clients, aka "Jabber over HTTP" -- jitsi "smacks"; "mam"; "lastactivity"; "offline"; "pubsub"; "adhoc"; "websocket"; "http_altconnect"; "compression"; } ``` * Create a new configuration file named `.cfg.lua` in `/etc/prosody/conf.avail/` with the following content: ```lua title="/etc/prosody/conf.avail/meet.example.org.cfg.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 = ""; turncredentials_secret = "YOURSECRET3"; turncredentials = { { type = "stun", host = "", port = "3478" }, { type = "turn", host = "", port = "3478", transport = "udp" }, -- { type = "turns", host = "", port = "443", transport = "tcp" } }; VirtualHost "" authentication = "anonymous" ssl = { key = "/var/lib/prosody/.key"; certificate = "/var/lib/prosody/.crt"; } speakerstats_component = "speakerstats." conference_duration_component = "conferenceduration." modules_enabled = { "bosh"; "pubsub"; "speakerstats"; "turncredentials"; "conference_duration"; } c2s_require_encryption = false Component "conference." "muc" modules_enabled = { "muc_meeting_id"; "muc_domain_mapper"; } admins = { "focus@auth." } muc_room_locking = false muc_room_default_public_jids = true -- internal muc component Component "internal.auth." "muc" modules_enabled = { "ping"; } admins = { "focus@auth." } muc_room_locking = false muc_room_default_public_jids = true muc_room_cache_size = 1000 Component "jitsi-videobridge." component_secret = "YOURSECRET3" VirtualHost "auth." ssl = { key = "/var/lib/prosody/auth..key"; certificate = "/var/lib/prosody/auth..crt"; } authentication = "internal_plain" Component "focus." component_secret = "YOURSECRET3" Component "speakerstats." "speakerstats_component" muc_component = "conference." Component "conferenceduration." "conference_duration_component" muc_component = "conference." ``` * Create a symlink for the configuration: `ln --symbolic /etc/prosody/conf.avail/.cfg.lua /etc/prosody/conf.d/.cfg.lua` * Create the certificates via `prosodyctl cert generate `. The value `` represents the following URLs. * `auth.` * `conference.` * `conferenceduration.` * `internal.auth.` * `FQDN` * `focus.` * `jitsi-videobridge.` * `callcontrol.` __Note:__ This is only needed if you deploy Jigasi * `recorder.` __Note:__ This is only needed if you deploy Jibri * `/var/lib/prosody/`: Symlink all generated `*.crt` and `*.key` files to `/etc/prosody/certs/`. :::note Please do not link other certificates. ::: * Add the certificates to the system keystore: * `ln --symbolic --force /var/lib/prosody/auth..crt /usr/local/share/ca-certificates/auth..crt` * `update-ca-certificates --fresh` * Create conference focus user: `prosodyctl register focus auth. YOURSECRET3` ### Nginx Edit the file `jitsi-meet.conf` in `/etc/nginx/vhosts.d/` (which was installed along with `jitsi-meet`) and do the following: * Check the `server_name` value. * Check the TLS certificates (Let's Encrypt for production use, Prosody for testing, for example). :::warning[Mobile apps] The jitsi mobile apps _require_ a valid certificate signed by a trusted [Certificate Authority](https://en.wikipedia.org/wiki/Certificate_authority), so if you don't have TLS configured, the mobile apps won't be able to connect to your jitsi instance. ::: :::note If you are using an existing server, please make sure to adjust the websocket and bosh part, too. ::: ### Jitsi-Meet * Go to `/srv/jitsi-meet` and edit `config.js`: ```js title="/srv/jitsi-meet/config.js" var config = { hosts: { domain: '', muc: 'conference.', bridge: 'jitsi-videobridge.', focus: 'focus.' }, useNicks: false, bosh: '///http-bind', }; ``` :::note Please be aware that this is the minimal configuration. ::: ### Jitsi-Videobridge :::note We use a combination of the [new Videobridge configuration](https://github.com/jitsi/jitsi-videobridge/blob/master/doc/muc.md#videobridge-configuration) and the legacy one with the `sip-communicator.properties` file. We have to do this because of the `STATISTICS_TRANSPORT` property. ::: If we remove `org.jitsi.videobridge.STATISTICS_TRANSPORT=muc,colibri` from `sip-communicator.properties`, the videobridge will not work! * Go to the directory `/etc/jitsi/videobridge` * Edit the file `jitsi-videobridge.conf` * Set `JVB_HOSTNAME` to your ``. * Set `JVB_SECRET` to your own secret. * Edit the file `application.conf` and adjust the values under `apis` and `websockets`, especially set a unique ID as `muc_nickname` with `uuidgen` for example. ```HUCON apis { xmpp-client { configs { xmpp-server-1 { hostname="localhost" domain = "auth.${FQDN}" username = "focus" password = "YOURSECRET3" muc_jids = "JvbBrewery@internal.auth.${FQDN}" # The muc_nickname must be unique across all jitsi-videobridge instances muc_nickname = "unique-id" disable_certificate_verification = true } } } } websockets { enabled=true server-id="default-id" domain="${FQDN}" } ``` ### Jitsi-Jicofo * Go to the directory `/etc/jitsi/jicofo` * Edit the file `jitsi-jicofo.conf` * Set the property `JICOFO_HOSTNAME` to ``. * Set the property `JICOFO_SECRET` to the password the Prosody user got in above setup. * Set the property `JICOFO_AUTH_DOMAIN` to `auth.`. * Set the property `JICOFO_AUTH_USER` to the Prosody user from above setup. * Edit the file `sip-cmmunicator.properties` * Set the property `org.jitsi.jicofo.BRIDGE_MUC` to `JvbBrewery@internal.auth.`. * Set the property `org.jitsi.jicofo.jibri.BREWERY` to `JibriBrewery@internal.auth.`. * Depending on your cert setup set `org.jitsi.jicofo.ALWAYS_TRUST_MODE_ENABLED` to `true` or `false`. ## Add-On: Jitsi-Jibri * Add to the file `/etc/prosody/conf.avail/.cfg.lua` the following snippet at the end of the file. ```lua VirtualHost "recorder." modules_enabled = { "ping"; } authentication = "internal_plain" ``` * Run `prosodyctl register jibri auth. YOURSECRET3` and replace `YOURSECRET3` with an appropiate one. * `prosodyctl register recorder recorder. YOURSECRET3` and replace `YOURSECRET3` with an appropiate one. * Go to the directory `/etc/jitsi/jibri` and edit the following properties you see listed below. The rest can be left as is. ```HUCON jibri{ api{ environments = [ { xmpp-domain = "" control-muc { domain = "internal." } control-login { domain = "recorder." username = "recorder" password = "YOURSECRET3" } call-login { domain = "recorder." username = "recorder" password = "YOURSECRET3" } } ] } } ``` * Edit the file `/etc/jitsi/jicofo/sip-communicator.properties` and add the following properties: ```HUCON org.jitsi.jicofo.jibri.BREWERY=JibriBrewery@internal.auth. org.jitsi.jicofo.jibri.PENDING_TIMEOUT=90 ``` * Edit the file `/srv/jitsi-meet/config.js` and set the following properties: ```js fileRecordingsEnabled: true, // If you want to enable file recording liveStreamingEnabled: true, // If you want to enable live streaming hiddenDomain: 'recorder.', ``` * Edit `/srv/jitsi-meet/interface_config.js` and make sure the `TOOLBAR_BUTTONS` array contains the `recording` and the `livestreaming` value if you want those features. ```js TOOLBAR_BUTTONS: [ 'microphone', 'camera', 'closedcaptions', 'desktop', 'embedmeeting', 'fullscreen', 'fodeviceselection', 'hangup', 'profile', 'chat', 'recording', 'livestreaming', 'etherpad', 'sharedvideo', 'settings', 'raisehand', 'videoquality', 'filmstrip', 'invite', 'feedback', 'stats', 'shortcuts', 'tileview', 'videobackgroundblur', 'download', 'help', 'mute-everyone', 'security' ], ``` ## Add-On: Jitsi-Jigasi :::note[Note from openSUSE packagers:] We've packaged it but we don't have the infrastructure to set up this component. Hence we can't provide a guide for this so far. ::: ## Services Now everything should be working. That means you are ready to start everything up: 1. `systemctl start prosody` 1. `systemctl start jitsi-videbridge` 1. `systemctl start jitsi-jicofo` 1. `systemctl start jitsi-jibri` (if configured and installed beforehand) 1. `systemctl start jitsi-jigasi` (if configured and installed beforehand) 1. `systemctl start nginx` ## Final notes * The Jitsi Software has a lot of dependencies and thus we recommend to run this on a dedicated host for Jitsi. * Updating Jitsi is crucial to get rid of bugs and updated dependencies with possible security fixes. * Although tempted through Chrome: Don't install a full X11 stack like KDE or Gnome for this. * Don't mix the `rpms` or `debs` with a source installation of the same component. * Securely backup your configuration, preferably in a VCS. This saves time and pain when doing rollbacks or dealing with other problems. ================================================ FILE: docs/devops-guide/quickstart.md ================================================ --- id: devops-guide-quickstart title: "Self-Hosting Guide - Debian/Ubuntu server" sidebar_label: "Debian/Ubuntu server" --- Follow these steps for a quick Jitsi-Meet installation on a Debian-based GNU/Linux system. The following distributions are supported out-of-the-box: - Debian 11 (Bullseye) or newer - Ubuntu 22.04 (Jammy Jellyfish) or newer :::note Many of the installation steps require `root` or `sudo` access. So it's recommended to have `sudo`/`root` access to your system. ::: ## Required packages and repository updates You will need the following packages: * `gnupg2` * `nginx-full` * `sudo` => **Only needed if you use `sudo`** * `curl` => **Or** `wget` **to [Add the Jitsi package repository](#add-the-jitsi-package-repository)** :::note Note OpenJDK 17 must be used. ::: Make sure your system is up-to-date and required packages are installed: Run as `root` or with `sudo`: ```bash # Retrieve the latest package versions across all repositories sudo apt update # Ensure support for apt repositories served via HTTPS sudo apt install apt-transport-https ``` On Ubuntu systems, Jitsi requires dependencies from Ubuntu's `universe` package repository. To ensure this is enabled, run this command: ```bash sudo add-apt-repository universe ``` Retrieve the latest package versions across all repositories: ```bash sudo apt update ``` ## Install Jitsi Meet ### Domain of your server and set up DNS Decide what domain your server will use. For example, `meet.example.org`. Set a DNS A record for that domain, using: - your server's public IP address, if it has its own public IP; or - the public IP address of your router, if your server has a private (RFC1918) IP address (e.g. 192.168.1.2) and connects through your router via Network Address Translation (NAT). If your computer/server or router has a dynamic IP address (the IP address changes constantly), you can use a dynamic dns-service instead. Example [DuckDNS](https://www.duckdns.org/). DNS Record Example: | **Record Type** | **Hostname** | **Public IP** | **TTL (Seconds)** | |:---:|:---:|:---:|:---:| | `A` | `meet.example.org` | Your Meeting Server Public IP (`x.x.x.x`) | `1800` | ### Set up the Fully Qualified Domain Name (FQDN) (optional) If the machine used to host the Jitsi Meet instance has a FQDN (for example `meet.example.org`) already set up in DNS, you can set it with the following command: ```bash sudo hostnamectl set-hostname meet.example.org ``` Then add the same FQDN in the `/etc/hosts` file: 127.0.0.1 localhost x.x.x.x meet.example.org :::note `x.x.x.x` is your server's public IP address. ::: Finally on the same machine test that you can ping the FQDN with: `ping "$(hostname)"` If all worked as expected, you should see: `meet.example.org` ### Add the Prosody package repository This will add the Prosody repository so that an up to date Prosody is installed, which is necessary for features including the lobby feature. ```bash sudo curl -sL https://prosody.im/files/prosody-debian-packages.key -o /usr/share/keyrings/prosody-debian-packages.key echo "deb [signed-by=/usr/share/keyrings/prosody-debian-packages.key] http://packages.prosody.im/debian $(lsb_release -sc) main" | sudo tee /etc/apt/sources.list.d/prosody-debian-packages.list sudo apt install lua5.2 ``` ### Add the Jitsi package repository This will add the jitsi repository to your package sources to make the Jitsi Meet packages available. ```bash curl -sL https://download.jitsi.org/jitsi-key.gpg.key | sudo sh -c 'gpg --dearmor > /usr/share/keyrings/jitsi-keyring.gpg' echo "deb [signed-by=/usr/share/keyrings/jitsi-keyring.gpg] https://download.jitsi.org stable/" | sudo tee /etc/apt/sources.list.d/jitsi-stable.list ``` Update all package sources: ```bash sudo apt update ``` ### Setup and configure your firewall The following ports need to be open in your firewall, to allow traffic to the Jitsi Meet server: * `80 TCP` => For SSL certificate verification / renewal with Let's Encrypt. **Required** * `443 TCP` => For general access to Jitsi Meet. **Required** * `10000 UDP` => For General Network Audio/Video Meetings. **Required** * `22 TCP` => For Accessing your Server using SSH (change the port accordingly if it's not 22). **Required** * `3478 UDP` => For querying the stun server (coturn, optional, needs `config.js` change to enable it). * `5349 TCP` => For fallback network video/audio communications over TCP (when UDP is blocked for example), served by coturn. **Required** If you are using `ufw`, you can use the following commands: ```bash sudo ufw allow 80/tcp sudo ufw allow 443/tcp sudo ufw allow 10000/udp sudo ufw allow 22/tcp sudo ufw allow 3478/udp sudo ufw allow 5349/tcp sudo ufw enable ``` Check the firewall status with: ``` sudo ufw status verbose ``` #### Using SSH For more details on using and hardening SSH access, see the corresponding [Debian](https://wiki.debian.org/SSH) or [Ubuntu](https://help.ubuntu.com/community/SSH/OpenSSH/Configuring) documentation. #### Forward ports via your router If you are running Jitsi Meet on a server [behind NAT](https://jitsi.github.io/handbook/docs/faq#how-to-tell-if-my-server-instance-is-behind-nat), forward the ports on your router to your server's IP address. _Note_: if participants cannot see or hear each other, double check your firewall / NAT rules. ### TLS Certificate In order to have encrypted communications, you need a [TLS certificate](https://en.wikipedia.org/wiki/Transport_Layer_Security). During installation of Jitsi Meet you can choose between different options: 1. The recommended option is to choose Let's Encrypt Certificate option 2. But if you want to use a different certificate you should get that certificate first and then install jitsi-meet and choose ___I want to use my own certificate___. 3. You could also use the self-signed certificate(___Generate a new self-signed certificate___) but this is not recommended for the following reasons: * Using a self-signed certificate will result in warnings being shown in your users browsers, because they cannot verify your server's identity. * Jitsi Meet mobile apps *require* a valid certificate signed by a trusted [Certificate Authority](https://en.wikipedia.org/wiki/Certificate_authority) and will not be able to connect to your server if you choose a self-signed certificate. ### Install Jitsi Meet _Note_: The installer will check if [Nginx](https://nginx.org/) or [Apache](https://httpd.apache.org/) are present (in that order) and configure a virtual host within the web server it finds to serve Jitsi Meet. If you are already running Nginx on port 443 on the same machine, turnserver configuration will be skipped as it will conflict with your current port 443. ```bash # jitsi-meet installation sudo apt install jitsi-meet ``` **SSL/TLS certificate generation:** You will be asked about SSL/TLS certificate generation. See [above](#tls-certificate) for details. **Hostname:** You will also be asked to enter the hostname of the Jitsi Meet instance. If you have a domain, use the specific domain name, for example: `meet.example.org`. Alternatively you can enter the IP address of the machine (if it is static or doesn't change). This hostname will be used for virtualhost configuration inside Jitsi Meet and also, you and your correspondents will be using it to access the web conferences. ### Access Control **Jitsi Meet server:** _Note_: By default, anyone who has access to your Jitsi Meet server will be able to start a conference: if your server is open to the world, anyone can have a chat with anyone else. If you want to limit the ability to start a conference to registered users, follow the instructions to set up a [secure domain](https://jitsi.github.io/handbook/docs/devops-guide/secure-domain/). **Conferences/Rooms:** The access control for conferences/rooms is managed in the rooms, you can set a password on the webpage of the specific room after creation. See the User Guide for details: https://jitsi.github.io/handbook/docs/user-guide/user-guide-start-a-jitsi-meeting ### Advanced configuration If the installation is on a machine [behind NAT](https://jitsi.github.io/handbook/docs/faq#how-to-tell-if-my-server-instance-is-behind-nat) jitsi-videobridge should configure itself automatically on boot. If three way calls do not work, further configuration of jitsi-videobridge is needed in order for it to be accessible from outside. Provided that all required ports are routed (forwarded) to the machine that it runs on. By default these ports are TCP/443 and UDP/10000. Add a static mapping to the `ice4j.harvest.mapping` section in `/etc/jitsi/videobridge/jvb.conf`: ``` ice4j { harvest { mapping { static-mappings = [ { local-address = "" public-address = "" } ] } } } ``` See [the documentation of ice4j](https://github.com/jitsi/ice4j/blob/4f1329607cdcfd9ea13c0a5e7e099205775f7a0b/src/main/resources/reference.conf#L91) for details. **Systemd/Limits:** Default deployments will have low values for maximum processes and open files. For greater than 100 participants, change `/etc/systemd/system.conf` to: ``` DefaultLimitNOFILE=65000 DefaultLimitNPROC=65000 DefaultTasksMax=65000 ``` To check values just run: ``` systemctl show --property DefaultLimitNPROC systemctl show --property DefaultLimitNOFILE systemctl show --property DefaultTasksMax ``` To load the values and check them see [below](#systemd-details) for details. ##### Systemd details To reload the systemd changes on a running system execute `sudo systemctl daemon-reload` and `sudo systemctl restart jitsi-videobridge2`. To check the tasks part execute `sudo systemctl status jitsi-videobridge2` and you should see `Tasks: XX (limit: 65000)`. To check the files and process part execute ```cat /proc/`cat /var/run/jitsi-videobridge/jitsi-videobridge.pid`/limits``` and you should see: ``` Max processes 65000 65000 processes Max open files 65000 65000 files ``` ### Confirm that your installation is working Launch a web browser (such as Firefox, Chrome or Safari) and enter the hostname or IP address from the previous step into the address bar. If you used a self-signed certificate (as opposed to using Let's Encrypt), your web browser will ask you to confirm that you trust the certificate. If you are testing from the iOS or Android app, it will probably fail at this point, if you are using a self-signed certificate. You should see a web page prompting you to create a new meeting. Make sure that you can successfully create a meeting and that other participants are able to join the session. If this all worked, then congratulations! You have an operational Jitsi conference service. ## Uninstall ```bash sudo apt purge jigasi jitsi-meet jitsi-meet-web-config jitsi-meet-prosody jitsi-meet-turnserver jitsi-meet-web jicofo jitsi-videobridge2 ``` Sometimes the following packages will fail to uninstall properly: - jigasi - jitsi-videobridge When this happens, just run the uninstall command a second time and it should be ok. The reason for the failure is that sometimes the uninstall script is faster than the process that stops the daemons. The second run of the uninstall command fixes this, as by then the jigasi or jitsi-videobridge daemons are already stopped. ## Debugging problems * Web Browser: You can try to use a different web browser. Some versions of some browsers are known to have issues with Jitsi Meet. * WebRTC, Webcam and Microphone: You can also visit https://webrtc.github.io/samples/src/content/getusermedia/gum to test your browser's [WebRTC](https://en.wikipedia.org/wiki/WebRTC) support. * Firewall: If participants cannot see or hear each other, double check your firewall / NAT rules. * Nginx/Apache: As we prefer the usage of Nginx as webserver, the installer checks first for the presence of Nginx and then for Apache. In case you desperately need to enforce the usage of apache, try pre-setting the variable `jitsi-meet/enforce_apache` for package `jitsi-meet-web-config` on debconf. * Log files: Take a look at the various log files: ``` /var/log/jitsi/jvb.log /var/log/jitsi/jicofo.log /var/log/prosody/prosody.log ``` ## Additional Functions ### Adding sip-gateway to Jitsi Meet #### Install Jigasi Jigasi is a server-side application acting as a gateway to Jitsi Meet conferences. It allows regular [SIP](https://en.wikipedia.org/wiki/Session_Initiation_Protocol) clients to join meetings and provides transcription capabilities. ```bash sudo apt install jigasi ``` During the installation, you will be asked to enter your SIP account and password. This account will be used to invite the other SIP participants. #### Reload Jitsi Meet Launch again a browser with the Jitsi Meet URL and you'll see a telephone icon on the right end of the toolbar. Use it to invite SIP accounts to join the current conference. Enjoy! ================================================ FILE: docs/devops-guide/region.md ================================================ --- id: devops-guide-region title: Region-based setup --- ## Configuration for region-based setup This approach allows jicofo to recognize the region of a participant and then choose a bridge for them based on that. To set this up: * Jicofo: enable RegionBasedBridgeSelectionStrategy and set jicofo.local-region to jicofo's region * JVB: set videobridge.relay.region to the local region * prosody: enable the `jiconop`, `muc_meeting_id`, and `jitsi_session` modules and set region_name to the local region ## User region detection For your global deployment we assume you are using some sort of DNS routing from a cloud provider. At some point on your ingress add the 'X-Proxy-Region' HTTP header with the region name to the request, and forward that to the shard. This header will be handled and sent to jicofo. Some cloud providers have a feature like this built in. If you have to add the proxy yourself, you can add a regional nginx reverse proxy or HAProxy in front of your shards that adds this header. ## How it works On the shard, the request to /xmpp-websocket will go through nginx. On participant join, prosody will extract the region and add it to the participant presence, which will be seen by jicofo. That region will be in the self-presence of the participant and the client will add it to the config.deploymentInfo (for debugging purposes). After connection `jiconop` will send the client the shard and region information, both will end up in the config.deploymentInfo. There is also a stat fired from ljm to jitsi-meet. The value of this is visible in the local user stats in the UI (when you hover over the gsm bars) - serverRegion. This is the region of the bridge that is assigned by jicofo. ================================================ FILE: docs/devops-guide/requirements.md ================================================ --- id: devops-guide-requirements title: Requirements --- :::note Jitsi Meet is a real-time system. Requirements are very different from a web server and depend on many factors. Miscalculations can very easily destroy basic functionality rather than cause slow performance. Avoid adding other functions to your Jitsi Meet setup as it can harm performance and complicate optimizations. Note that Jitsi Meet design priorizes scalability by adding servers on using a huge server. Check Jitsi-videobridge documentation on adding several bridges to a Jitsi Meet server, and OCTO to go even beyond that (federation of Jitsi Meet servers). If you feel that you are a network and server administration newbie, don't even think of going there. ::: # Jitsi Meet needs, by order of importance - Network link: basic speed and reliability are essential. Check speed against the provider claims using any download tool (or ftp), and verify latency using a tool such as iperf3. Exact calculation is very complex and depend on many optimisations and tricks, but you should at least remember these numbers on resolution: 180 = 200 kbits/s 360 = 500 kbits/s 720 (HD) = 2500 kbits/s 4k = 10 Mbits/s So don't expect to have 20 users using 4K on a server with 100Mbits/s upload and download. For a friends/small organization server, 1 Gbits/s will often be enough but for a serious server 10 Gbits/s is advisable. Several (or many...) bridges having each a 10 Gbits/s link are used by big deployments. **These requirements concern the videobridge. If there are only external videobridges (as can be the case on high end Jitsi Meet servers), network performance matters much less.** - **RAM:** it's usually suggested to get 8 GB. For small meetings you can get away with 4 GB, for test servers or very small meetings you can try to use 2 GB. For big meetings it's suggested to go the scalable way over getting huge amounts of memory. - **CPU:** very low processor performance can seriously harm a real time system, especially when using a shared server (where your CPU performance can be stolen by other customers of your hoster, check on 'dedicated CPU' if you are getting a VPS, rather than a physical server). However, a consideration is that a Jitsi Meet component, Prosody, can only use ONE (1) core. So getting a lot of cores, let's say more than 32, is not always useful. For a basic server, 4 dedicated cores can be enough. - **Disk:** unless you are doing heavy logging or have very specific needs, you can get away with 20 Gbytes of standard hard disk. SSD are more a nice to have than a necessity. **If you want additional services, requirements can go up.** # Recording Jibri needs ONE system per recording. One Jibri instance = one meeting. For 5 meetings recorded simultaneously, you need 5 Jibris. There is no workaround to that. If you are knowledgeable, you can setup Jibris in containers and use a big server to save a bit on resources but that's about it. Jibri RAM, CPU and hard disk needs are far higher than Jitsi Meet itself, as it does video encoding. For `1080x720` you currently need at least 8 GB RAM, for `1280x1024` 12 GB (this is for recording a __single__ meeting). For cloud storage you will need at least SSD drives. If memory is not sufficient, CPU can't encode fast enough or hard disk is not fast enough, recordings will fail. While Jibri and Jitsi Meet can technically be hosted in a single server, it's not recommended because Jibri is a resource drain and it can harm Jitsi Meet performance, and can exhaust disk space and stop Jitsi Meet function altogether. ================================================ FILE: docs/devops-guide/reservation.md ================================================ --- id: reservation title: Reservation System setup sidebar_label: Reservation System --- ### Support for a reservation system over REST API It is possible to connect to an external conference reservation system using a REST API. Before a new Jitsi Meet conference is created, the reservation system will be queried for room availability. The system is supposed to return a positive or negative response code, which also contains conference duration. Prosody will enforce conference duration and if the time limit is exceeded the conference will be terminated. #### Enable reservation system In order to enable the reservation system, the URL base for the REST API endpoint must be configured. Under the main virtual host in prosody, enable module "reservations" and add the config `reservations_api_prefix`: ``` VirtualHost "jitmeet.example.com" -- .... modules_enabled = { -- .... "reservations"; } reservations_api_prefix = "http://reservation.example.com" ``` The URL base is used to construct the request URL. Currently, only `'/conference'` endpoint is supported, so all request will go to: ``` http://reservation.example.com/conference ``` Additional configuration options are available: * "reservations_api_timeout" to change API call timeouts (defaults to 20 seconds) * "reservations_api_headers" to specify custom HTTP headers included in all API calls e.g. to provide auth tokens. * "reservations_api_retry_count" to specify the number of times API call failures are retried (defaults to 3) * "reservations_api_retry_delay" seconds to wait between retries (defaults to 3s) * "reservations_api_should_retry_for_code" as a function that takes an HTTP response code and returns true if the API call should be retried. By default, retries are done for 5XX responses. Timeouts are never retried, and HTTP call failures are always retried. * "reservations_enable_max_occupants" to enable support for setting max occupants. If this is set to `true`, and if the API response payload includes a "max_occupants" value, then that value will be set as the max occupancy limit for that specific room. * "muc_max_occupants" module must also be enabled for this to work. * "reservations_enable_lobby_support" to enable support for lobby. If this is set to `true`, and if the API response payload includes a "lobby" field set to `true` , then the lobby will be enabled for the room. * "muc_lobby_rooms" and "persistent_lobby" modules must also be enabled for this to work. * "reservations_enable_password_support" to enable support for room password. If this is set to `true`, and if the API response payload includes a "password" value, then that value will be set as room password. Users will then be required to know that password to be able to join the room, or in the case where lobby is enabled, can use the password to bypass the lobby. ``` --- The following are all optional reservations_api_headers = { ["Authorization"] = "Bearer TOKEN-237958623045"; } reservations_api_timeout = 10 -- timeout if API does not respond within 10s reservations_api_retry_count = 5 -- retry up to 5 times reservations_api_retry_delay = 1 -- wait 1s between retries reservations_api_should_retry_for_code = function (code) return code >= 500 or code == 408 end reservations_enable_max_occupants = true -- enable integration with muc_max_occupants reservations_enable_lobby_support = true -- enable integration with muc_lobby_rooms reservations_enable_password_support = true -- enable support for setting room passwords ``` #### Call flow ##### Notes All API calls use the following datetime format: `yyyy-MM-dd'T'HH:mm:ss.SSSX` - more info can be found in `SimpleDateFormat` [JavaDoc] [JavaDoc]: https://docs.oracle.com/javase/6/docs/api/java/text/SimpleDateFormat.html ##### Conference allocation When the first user joins a MUC room (i.e. Jitsi Meet URL is opened), an `HTTP POST` request is sent to `'/conference'` endpoint with the following parameters included: * `name (string)` - short name of the conference room (not full MUC address). If tenant is used, the name will be `[tenant]roomname`. * `start_time (string)` - conference start date and time * `mail_owner (string)` - if authentication system is enabled this field will contain user's identity. It that case it will not be possible to create a new conference room without authenticating. The payload sent to the endpoint will be encoded as `application/x-www-form-urlencoded`. The reservation system is expected to respond with one of the following responses: ###### HTTP 200 or 201 Conference created successfully In the HTTP response, a JSON object is expected. It should contain conference `id` assigned by the system and `duration` measured in seconds. Sample response body: ``` { "id": 364758328, "name": "conference1234", "mail_owner": "user@server.com", "start_time": "2048-04-20T17:55:12.000Z", "duration": 900000 } ``` The object can optionally include a `max_occupants` key with an integer value. When provided, and if `reservations_enable_max_occupants` is enabled, then the value will be passed to muc_mod_max_occupants to enforce per-room occupancy limits. ###### HTTP 409 - Conference already exists This is to recover from previous failures. If for some reason the conference was restarted and the user tries to create the room again, this response informs Prosody that the conference room already exists. It is expected to contain `conflict_id` in the JSON response body: ``` { "conflict_id": 364758328 } ``` Prosody will use `HTTP GET` to fetch information about the conflicting conference for the given `conflict_id`. More info about this request can be found in the "Reading conference info" section. ###### HTTP 4xx Other response codes will cause conference creation failure. The JSON response can contain a `message` object which will be sent back to the client. For example `user1` tries to start a new conference by sending `conference` IQ to Jicofo. The system will reject the request. Client -> Jicofo: ``` ``` Prosody -> Reservation system: ``` POST /conference HTTP/1.1 content-type:application/x-www-form-urlencoded;charset=utf-8 host: http://reservation.example.com content-length: length name=testroom1&start_time=2048-04-20T17%3A55%3A12.000Z&mail_owner=client1%40xmpp.com ``` Reservation system -> Prosody: ``` HTTP/1.1 403 Forbidden Content-Type: application/json; charset=utf-8 Content-Length: length { "message": "client1 is not allowed to create the room at this time" } ``` Prosody -> Client: ``` client1 is not allowed to create the room at this time ``` The application can use `text` and `reservation-error` elements to provide meaningful information to the user. ##### Reading conference info In case of a `409` response to the `HTTP POST` request, Prosody will try to read information about the conflicting conference using an `HTTP GET` `/conference/{conflict_id}` endpoint. The response should provide all information about the conference stored in the reservation system: * `"id"`: conference identifier assigned by the reservation system * `"name"`: conference room name * `"mail_owner"`: identity of the user who has created the conference * `"start_time"`: conference start date and time * `"duration"`: scheduled conference duration in seconds The optional `max_occupants` value should also be provided if applicable. Sample response JSON body (contains the same info as `200 OK` to `HTTP POST`): ``` { "id": 364758328, "name": "conference1234", "mail_owner": "user@server.com", "start_time": "2048-04-20T17:55:12.000Z", "duration": 900000 } ``` ##### Deleting conference Prosody deletes conferences in the reservation system in two cases. First when all users leave XMPP Multi User Chat room. Secondly when the conference duration limit is exceeded. In the latter case Prosody will destroy the XMPP MUC room. After the MUC room is destroyed, Prosody sends an `HTTP DELETE` request to `'/conference/{id}'` endpoint where `{id}` is replaced with conference identifier assigned by the reservation system. ``` DELETE /conference/364758328 HTTP/1.1 host: http://reservation.example.com ... ``` #### Implementation diagram ![](https://raw.githubusercontent.com/jitsi/handbook/master/docs/assets/reservation-api.png) ================================================ FILE: docs/devops-guide/scalable.md ================================================ --- id: devops-guide-scalable title: DevOps Guide (scalable setup) sidebar_label: Scalable setup --- A single server Jitsi installation is good for a limited size of concurrent conferences. The first limiting factor is the videobridge component, that handles the actual video and audio traffic. It is easy to scale the video bridges horizontally by adding as many as needed. In a cloud based environment, additionally the bridges can be scaled up or down as needed. :::warning The [Youtube Tutorial on Scaling](https://www.youtube.com/watch?v=LyGV4uW8km8) is outdated and describes an old configuration method. The current default Jitsi Meet install is already configured for horizontal scalability. ::: :::note Building a scalable infrastructure is not a task for beginning Jitsi Administrators. The instructions assume that you have installed a single node version successfully, and that you are comfortable installing, configuring and debugging Linux software. This is not a step-by-step guide, but will show you, which packages to install and which configurations to change. It is highly recommended to use configuration management tools like Ansible or Puppet to manage the installation and configuration. ::: ## Architecture (Single Jitsi-Meet, multiple videobridges) A first step is to split the functions of the central jitsi-meet instance (with nginx, prosody and jicofo) and videobridges. A simplified diagram (with open network ports) of an installation with one Jitsi-Meet instance and three videobridges that are load balanced looks as follows. Each box is a server/VM. ``` + + | | | | v v 80, 443 TCP 443 TCP, 10000 UDP +--------------+ +---------------------+ | nginx | 5222 TCP | | | Jitsi Meet |<-------------------+| jitsi-videobridge | | prosody | | | | | jicofo | | +---------------------+ +--------------+ | | +---------------------+ | | | +----------+| jitsi-videobridge | | | | | +---------------------+ | | +---------------------+ | | | +----------+| jitsi-videobridge | | | +---------------------+ ``` ## Machine Sizing The Jitsi-Meet server will generally not have that much load (unless you have many) conferences going at the same time. A 4 CPU, 8 GB machine will probably be fine. The videobridges will have more load. 4 or 8 CPU with 8 GB RAM seems to be a good configuration. ### Installation of Jitsi-Meet Assuming that the installation will run under the following FQDN: `meet.example.com` and you have SSL cert and key in `/etc/ssl/meet.example.com.{crt,key}` Set the following DebConf variables prior to installing the packages. (We are not installing the `jitsi-meet` package which would handle that for us) Install the `debconf-utils` package ``` $ 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 ``` To enable integration with [Jitsi Meet Components](https://jaas.8x8.vc/#/components) for telephony support, set the `jitsi-meet/jaas-choice` option above to `true`. On the jitsi-meet server, install the following packages: * `nginx` * `prosody` * `jicofo` * `jitsi-meet-web` * `jitsi-meet-prosody` * `jitsi-meet-web-config` ### Installation of Videobridge(s) For simplicities sake, set the same `debconf` variables as above and install * `jitsi-videobridge2` ### Configuration of jitsi-meet #### Firewall Open the following ports: Open to world: * 80 TCP * 443 TCP Open to the videobridges only * 5222 TCP (for Prosody) #### NGINX Create the `/etc/nginx/sites-available/meet.example.com.conf` as usual #### Jitsi-Meet Adapt `/usr/share/jitsi-meet/config.js` and `/usr/share/jitsi-meet/interface-config.js` to your specific needs #### Jicofo No changes necessary from the default install. ### Configuration of the Videobridge #### Firewall Open the following ports: Open to world: * 10000 UDP (for media) #### jitsi-videobridge2 No changes necessary from the default setup. ## Testing After restarting all services (`prosody`, `jicofo` and all the `jitsi-videobridge2`) you can see in `/var/log/prosody/prosody.log` and `/var/log/jitsi/jicofo.log` that the videobridges connect to Prososy and that Jicofo picks them up. When a new conference starts, Jicofo picks a videobridge and schedules the conference on it. ================================================ FILE: docs/devops-guide/secure-domain.md ================================================ --- id: secure-domain title: Secure Domain Setup sidebar_label: Authentication (Secure Domain) - Deprecated --- :::note This method of authentication is deprecated and should not be used in new installations. It is recommended to use JWT authentication instead, as described in [Authentication](authentication.md). ::: It is possible to allow only authenticated users to create new conference rooms. Whenever a new room is about to be created, Jitsi Meet will prompt for a user name and password. After the room is created, others will be able to join from anonymous domain. Here's what has to be configured: ## Prosody configuration If you have installed Jitsi Meet from the Debian package, these changes should be made in `/etc/prosody/conf.avail/[your-hostname].cfg.lua` In the example below, this hostname is assumed to be `jitsi.example.com`. Update this value according to your own hostname. ### Enable authentication Inside the `VirtualHost "[your-hostname]"` section, replace anonymous authentication with hashed password authentication: ``` VirtualHost "jitsi.example.com" authentication = "internal_hashed" ``` You will see your own hostname instead of `jitsi.example.com` in your config file. ### Enable anonymous login for guests Add this section **after the previous VirtualHost** to enable the anonymous login method for guests: ``` VirtualHost "guest.jitsi.example.com" authentication = "jitsi-anonymous" c2s_require_encryption = false ``` _Note that `guest.jitsi.example.com` is internal to Jitsi, and you do not need to (and should not) create a DNS record for it, or generate an SSL/TLS certificate, or do any web server configuration. While it is internal, you should still replace `jitsi.example.com` with your hostname._ ## Jitsi Meet configuration In config.js, the `anonymousdomain` options has to be set. If you have installed jitsi-meet from the Debian package, these changes should be made in `/etc/jitsi/meet/[your-hostname]-config.js`. ``` var config = { hosts: { domain: 'jitsi.example.com', anonymousdomain: 'guest.jitsi.example.com', // ... }, // ... } ``` You will see your own hostname instead of `jitsi.example.com` in your config file. You should add only the `anonymousdomain` line. Be carefull of commas. ## Jicofo configuration When running Jicofo, specify your main domain in an additional configuration property. Jicofo will accept conference allocation requests only from the authenticated domain. This should go as a new `authentication` section in `/etc/jitsi/jicofo/jicofo.conf`: ``` jicofo { authentication: { enabled: true type: XMPP login-url: "jitsi.example.com" } } ``` Replace `jitsi.example.com` with your own hostname. Don't create a new `jicofo` section. Create the `authentication` section inside the existing `jicofo` section. ## Restart the services Restart prosody, jicofo and jitsi-videobridge2 as `root`. ``` systemctl restart prosody systemctl restart jicofo systemctl restart jitsi-videobridge2 ``` ## Create users in Prosody Finally, run `prosodyctl` to create a user in Prosody: ``` sudo prosodyctl register ``` For example: ``` sudo prosodyctl register myname jitsi.example.com mypassword123 ``` :::note Docker users may require an alternate config path. Users of the official [`jitsi/prosody`](https://github.com/jitsi/docker-jitsi-meet) image should invoke `prosodyctl` as follows. ``` prosodyctl --config /config/prosody.cfg.lua register meet.jitsi ``` Full documentation for `prosodyctl` can be found on [the official site](https://prosody.im/doc/prosodyctl). ::: ## Remove users from Prosody To remove an existing user: ``` sudo prosodyctl unregister ``` For example: ``` sudo prosodyctl unregister myname jitsi.example.com ``` ## Optional: Jigasi configuration ### Enable Authentication If you are using Jigasi, set it to authenticate by editing the following lines in `/etc/jitsi/jigasi/sip-communicator.properties`: ``` org.jitsi.jigasi.xmpp.acc.USER_ID=SOME_USER@SOME_DOMAIN org.jitsi.jigasi.xmpp.acc.PASS=SOME_PASS org.jitsi.jigasi.xmpp.acc.ANONYMOUS_AUTH=false ``` Note that the password is the actual plaintext password, not a base64 encoding. ### Debugging If you experience problems with a certificate chain, you may need to uncomment the following line, also in `sip-communicator.properties`: ``` net.java.sip.communicator.service.gui.ALWAYS_TRUST_MODE_ENABLED=true ``` :::note This should only be used for testing/debugging purposes, or in controlled environments. If you confirm that this is the problem, you should then solve it in another way (e.g. get a signed certificate for Prosody, or add the particular certificate to Jigasi’s trust store). ::: ================================================ FILE: docs/devops-guide/speakerstats.md ================================================ --- id: speakerstats title: Enabling Speaker Stats sidebar_label: Speaker Stats --- To enable the speaker stats we need to enable speakerstats module under the main virtual host, this is to enable the advertising the speaker stats component, which address needs to be specified in `speakerstats_component` option. We need to also enable the component with the address specified in `speakerstats_component`. The component needs also to have the option with the muc component address in `muc_component` option. ```lua VirtualHost "jitsi.example.com" speakerstats_component = "speakerstats.jitsi.example.com" modules_enabled = { "speakerstats"; } Component "speakerstats.jitsi.example.com" "speakerstats_component" muc_component = "conference.jitsi.example.com" Component "conference.jitsi.example.com" "muc" ``` ================================================ FILE: docs/devops-guide/token-authentication.md ================================================ --- id: token-authentication title: Token Authentication sidebar_label: Authentication (Token) --- It is possible to allow only users with a valid token to create new conference rooms. After the room is created, others will be able to join from anonymous domain. Here's what has to be configured: ## Token package Install `jitsi-meet-tokens` packages. ``` apt-get install jitsi-meet-tokens ``` Set `Application ID` and `Application Secret` when asked. This command will add `app_id` and `app_secret` into the Prosody config and set `authentication`. ## Prosody configuration If you have installed Jitsi Meet from the Debian package, the changes should be made in `/etc/prosody/conf.avail/[your-hostname].cfg.lua` In the example below, this hostname is assumed to be `jitsi.example.com`. After installing the package you will see the following lines in your Prosody config: ``` VirtualHost "jitsi.example.com" authentication = "token" app_id="myappid" app_secret="myappsecret" --- --- Component "conference.jitsi.example.com" "muc" --- --- modules_enabled = { --- --- "token_verification"; --- --- } ``` ### allow_empty_token Add `allow_empty_token` into `VirtualHost`: ``` VirtualHost "jitsi.example.com" authentication = "token" app_id="myappid" app_secret="myappsecret" allow_empty_token = true ``` ### persistent_lobby Add `persistent_lobby` as module into `VirtualHost`: ``` VirtualHost "jitsi.example.com" --- --- modules_enabled = { --- --- "muc_lobby_rooms"; "persistent_lobby"; ``` ### muc_wait_for_host Add `muc_wait_for_host` as module into `Component`: ``` Component "conference.jitsi.example.com" "muc" --- --- modules_enabled = { --- "token_verification"; "muc_wait_for_host"; } ``` ### Enable anonymous login for guests Add this section **after the previous VirtualHost** to enable the anonymous login method for guests: ``` VirtualHost "guest.jitsi.example.com" authentication = "jitsi-anonymous" c2s_require_encryption = false ``` _Note that `guest.jitsi.example.com` is internal to Jitsi, and you do not need to (and should not) create a DNS record for it, or generate an SSL/TLS certificate, or do any web server configuration. While it is internal, you should still replace `jitsi.example.com` with your hostname._ ## Jitsi Meet configuration In config.js, the `anonymousdomain` options has to be set. If you have installed jitsi-meet from the Debian package, these changes should be made in `/etc/jitsi/meet/[your-hostname]-config.js`. ``` var config = { hosts: { domain: 'jitsi.example.com', anonymousdomain: 'guest.jitsi.example.com', // ... }, // ... } ``` You will see your own hostname instead of `jitsi.example.com` in your config file. You should add only the `anonymousdomain` line. Be carefull of commas. ## Jicofo configuration No need to update anything in Jicofo config. Some out-dated documents recommend to enable the authentication in `jicofo.conf`. Don't do that. The authentication must be disabled in `jicofo.conf` when the `token` authentication is active. Simply keep `jicofo.conf` as it is without changing anything. ## Restart the services Restart prosody, jicofo and jitsi-videobridge2 as `root`. ``` systemctl restart prosody systemctl restart jicofo systemctl restart jitsi-videobridge2 ``` ================================================ FILE: docs/devops-guide/turn.md ================================================ --- id: turn title: Setting up TURN sidebar_label: TURN setup --- One-to-one calls should avoid going through the JVB for optimal performance and for optimal resource usage. This is why we've added the peer-to-peer mode where the two participants connect directly to each other. Unfortunately, a direct connection is not always possible between the participants. In those cases you can use a TURN server to relay the traffic (n.b. the JVB does much more than just relay the traffic, so this is not the same as using the JVB to "relay" the traffic). This document describes how to enable TURN server support in one-to-one calls in Jitsi Meet. Even though it gives some hints how to configure [prosody](https://prosody.im) and [coTURN](https://github.com/coturn/coturn), it assumes a properly configured TURN server, and a properly configured XMPP server. One way to configure TURN support in meet is with a static configuration. You can simply fill out the `p2p.stunServers` option with appropriate values, e.g.: ``` [ { urls: 'turn:turn.example.com1', username: 'user', credential: 'pass' }, ] ``` :::caution This technique doesn't require any special configuration on the XMPP server, but it exposes the credentials to your TURN server and other people can use your bandwidth freely, so while it's simple to implement, it's not recommended. ::: This [draft](https://tools.ietf.org/html/draft-uberti-behave-turn-rest-00) describes a proposed standard REST API for obtaining access to TURN services via ephemeral (i.e. time-limited) credentials. These credentials are vend by a web service over HTTP, and then supplied to and checked by a TURN server using the standard TURN protocol. The usage of ephemeral credentials ensures that access to the TURN server can be controlled even if the credentials can be discovered by the user. Jitsi Meet can fetch the TURN credentials from the XMPP server via [XEP-0215](https://xmpp.org/extensions/xep-0215.html) and this is configured by default using [mod_external_services](https://prosody.im/doc/modules/mod_external_services). The default configured turnserver uses the default ports for the protocol UDP 3478 and TCP(TLS) on 5349. ## Use TURN server on port 443 By default, TURN server listens on standard ports UDP 3478 and TCP 5349 (for TLS connections). There are certain corporate networks which allow only TCP connections using port 443(https) and to cover this kind of scenarios it is useful to have TURN server listening on port 443 for TLS connections. Here is how to run nginx and TURN server on the same machine sharing port. For this you will need a second DNS record for your turn domain pointing to the same machine (as a reference below we will use `turn-jitsi-meet.example.com`). - You need to enable the multiplexing based on that new DNS record. You need to create a file in `/etc/nginx/modules` or `/etc/nginx/modules-available`. If you are placing the file in `/etc/nginx/modules-available` you need to add a symlink in `/etc/nginx/modules-enabled`. The file content should be: ``` stream { map $ssl_preread_server_name $name { jitsi-meet.example.com web_backend; turn-jitsi-meet.example.com turn_backend; } upstream web_backend { server 127.0.0.1:4444; } upstream turn_backend { server __your_public_ip__:5349; } server { listen 443; listen [::]:443; # since 1.11.5 ssl_preread on; proxy_pass $name; # Increase buffer to serve video proxy_buffer_size 10m; } } ``` Make sure you edit the file and replace `jitsi-meet.example.com` with your domain of deployment, `turn-jitsi-meet.example.com` with the DNS name you will use for the TURN server and `__your_public_ip__` with your public IP of the deployment. If you have more virtual hosts make sure you add them here and do the port change for them (the next step). - Then go to `/etc/nginx/sites-available/your-conf` and change your virtual host to listen on port 4444 instead of 443. ``` server { listen 4444 ssl; listen [::]:4444 ssl; server_name jitsi-meet.example.com; ``` - Next you need to make sure Prosody is advertising the correct DNS name and port for the TURN server. You should edit the line using port `5349` in the file `/etc/prosody/conf.d/jitsi-meet.example.com.cfg.lua` and make it look like (change port and address): ``` { type = "turns", host = "turn-jitsi-meet.example.com", port = "443", transport = "tcp" } ``` - Now you need to make sure the TURN server (coturn) uses trusted certificates. Here is how to request those from Let's Encrypt (make sure you set correct values for the domain and email): ``` 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 ``` - After restarting prosody (`systemctl restart prosody`) you are good to go! ================================================ FILE: docs/devops-guide/video-sipgw.md ================================================ --- id: videosipgw title: Configuring a video SIP gateway sidebar_label: Video SIP gateway --- This document describes how you can configure jitsi-meet to use sipgw jibri and enable rooms in 'Add people dialog' You will need a working deployment of jibri configured to use a regular sip video device, for more info check out the [jibri documentation](https://github.com/jitsi/jibri/blob/master/README.md). This feature is available for non-guests of the system, so this relies on setting in config.js ``enableUserRolesBasedOnToken: true`` and providing a jwt token when accessing the conference. * Jicofo configuration: edit /etc/jitsi/jicofo/sip-communicator.properties (or similar), set the appropriate MUC to look for the Jibri Controllers. This should be the same MUC as is referenced in jibri's config.json file. Restart Jicofo after setting this property. ``` org.jitsi.jicofo.jibri.SIP_BREWERY=TheSipBrewery@conference.yourdomain.com ``` * Jitsi Meet configuration: - config.js: add ``` enableUserRolesBasedOnToken: true, peopleSearchQueryTypes: ['conferenceRooms'], peopleSearchUrl: 'https://api.yourdomain.com/testpath/searchpeople', ``` The combination of the above settings and providing a jwt token will enable a button under invite option which will show the dialog 'Add people'. ## People search service When searching in the dialog, a request for results is made to the `peopleSearchUrl` service. The request is in the following format: ``` https://api.yourdomain.com/testpath/searchpeople?query=testroomname&queryTypes=[%22conferenceRooms%22]&jwt=somejwt ``` The parameters are: - query - The text entered by the user. - queryTypes - What type of results we want people, rooms, conferenceRooms. This is the value from config.js `peopleSearchQueryTypes` - jwt - The token used by the user to access the conference. The response of the service is a json in the following format: ``` [ { "id": "address@sip.domain.com", "name": "Some room name", "type": "videosipgw" }, { "id": "address2@sip.domain.com", "name": "Some room name2", "type": "videosipgw" } ] ``` Type should be `videosipgw`, `name` is the name shown to the user and `id` is the sip address to be called by the sipgw jibri. ================================================ FILE: docs/devops-guide/videotutorials.md ================================================ --- id: devops-guide-videotutorials title: Video Tutorials --- ## [Installing Jitsi Meet on your own Linux Server](https://jitsi.org/news/new-tutorial-installing-jitsi-meet-on-your-own-linux-server/)
## [How to Load Balance Jitsi Meet](https://jitsi.org/blog/tutorial-video-how-to-load-balance-jitsi-meet/)
## [Scaling Jitsi Meet in the Cloud](https://jitsi.org/blog/new-tutorial-video-scaling-jitsi-meet-in-the-cloud/)
================================================ FILE: docs/faq.md ================================================ --- id: faq title: FAQ --- ## How to tell if my server instance is behind NAT? In general, if the tool ifconfig (or ipconfig) shows the assigned IPv4 address to be a private / local address (10.x.x.x, or 172.16.x.x - 172.31.x.x, or 192.168.x.x) but you know that its public IPv4 address is different from that, the server is most probably behind NAT. If you are hosting your server on a VPS, and you are not sure, ask your VPS provider's support team. ## Clients could communicate well in the room created at `meet.jit.si`. The same clients still could connect to my self-hosted instance but could neither hear nor see one another. What's wrong? Most probably, the server is behind NAT, but you haven't added the NAT-specific configuration. See this [resolved question](https://community.jitsi.org/t/cannot-see-video-or-hear-audio-on-self-hosted-instance/). You need to follow the steps detailed [here](devops-guide/devops-guide-quickstart#advanced-configuration). ## It works with two participants but crashes or does not work properly when a third joins P2P mode is working, but it fails when you are trying to pass traffic via jitsi-videobridge2. Check you've got your firewall / NAT set up correctly — especially UDP 10000. For more information, see [here](devops-guide/devops-guide-quickstart#setup-and-configure-your-firewall). ## Can I mute and unmute other participants? If you are the moderator of a conference, you can mute everyone's microphone. You cannot unmute other people's microphones, and they can unmute their microphones at any time. You may want to set some "ground rules" for who can talk and when, just as with any physical meeting or classroom. If you would like to limit who can become a moderator, you need to set up your instance of Jitsi and enable "secure domain". Please see [here](#4-enable-secure-domain-if-you-are-using-your-instance-of-jitsi) for more information. ## How can I protect my meetings with Jitsi? ### _1. Create a "strong" room name._ Use a strong room name, that no one else is likely to be using. Use the name generator on the welcome page, or else generate your own "strong" name. For example, on macOS, in the terminal, you can use `uuidgen` to generate a string of letters of numbers (e.g. B741B63E-C5E6-4D82-BAC4-048BE25D8CC7). Your room name would be `meet.jit.si/B741B63E-C5E6-4D82-BAC4-048BE25D8CC7` on the hosted `meet.jit.si` platform. If you use "test" or "LucysMeeting" "pilates" or similar, then it's highly likely that other users will have had the same idea. ### _2. Use a different room name for each meeting / conference you have._ If you are going to have multiple meetings, ideally use a different room name for each one. If that is not practical, at least use a different room name for each group of people. ### _3. Add a password to the room._ Once you have started your room, set a password for it. Only people who have the password can join from that point on, but it does not affect people who have already joined. You will need to tell everyone the password. If they give the password to others, those other people can also join. ### _4. Enable "secure domain" if you are using your instance of Jitsi._ In addition to the tips above, consider enabling the ["secure domain" configuration](https://jitsi.github.io/handbook/docs/devops-guide/secure-domain). This requires you (or someone else) to enter a username and password to open a room. It also allows you to become a moderator. ## It's working when I connect from a browser, but not from the iOS or Android apps This probably means that you are not serving the fullchain for your TLS certificate. You can check if your cert chain is properly configured [here](https://whatsmychaincert.com/). In nginx, if you are using Let's Encrypt, you should have a line like this: `ssl_certificate /etc/letsencrypt/live/jitsi.example.com/fullchain.pem;` ## Can I record and save the video? Yes. There are multiple methods (using external software, services or the embedded feature): #### Record using the native feature Jitsi offers the possiblity to record locally the video (with audio) of the room. When the recording is stopped (either manually or when the max size of the file is reached) the file (in webm format) is saved into the device storage. To configure the feature, for self-hosted instances, see information [here](dev-guide/dev-guide-configuration/#recording). #### Record using external software / services _Note_: If you want to use a privacy-friendly method, use method 1 or 2. 1. **OBS**: Use [OBS](https://obsproject.com/) to record your Session (e.g. your browser window). 2. **RTMP-Server**: For this you have to setup your own RTMP-Server and then use your RTMP URL + Stream key instead of the Youtube Stream key as described [here](https://jitsi.org/blog/live-streaming-with-jitsi-and-youtube/). Self-installed Jitsi Meet deployments will need to setup Jibri to do this. 3. **Dropbox**: [Connect to Dropbox with Jitsi Meet](/handbook/docs/dev-guide/dev-guide-web-integrations#creating-the-dropbox-app-for-dropbox-recording-integration) and save the video in the Dropbox. 4. **Video Services/Websites**: Stream your conference to YouTube or other sites (e.g. Twitch) and access the recording there (see [howto](https://jitsi.org/blog/live-streaming-with-jitsi-and-youtube/)). Self-installed Jitsi Meet deployments will need to setup Jibri to do this. ## I set the password in meeting but it is not working the next time Once the meeting ends it's password also gets removed, so you need to set the password again for next meeting. ## How to limit the number of participants? 1. Use the command `prosodyctl about` to view the version of prosody and plug directory, similar to the output below. ``` Prosody 0.11.6 # Prosody directories Data directory: /var/lib/prosody Config directory: /etc/prosody Source directory: /usr/lib/prosody Plugin directories: /usr/share/jitsi-meet/prosody-plugins/ /usr/lib/prosody/modules/ ``` 2. Check if there is a `mod_muc_max_occupants.lua` file in your plugin directory. If not, please create a new file `mod_muc_max_occupants.lua` in the plugin directory And copy everything from [here](https://github.com/jitsi/jitsi-meet/blob/master/resources/prosody-plugins/mod_muc_max_occupants.lua) to paste. If it exists, please ignore this step. 3.Edit your `/etc/prosody/conf.avail/meet.example.com.cfg.lua` file and add `muc_max_occupants` as a module_enabled in the conference.meet.example.com "muc" section. Then, add the options below that. You need both `muc_max_occupants` and `muc_access_whitelist` defined. Example: ``` Component "conference.meet.example.com" "muc" storage = "memory" modules_enabled = { "muc_meeting_id"; "muc_domain_mapper"; "muc_max_occupants"; } muc_max_occupants = "5" muc_access_whitelist = { "focus@auth.meet.example.com" } admins = { "focus@auth.meet.example.com" } muc_room_locking = false muc_room_default_public_jids = true ``` Note: the relationship between storage = "" and your prosody version, and you need to modify all storage="" . - Prosody nightly747 storage = "null" - Prosody 0.10 storage = "none" - Prosody 0.11 storage = "memory" 4. You need to use the command `prosodyctl restart` to see the effect. 5. If you want to update to use prosody, you can check [here](https://community.jitsi.org/t/how-to-how-do-i-update-prosody/72205). ## Other participants complain my screen sharing is very bright and appears washed out? You might have HDR streaming enabled in your OS display or graphic card settings. If you are on Windows, you can quickly toggle HDR on/off using `Win + Alt + B` for all your HDR-capable screens at any time, even while screen sharing. ================================================ FILE: docs/intro.md ================================================ --- id: intro title: Introduction --- ## What is Jitsi? Jitsi is a video conferencing platform. It is easy to use, easy to self-host, secure, state-of-the-art, and built from a [collection of Open Source projects](architecture.md). ## About this handbook This handbook aims to be the one-stop shop for all Jitsi documentation. :::note It's work in progress. If you want to help, please create a **Pull Request** in our [GitHub repository](https://github.com/jitsi/handbook)! ::: The content is divided into 3 main areas: * [User guide](/docs/category/user-guide): Designed to help users of the service, to better understand all the available features and how to use them. * [Developer guide](/docs/category/developer-guide): Designed to help developers who want to either integrate the Jitsi Meet API / SDK in their products or want to improve Jitsi Meet itself by developing new features or fixing bugs. * [Self-Hosting guide](devops-guide/devops-guide.md): Designed for folks wanting to self-host, system administrators or anyone who wishes to deploy and operate their own Jitsi Meet instance. ## JaaS customers Are you a JaaS customer? If so, please start [here](https://developer.8x8.com/jaas/docs/jaas-onboarding). ================================================ FILE: docs/releases.md ================================================ --- id: releases title: Releases --- :::tip Release notes for Jitsi Meet are kept [here](https://github.com/jitsi/jitsi-meet-release-notes). ::: import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; ### Apps | Android | Android (F-Droid) | iOS | |:-:|:-:|:-:| | [](https://play.google.com/store/apps/details?id=org.jitsi.meet) | [](https://f-droid.org/en/packages/org.jitsi.meet/) | [](https://itunes.apple.com/us/app/jitsi-meet/id1165103905) | ### Apps (beta) If you are feeling adventurous and want to get an early scoop of the features as they are being developed you can also sign up for our open beta testing here: | Android | iOS | |:-:|:-:| | [Play Store Beta](https://play.google.com/apps/testing/org.jitsi.meet) | [TestFlight](https://testflight.apple.com/join/isy6ja7S) ### SDKs | Android | iOS | | :--: | :--: | | [Maven repository](https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-android-sdk#use-pre-build-sdk-artifactsbinaries) | [CocoaPods](https://cocoapods.org/pods/JitsiMeetSDK) | Windows | macOS | GNU/Linux (AppImage) | GNU/Linux (Deb) | | :--: | :--: | :--: | :--: | | [Download](https://github.com/jitsi/jitsi-meet-electron/releases/latest/download/jitsi-meet.exe) | [Download](https://github.com/jitsi/jitsi-meet-electron/releases/latest/download/jitsi-meet.dmg) | [Download](https://github.com/jitsi/jitsi-meet-electron/releases/latest/download/jitsi-meet-x86_64.AppImage) | [Download](https://github.com/jitsi/jitsi-meet-electron/releases/latest/download/jitsi-meet-amd64.deb) | The desktop applications are based on Electron. For macOS, it is also available as a `brew` cask which can be installed using `brew install jitsi-meet`. ### Docker images See the Docker image releases [here](https://github.com/jitsi/docker-jitsi-meet/releases). ### Debian/Ubuntu packages * [`stable`](https://download.jitsi.org/stable/) ([instructions](https://jitsi.org/downloads/ubuntu-debian-installations-instructions/)) * [`testing`](https://download.jitsi.org/testing/) ([instructions](https://jitsi.org/downloads/ubuntu-debian-installations-instructions-for-testing/)) * [`nightly`](https://download.jitsi.org/unstable/) ([instructions](https://jitsi.org/downloads/ubuntu-debian-installations-instructions-nightly/)) ### Web frontend Latest stable release | [![release](https://img.shields.io/badge/release-latest-green.svg)](https://github.com/jitsi/jitsi-meet/releases/latest) | |---|---| Prebuilt [source builds](https://download.jitsi.org/jitsi-meet/src/) are also available. :::note Generally, you won't need to download this, as it's part of the Debian packages and Docker images already. ::: ================================================ FILE: docs/security.md ================================================ --- id: security title: Security --- This topic is relatively complex, so we created a post that covers it much more broadly here: https://jitsi.org/security ================================================ FILE: docs/user-guide/advanced.md ================================================ --- id: user-guide-advanced title: User Guide (advanced) sidebar_label: Advanced options --- There are some options to tweak the invitation link to unlock more features in Jitsi. The following parameters apply to the web, iframe and mobile version. All keys listed here are prefixed with `config.`. You pick a key, combine it with its value using `=` and link parameters with `&`, e.g. `#config.defaultLanguage=en&config.minParticipants=3`. ## Invitations These parameters affect how you can invite people either before or within a session. Key | Value | Effect ------------------------------- | ------ | ----------------------------------- `disableInviteFunctions` | `true` | disable invite function of the app `minParticipants` | `2` | override the minimum number of participants before starting a call `prejoinConfig.enabled` | `true` | show an intermediate page before joining to allow for adjustment of devices ## UI These parameters have an effect on the user interface. Key | Value | Effect ------------------------------- | ------ | ----------------------------------- `defaultLanguage` | `en` | change the UI default language `disableThirdPartyRequests` | `true` | generate avatars locally and disable third-party requests `enableDisplayNameInStats` | `true` | send display names of participants to analytics `enableEmailInStats` | `true` | send email (if available) to analytics `enableInsecureRoomNameWarning` | `true` | show a warning label if the room name is deemed insecure ## Video Use these parameters to influence the video of a session. Key | Value | Effect ------------------------------- | ------ | ----------------------------------- `desktopSharingFrameRate.min` | `5` | override the minimum framerate for desktop sharing `desktopSharingFrameRate.max` | `5` | override the maximum framerate for desktop sharing `startWithVideoMuted` | `true` | disable video when joining ## Audio Use these parameters to influence the audio of a session. Key | Value | Effect ------------------------------- | ------ | ----------------------------------- `disableAudioLevels` | `true` | disable audio statistics polling (thereby perhaps improving performance) `disableRemoteMute` | `true` | disable all muting operations of remote participants `startWithAudioMuted` | `true` | turn off audio input when joining `startSilent` | `true` | mute audio input and output ================================================ FILE: docs/user-guide/basic.md ================================================ --- id: user-guide-basic title: User Guide (basic) sidebar_label: Basic options --- Welcome to the user guide! Check back soon! ================================================ FILE: docs/user-guide/browsers.md ================================================ --- id: supported-browsers title: Supported Browsers --- ## Desktop browsers | Browser | Support | Versions | Notes | |---|:---:|:---:|---| | Chrome [^1] | ✅ | >= 72 | Best results with >= 96 | | Firefox | ✅ | >= 68 | Best results with >= 101 | | Safari | ✅ | >= 14 | Best results with >= 15, output device selection unsupported | | Edge | ✅ | >= 79 | Edge Legacy is unsupported | | Internet Explorer | ❌ | | | ## Mobile browsers ### Android | Browser | Support | Versions | Notes | |---|:---:|:---:|---| | Chrome [^1] | ✅ | | Same support as the desktop version | | Firefox | ✅ | | Same support as the desktop version | :::note For a better mobile experience (background support, Bluetooth support, etc.) we recommend using a native app instead. We provide a [native Android SDK](/handbook/docs/dev-guide/dev-guide-android-sdk). ::: ### iOS | Browser | Support | Versions | Notes | |---|:---:|:---:|---| | Chrome | ✅ | | Same support as Safari as they share the engine | | Firefox | ✅ | | Same support as Safari as they share the engine | | Safari | ✅ | >= 14.3 | Best results with 15.4 | | Edge | ✅ | | Same support as Safari as they share the engine | :::note On iOS all browsers share the same engine, Safari. As such all features and limitations on all iOS browsers are those of Safari. For a better mobile experience (background support, CallKit integration, etc.) we recommend using a native app instead. We provide a [native iOS SDK](/handbook/docs/dev-guide/dev-guide-ios-sdk). ::: [^1]: This also applies to all Chromium based browsers such as Brave, (current) Edge, Opera, Vivaldi and others. ================================================ FILE: docs/user-guide/client-connection-status-indicators.md ================================================ --- id: client connection status indicators title: Client Connection Status Indicators --- This document explains what the different connection quality indicators on the video thumbnails actually mean. ## GOOD * With video enabled, when the send bitrate for the video stream is at least 50% of the target bitrate expected for the stream. Please refer to the target bitrates table below. * With video disabled or screen sharing is in progress, when the downstream packet loss is less than 6%. ## NON-OPTIMAL * With video enabled, when the send bitrate for the video stream is at least 30% of the target bitrate expected for the stream. Please refer to the target bitrates table below. * With video disabled or screen sharing is in progress, when the downstream packet loss is between 6% and 8%. ## POOR * With video enabled, when the send bitrate for the video stream is at least 10% of the target bitrate expected for the stream. Please refer to the target bitrates table below. * With video disabled or screen sharing is in progress, when the downstream packet loss is between 8% and 12%. ## LOST * When the user stops receiving video for the remote endpoint even when the endpoint is not video muted and it is in LastN as indicated by the bridge’s LastNEndpointChangeEvent. * When the bridge sends an EndpointConnectivityStatusChangeEvent indicating that the remote endpoint is no longer active, i.e., when the bridge has not received media from the remote endpoint for more than 3 secs. ## GHOST/NINJA * When the user stops receiving video for the remote endpoint even when the endpoint is not video muted and it is not in LastN as indicated by the bridge’s LastNEndpointChangeEvent. This means that the bridge decided to suspend the video for this user. Bridge takes into consideration the available downlink bandwidth for the receiving endpoint and the number of video streams requested using the channelLast setting. ## Target bitrates expected for the video streams CodecType | 180p (in Kbps) | 360p (in Kbps) | 720p (in Kbps) ----------- | -------------- | -------------- | ------------------- VP8 | 200 | 500 | 1500 VP9 | 100 | 300 | 1200 ================================================ FILE: docs/user-guide/jitsi-meet-for-google-calendar.md ================================================ --- id: user-guide-jitsi-meet-for-google-calendar title: Jitsi Meet for Google Calendar sidebar_label: Jitsi Meet for Google Calendar --- Welcome to the user guide! Check back soon! ================================================ FILE: docs/user-guide/join-a-jitsi-meeting.md ================================================ --- id: user-guide-join-jitsi-meeting title: Join a Jitsi Meeting --- # Join by using a Jitsi link People can invite each other to Jitsi meetings by simply sending a link. 1. If you have received such an invite link from a trusted source, copy it into your browser's address bar and press Enter / Return. 2. Your browser may first ask you to grant microphone and/or camera access. If you trust the person who invited you, confirm this access request. Please refer to the browser's documentation for details (e.g. [Firefox](https://support.mozilla.org/kb/how-manage-your-camera-and-microphone-permissions#w_using-prompts-to-allow-or-block-camera-and-microphone-permissions-for-a-site), [Chrome](https://support.google.com/chrome/answer/2693767)). 3. If prompted, enter a name, which will be visible to other participants in the Jitsi Meeting room. 4. (Optional) Adjust the camera and/or microphone settings via the `v` dropdown menu items. 5. Click on `Join meeting`. 6. If your meeing is taking place on https://meet.jit.si and you are the first to join you will be asked to authenticate or wait for a moderator. You can authenticate with a Google, Facebook or GitHub account. ================================================ FILE: docs/user-guide/keyboard-shortcuts.md ================================================ --- id: keyboard-shortcuts title: Keyboard shortcuts --- * F - Show or hide video thumbnails * M - Mute or unmute your microphone * V - Start or stop your camera * A - Manage video quality * C - Open or close the chat * D - Switch between camera and screen sharing * P - Show or hide the participants pane * R - Raise or lower your hand * S - View or exit full screen * W - Toggle tile view * T - Show participants stats * Alt T - Send thumbs up reaction * Alt C - Send clap reaction * Alt L - Send laugh reaction * Alt O - Send surprised reaction * Alt B - Send boo reaction * Alt S - Send silence reaction * G - Toggle GIPHY menu * ? - Show or hide keyboard shortcuts * SPACE - Push to talk * 0 - Focus on your video * 1-9 - Focus on another person's video ================================================ FILE: docs/user-guide/share-a-jitsi-meeting.md ================================================ --- id: user-guide-share-a-jitsi-meeting title: Share a Jitsi Meeting sidebar_label: Share a Jitsi Meeting --- First, you need to [Join](https://jitsi.github.io/handbook/docs/user-guide/user-guide-join-jitsi-meeting) / [Start](https://jitsi.github.io/handbook/docs/user-guide/user-guide-start-a-jitsi-meeting) a Jitsi Meeting. Next: - Click on the **More actions** "..." Button. - Click on **Invite people**. - Select the desired option using which you want to share the meeting. ================================================ FILE: docs/user-guide/start-a-jitsi-meeting.md ================================================ --- id: user-guide-start-a-jitsi-meeting title: Start a Jitsi Meeting sidebar_label: Start a Jitsi Meeting --- ## Desktop or Mobile Browser 1. You need a browser (please note our separate information). 2. Open the browser and in the address bar type, for example "https://meet.jit.si" (without "") and press Enter. 3. The page opens as shown in the figure: ![screenshot 1](../assets/user_guide_start_meeting.png "screenshot 1") 4. Now enter a name for your conference (e.g. new meeting) in the "Start new meeting" field. Note: Please do not use any special characters, spaces or umlauts, as this can lead to problems. Note: Jitsi offers a functionality that automatically suggests names for the conferences. These can be overwritten. 5. Click the blue `Go` button. 6. The following window opens: ![screenshot 2](../assets/user_guide_join_meeting.png "screenshot 2") 7. It is possible that no picture of you will appear at first. To do this, the browser will ask you whether you want to allow camera access. Please confirm this by clicking on `allow` or `permit`. Sometimes you also have to click the camera button at the bottom of the screen first to activate the dialog for allowing camera access. Do the same with the microphone the first time you use Jitsi. 8. Now enter your display name in the "enter your name" field. 9. Click the blue `Join meeting` button. 10. If you are connecting to https://meet.jit.si and you are first participant you will be asked to either authenticate or wait for a moderator. You can authenticate with a Google, Facebook or GitHub account. 11. Have fun in your first conference. :::note If you do not see a video image of yourself, check the following points: The camera on your device is: - present (small lens at the top of the screen / an external webcam on the monitor), - activated (on some laptops you can actively switch the webcam on/off), - plugged in (only necessary for external webcams), - installed (some devices require the camera to be installed first). ::: :::note If you cannot transmit sound, check the following points: The microphone on your device is: - available (especially with desktop devices, a microphone is never actually integrated. Here you need an external microphone or headset, which you connect to the appropriate ports on your PC), - activated (on some laptops with an integrated microphone or headsets there is a switch to activate / deactivate the microphone), - plugged in (only necessary for external microphones), - installed (on some old computers the microphone must be installed). ::: ================================================ FILE: docs/user-guide/use-jitsi-meet-on-mobile.md ================================================ --- id: user-guide-jitsi-meet-on-mobile title: Use Jitsi Meet on Mobile sidebar_label: Use Jitsi Meet on Mobile --- When you Join a Jitsi Meeting using a Mobile Phone, there are always options to join the meeting using the Jitsi Meet App or Continue on the web. The most convenient option is to Join using the **Jitsi Meet App**. You can download and Join / Create Meetings using the App as follows: - Download the Jitsi Meet App for [Android](https://play.google.com/store/apps/details?id=org.jitsi.meet) / [iOS](https://apps.apple.com/us/app/jitsi-meet/id1165103905) / [F-Droid](https://f-droid.org/en/packages/org.jitsi.meet/) - Open the app. - Join / Create a Meeting. ================================================ FILE: docusaurus.config.js ================================================ module.exports = { title: "Jitsi Meet", tagline: "State-of-the-art video conferencing you can self-host.", url: "https://jitsi.github.io", baseUrl: "/handbook/", organizationName: "jitsi", projectName: "handbook", favicon: "img/favicon.svg", onBrokenLinks: "throw", onBrokenMarkdownLinks: "throw", presets: [ [ "@docusaurus/preset-classic", { docs: { showLastUpdateAuthor: false, showLastUpdateTime: true, editUrl: "https://github.com/jitsi/handbook/edit/master/", path: "docs", sidebarPath: require.resolve("./sidebars.js"), }, theme: { customCss: [require.resolve("./src/css/custom.css")], }, }, ], ], plugins: [ [ '@docusaurus/plugin-client-redirects', { redirects: [ { to: '/docs/category/user-guide', from: [ '/docs/user-guide', '/docs/user-guide/user-guide-start' ], }, { to: '/docs/category/developer-guide', from: [ '/docs/dev-guide', '/docs/dev-guide/dev-guide-start' ], }, { to: '/docs/devops-guide/', from: '/docs/devops-guide/devops-guide-start', }, ] } ] ], themeConfig: { prism: { additionalLanguages: ["java", "markdown", "bash", "gradle", "lua", "dart"], lang: { "shell": "bash" }, }, algolia: { appId: 'K2ODL876OV', apiKey: 'fc233b31ee025aa87cf553bd9e7ce9e9', indexName: 'jitsi', }, navbar: { title: "Jitsi Meet Handbook", logo: { src: "img/logo.svg", }, items: [ { to: "docs/intro", label: "Docs", position: "left", }, { to: "docs/category/sdks", label: "SDKs", position: "left", }, { to: "docs/releases", label: "Releases", position: "left", }, { href: "https://community.jitsi.org", label: "Community", position: "left", }, { href: "https://jaas.8x8.vc", label: "JaaS", position: "left", }, { href: 'https://github.com/jitsi', position: 'right', className: 'header-github-link', 'aria-label': 'GitHub repository', }, ], }, image: "img/undraw_online.svg", footer: { style: "dark", links: [ { title: "Docs", items: [ { label: "Introduction", to: "docs/intro", }, { label: "User Guide", to: "docs/category/user-guide", }, { label: "Developer Guide", to: "docs/category/developer-guide", }, { label: "Self-Hosting Guide", to: "docs/devops-guide", }, ], }, { title: "Community", items: [ { label: "Forum", href: "https://community.jitsi.org", }, { label: "Twitter", href: "https://twitter.com/jitsinews", }, ], }, { title: "More", items: [ { label: "Blog", href: "https://jitsi.org", }, { label: "GitHub", href: "https://github.com/jitsi", }, { label: "JaaS: Jitsi as a Service", href: "https://jaas.8x8.vc" }, ], }, ], logo: { alt: "8x8 Footer Logo", src: "img/8x8-copyright-icon.svg", href: "https://8x8.com", }, copyright: `Copyright © 8x8, Inc.`, }, }, }; ================================================ FILE: package.json ================================================ { "name": "@jitsi/handbook", "private": true, "scripts": { "examples": "docusaurus-examples", "start": "docusaurus start", "build": "docusaurus build", "serve": "docusaurus serve", "publish-gh-pages": "docusaurus-publish", "write-translations": "docusaurus-write-translations", "version": "docusaurus-version", "rename-version": "docusaurus-rename-version", "swizzle": "docusaurus swizzle", "deploy": "docusaurus deploy", "docusaurus": "docusaurus" }, "dependencies": { "@docusaurus/core": "3.5.2", "@docusaurus/plugin-client-redirects": "3.5.2", "@docusaurus/preset-classic": "3.5.2", "@mdx-js/react": "3.0.1", "clsx": "2.1.1", "prism-react-renderer": "2.4.0", "react": "18.3.1", "react-dom": "18.3.1" } } ================================================ FILE: sidebars.js ================================================ module.exports = { docs: [ { type: "category", label: "Getting Started", items: [ "intro", "architecture", "security", "faq", ], }, { type: "category", label: "Community", link: { type: "doc", id: "community/community-intro", }, items: [ "community/third-party-software", ], }, { type: "category", label: "User Guide", link: { type: "generated-index", }, items: [ "user-guide/supported-browsers", "user-guide/user-guide-join-jitsi-meeting", "user-guide/user-guide-start-a-jitsi-meeting", "user-guide/user-guide-share-a-jitsi-meeting", "user-guide/user-guide-jitsi-meet-on-mobile", "user-guide/user-guide-jitsi-meet-for-google-calendar", "user-guide/keyboard-shortcuts", "user-guide/user-guide-basic", "user-guide/user-guide-advanced", ], }, { type: "category", label: "Developer Guide", link: { type: "generated-index", }, items: [ "dev-guide/dev-guide-contributing", { type: "category", label: "SDKs", link: { type: "generated-index", }, items: [ "dev-guide/dev-guide-iframe", "dev-guide/dev-guide-ljm-api", "dev-guide/dev-guide-electron-sdk", "dev-guide/dev-guide-react-sdk", "dev-guide/dev-guide-android-sdk", "dev-guide/dev-guide-ios-sdk", "dev-guide/dev-guide-react-native-sdk", "dev-guide/dev-guide-flutter-sdk", ] }, { type: "category", label: "Web", link: { type: "generated-index", }, items: [ "dev-guide/dev-guide-web-jitsi-meet", "dev-guide/dev-guide-ljm", "dev-guide/dev-guide-web-integrations", { type: "category", label: "IFrame API", link: { type: "doc", id: "dev-guide/dev-guide-iframe", }, items: [ "dev-guide/dev-guide-iframe-functions", "dev-guide/dev-guide-iframe-commands", "dev-guide/dev-guide-iframe-events" ] }, "dev-guide/dev-guide-react-sdk", "dev-guide/dev-guide-ljm-api", "dev-guide/dev-guide-windows", ], }, { type: "category", label: "Mobile", link: { type: "generated-index", }, items: [ "dev-guide/dev-guide-mobile-jitsi-meet", "dev-guide/mobile-feature-flags", "dev-guide/dev-guide-android-sdk", "dev-guide/dev-guide-ios-sdk", "dev-guide/dev-guide-react-native-sdk", "dev-guide/dev-guide-flutter-sdk", ], }, "dev-guide/dev-guide-configuration", ], }, { type: "category", label: "Self-Hosting Guide", link: { type: "doc", id: "devops-guide/devops-guide-start", }, items: [ { type: "category", label: "Deployment", link: { type: "generated-index", }, items: [ "devops-guide/devops-guide-requirements", "devops-guide/devops-guide-quickstart", "devops-guide/devops-guide-opensuse", { type: "category", label: "Docker", link: { type: "doc", id: "devops-guide/devops-guide-docker", }, items: [ { type: "doc", id: "devops-guide/devops-guide-log-analyser", label: "Log Analyser", }, ], }, "devops-guide/devops-guide-region" ], }, { type: "category", label: "Configuration", link: { type: "generated-index", }, items: [ "devops-guide/authentication", "devops-guide/secure-domain", "devops-guide/token-authentication", "devops-guide/ldap-authentication", "devops-guide/devops-guide-scalable", "devops-guide/reservation", "devops-guide/turn", "devops-guide/speakerstats", "devops-guide/videosipgw", "devops-guide/cloud-api", "devops-guide/file-sharing" ], }, "devops-guide/devops-guide-videotutorials", "devops-guide/faq", ], }, ], "releases-sidebar": [ { type: "doc", label: "Releases", id: "releases", }, ], }; ================================================ FILE: src/css/custom.css ================================================ :root { --ifm-color-primary-lightest: #3897e0; --ifm-color-primary-lighter: #2188d6; --ifm-color-primary-light: #2082cd; --ifm-color-primary: #1d76ba; --ifm-color-primary-dark: #1a6aa7; --ifm-color-primary-darker: #19649e; --ifm-color-primary-darkest: #145382; } .header-github-link:hover { opacity: 0.6; } .header-github-link::before { content: ""; width: 24px; height: 24px; display: flex; background: url("data:image/svg+xml,%3Csvg viewBox='0 0 24 24' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath d='M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12'/%3E%3C/svg%3E") no-repeat; } [data-theme="dark"] .header-github-link::before { background: url("data:image/svg+xml,%3Csvg viewBox='0 0 24 24' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath fill='white' d='M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12'/%3E%3C/svg%3E") no-repeat; } @media only screen and (min-device-width: 360px) and (max-device-width: 736px) { } @media only screen and (min-width: 1024px) { } @media only screen and (max-width: 1023px) { } @media only screen and (min-width: 1400px) { } @media only screen and (min-width: 1500px) { } .video-container { height: 0; margin: 0; margin-bottom: 30px; overflow: hidden; padding-bottom: 56.25%; padding-top: 30px; position: relative; } .video-container iframe { position: absolute; top: 0; left: 0; width: 100%; height: 100%; } img[alt="ios-screensharing"] { display: inline; } ================================================ FILE: src/pages/help.md ================================================ # Getting help Jitsi is maintained by a dedicated group of enthusiasts. If you need help with Jitsi [our community](https://community.jitsi.org) is the best place to start. You can learn more about using Jitsi or developing applications with it by browsing our [docs](/handbook/docs/intro). ================================================ FILE: src/pages/index.js ================================================ import React from "react"; import clsx from "clsx"; import Layout from "@theme/Layout"; import Link from "@docusaurus/Link"; import useDocusaurusContext from "@docusaurus/useDocusaurusContext"; import useBaseUrl from "@docusaurus/useBaseUrl"; import styles from "./styles.module.css"; const features = [ { title: <>Hey there Fellow Jitster!, imageUrl: "img/undraw_code_review.svg", description: ( <> Jitsi Meet is a set of Open Source projects which empower users to deploy secure, scalable and easy to use video conferencing platforms with state-of-the-art video quality and features.

On This site you'll find documentation for all your Jitsi needs.

Get started here. ), }, { title: <>Batteries included, imageUrl: "img/undraw_real_time_sync.svg", description: ( <> Jitsi Meet supports all common browsers and also mobile devices.

Our APIs allow developers to easily integrate Jitsi Meet into existing applications, whether those are web based or native mobile apps.

You can use our freely available instance at{" "} meet.jit.si {" "} or self-host it yourself using our readily available Debian packages or comprehensive Docker setup. ), }, { title: <>JaaS: Jitsi as a Service, imageUrl: "img/undraw_going_up.svg", description: ( <> Looking for configuration flexibility without the complexity of self-hosting and scalability management?

Look no further than JaaS. 8x8 Jitsi as a Service (JaaS) is an enterprise-ready video meeting platform that allows developers, organizations and businesses to easily build and deploy video solutions. With Jitsi as a Service we now give you all the power of Jitsi running on our global platform so you can focus on building secure and branded video experiences.

Check JaaS out{" "} here . ), }, ]; function VideoContainer() { return (

What is Jitsi?