Skip to content

Latest commit

 

History

History
203 lines (134 loc) · 7.23 KB

README.md

File metadata and controls

203 lines (134 loc) · 7.23 KB
Raw

Jitsi Meet Electron

Desktop application for Jitsi Meet built with Electron.

Features

  • End-to-End Encryption support (BETA)
  • Works with any Jitsi Meet deployment
  • Builtin auto-updates
  • Screensharing (Windows, Mac, X11 only. Not supported under Wayland, see known issues below)
  • Remote control (currently disabled due to security issues)
  • Always-On-Top window
  • Support for deeplinks such as jitsi-meet://myroom (will open myroom on the configured Jitsi instance) or jitsi-meet://jitsi.mycompany.com/myroom (will open myroom on the Jitsi instance running on jitsi.mycompany.com)

Installation

Download our latest release and you're off to the races!

Windows macOS GNU/Linux (AppImage) GNU/Linux (Deb)
Download Download x64_64 arm64 x86_64 arm64

Third-Party builds

Download On Flathub

Homebrew

For macOS user, you can install the application using the following command:

brew install --cask jitsi-meet

Development

If you want to hack on this project, here is how you do it.

Show building instructions

Installing dependencies

Install Node.js 20 first (or if you use nvm, switch to Node.js 20 by running nvm use).

Extra dependencies for Windows 
npm install --global --production windows-build-tools
Extra dependencies for GNU/Linux

X11, PNG, and zlib development packages are necessary. On Debian-like systems, they can be installed as follows:

sudo apt install libx11-dev zlib1g-dev libpng-dev libxtst-dev

Install all required packages:

npm install

Starting in development mode

npm start

The debugger tools are available when running in dev mode, and can be activated with keyboard shortcuts as defined here.

They can also be displayed automatically with the application --show-dev-tools command line flag, or with the SHOW_DEV_TOOLS environment variable as shown:

SHOW_DEV_TOOLS=true npm start

Building the production distribution

npm run dist

Working with jitsi-meet-electron-sdk

jitsi-meet-electron-sdk is a helper package which implements many features such as remote control and the always-on-top window. If new features are to be added or tested, running with a local version of these utils is very handy.

By default, the @jitsi/electron-sdk is build from npm. The default dependency path in package.json is:

"@jitsi/electron-sdk": "^3.0.0"

To work with a local copy, you must change the path to:

"@jitsi/electron-sdk": "file:///Users/name/jitsi-meet-electron-sdk-copy",

To build the project, you must force it to take the sources, as npm update will not do it.

npm install @jitsi/electron-sdk --force

NOTE: Also check the jitsi-meet-electron-sdk README to see how to configure your environment.

Publishing

  1. Create release branch: git checkout -b release-1-2-3, replacing 1-2-3 with the desired release version
  2. Increment the version: npm version patch, replacing patch with minor or major as required
  3. Push release branch to github: git push -u origin release-1-2-3
  4. Create PR: gh pr create
  5. Once PR is reviewed and ready to merge, create draft Github release: gh release create v1.2.3 --draft --title 1.2.3, replacing v1.2.3 and 1.2.3 with the desired release version
  6. Merge PR
  7. Github action will build binaries and attach to the draft release
  8. Test binaries from draft release
  9. If all tests are fine, publish draft release

Known issues

Windows

A warning that the app is unsigned will show up upon first install. This is expected.

macOS

None

GNU/Linux

  • If you can't execute the file directly after downloading it, try running chmod u+x ./jitsi-meet-x86_64.AppImage

  • Under wayland, screensharing is currently buggy:

    • Sharing a full screen is not possible
    • When trying to start screensharing under wayland, 2 permission popups will show up. First a pipewire based system selector, then a jitsi internal selector. Select an application window in the first selector and then the same in the jitsi internal selector. Sharing application windows works via this, sharing a full screen unfortunately not.

  • On Ubuntu 22.04 and later, the AppImage will fail with a fuse error (as the AppImage uses libfuse2, while 22.04 comes with libfuse3 by default):

    dlopen(): error loading libfuse.so.2

    To fix this, install libfuse2 as follows:

    sudo apt install libfuse2

  • On Ubuntu 24.04 and later, the AppImage will fail with a sandboxing error (The SUID sandbox helper binary was found, but is not configured correctly...) This is due to AppArmor conflicting by restricting unprivileged user namespaces (#965, Ubuntu blog post).

    To workaround this, disable the use of the sandbox with --no-sandbox:

    ./jitsi-meet-x86_64.AppImage --no-sandbox

  • If you experience a blank page after jitsi server upgrades, try removing the local cache files:

    rm -rf ~/.config/Jitsi\ Meet/

Translations

The JSON files are for all the strings inside the application, and can be translated here.

New translations require the addition of a line in index.js.

Localize desktop file on linux requires the addition of a line in package.json. Please search for Comment[hu] as an example to help add your translation of the English string Jitsi Meet Desktop App for your language.

License

Apache 2. See the LICENSE file.

Community

Jitsi is built by a large community of developers. If you want to participate, please join the community forum.