No description
  • TypeScript 94.8%
  • CSS 4.1%
  • JavaScript 0.4%
  • Shell 0.3%
  • HTML 0.2%
Find a file
Jan Kraus 279341ffee
Some checks failed
build-element-call.yaml / change codec to vp9 (push) Failing after 0s
deploy-to-netlify.yaml / change codec to vp9 (push) Failing after 0s
translations-download.yaml / change codec to vp9 (push) Failing after 0s
Build / build_sdk_element_call (push) Has been cancelled
Build & publish embedded packages for releases / Versioning (push) Has been cancelled
Build / build_full_element_call (push) Has been cancelled
Build / deploy_develop (push) Has been cancelled
Build / docker_for_develop (push) Has been cancelled
Build / build_embedded_element_call (push) Has been cancelled
Build / Build Storybook (push) Has been cancelled
Build / Build Element Call (push) Has been cancelled
Build / Build & publish docker (push) Has been cancelled
Build / Build Element Call-1 (push) Has been cancelled
Build / Build Element Call-2 (push) Has been cancelled
Build & publish embedded packages for releases / build_element_call (push) Has been cancelled
Build & publish embedded packages for releases / Publish tarball (push) Has been cancelled
Build & publish embedded packages for releases / Publish NPM (push) Has been cancelled
Build & publish embedded packages for releases / Publish Android AAR (push) Has been cancelled
Build & publish embedded packages for releases / Publish SwiftPM Library (push) Has been cancelled
Build & publish embedded packages for releases / Update release notes (push) Has been cancelled
Test / Run unit tests (push) Has been cancelled
Test / Run end-to-end tests (push) Has been cancelled
Upload translation files to Localazy / upload (push) Has been cancelled
GitHub Actions Security Analysis with zizmor 🌈 / Run zizmor 🌈 (push) Has been cancelled
change codec to vp9
2026-07-26 04:08:04 +02:00
.githooks update linking realted logic 2026-04-21 16:06:51 +02:00
.github Merge branch 'livekit' into johannes/docker-compose-renovate 2026-07-09 14:03:18 +02:00
.storybook fix tests dep optimization issues 2026-05-11 19:50:32 +02:00
.vscode Apply Prettier to the entire project 2022-12-09 14:34:25 -05:00
backend devx: Allow to run local dev EC on mobile in same wifi 2026-05-18 13:25:56 +02:00
config Update config.sample.json 2026-06-26 13:30:19 +02:00
docs Add URL param to control background style 2026-06-30 16:29:20 +02:00
embedded Switch from prettier to oxfmt 2026-06-17 12:20:42 +02:00
eslint fmt 2026-07-07 19:52:50 +02:00
locales delint 2026-07-20 17:03:55 +02:00
playwright Update ghcr.io/element-hq/element-web:develop Docker digest to 07ccf47 (#4111) 2026-07-15 14:34:34 +00:00
public Vite embedded build of Element Call (#3077) 2025-03-12 17:00:44 +00:00
scripts update linking realted logic 2026-04-21 16:06:51 +02:00
sdk fmt 2026-07-07 19:52:50 +02:00
src change codec to vp9 2026-07-26 04:08:04 +02:00
.dockerignore Add CI 2021-12-20 16:59:39 +00:00
.env.example Adopt the Compound color system 2023-08-28 17:14:40 -04:00
.gitignore Add back our custom linking plugins to pnpm 2026-04-20 16:59:34 +02:00
.node-version Update Node.js to v24 2025-11-05 18:49:21 +00:00
.oxfmtrc.json Switch from prettier to oxfmt 2026-06-17 12:20:42 +02:00
.oxlintrc.json Add lint rule to make sure future child loggers are setup correctly 2026-07-07 19:34:03 +02:00
.postcssrc.json Add automatic css prefixing 2021-10-14 17:41:59 -07:00
codecov.yaml test: Enable quality gate and touch a file 2025-11-26 19:13:07 +01:00
CONTRIBUTING.md add max reply SLA 2026-04-30 13:14:13 +02:00
demo.gif update Element Call screenshot 2025-03-17 09:55:04 +01:00
docker-compose-dev.yml Make renovate track docker-compose files and pin synapse / element-web for playwright tests 2026-07-03 08:48:28 +02:00
docker-compose-playwright.yml Update ghcr.io/element-hq/element-web:develop Docker digest to 07ccf47 (#4111) 2026-07-15 14:34:34 +00:00
Dockerfile Build Docker image on slim base (#3204) 2025-06-06 12:04:57 -04:00
i18next.config.ts Replace deprecated i18next-parser with i18next-cli 2026-06-08 15:32:34 +02:00
index.html Merge pull request #3905 from manfrommedan/fix/promise-withresolvers-polyfill 2026-06-02 19:43:12 +08:00
knip.ts Create service interruptions view model 2026-07-14 12:02:36 +02:00
LICENSE-AGPL-3.0 dual license AGPL + Commercial (#2984) 2025-02-05 16:01:51 +00:00
LICENSE-COMMERCIAL Fix typo in license filename 2025-02-06 12:52:11 +00:00
localazy.json Rename en-GB language to en (#2866) 2024-12-04 14:51:29 +00:00
package.json Make renovate track docker-compose files and pin synapse / element-web for playwright tests 2026-07-03 08:48:28 +02:00
playwright.config.ts Posthog add reconnect event (#3953) 2026-05-14 23:07:02 +02:00
pnpm-lock.yaml Resolve most existing Dependbot warnings 2026-07-15 18:05:06 +02:00
pnpm-workspace.yaml Resolve most existing Dependbot warnings 2026-07-15 18:05:06 +02:00
README.md Make renovate track docker-compose files and pin synapse / element-web for playwright tests 2026-07-03 08:48:28 +02:00
renovate.json Add additional renovate packageGroup for element-web 2026-07-09 13:20:57 +02:00
tsconfig.json Switch from eslint to oxlint 2026-06-23 15:13:46 +02:00
vite-embedded.config.ts Make convert remaining js config files to ts 2025-08-04 19:09:37 +02:00
vite-sdk.config.ts copyright. 2025-12-23 12:48:54 +01:00
vite.config.ts Merge branch 'livekit' into valere/devx/run_dev_on_phone 2026-05-28 13:17:22 +02:00
vitest.config.ts Use vitest's default for scoped class names 2026-07-08 17:03:51 +02:00
WIDGET_TEST.md fixup some missing yarn -> pnpm transitions 2026-04-21 10:53:56 +02:00

Element Call

Chat Localazy License Codecov

🎬 Live Demo 🎬

The world's first 🌐 decentralized and 🤝 federated video conferencing solution powered by the Matrix protocol.

📌 Overview

Element Call is a native Matrix video conferencing application developed by Element, designed for secure, scalable, privacy-respecting, and decentralized video and voice calls over the Matrix protocol. Built on MatrixRTC (MSC4143), it utilizes MSC4195 with LiveKit as its backend.

A demo of Element Call with six people

You can find the latest development version continuously deployed to call.element.dev.

Note

For prior version of the Element Call that relied solely on full-mesh logic, check full-mesh branch.

Key Features

Decentralized & Federated No central authority; works across Matrix homeservers.
End-to-End Encrypted Secure and private calls.
Standalone & Widget Mode Use as an independent app or embed in Matrix clients.
WebRTC-based No additional software required.
Scalable with LiveKit Supports large meetings via SFU (MSC4195: MatrixRTC using LiveKit backend).
Raise Hand Participants can signal when they want to speak, helping to organize the flow of the meeting.
Emoji Reactions Users can react with emojis 👍 🎉 👏 🤘, adding engagement and interactivity to the conversation.

🚀 Deployment & Packaging Options

Element Call is developed using the Matrix js-sdk with Matroska mode. This allows the app to run either as a Standalone App directly connected to a homeserver with login interfaces or it can be used as a widget within a Matrix client.

🖥️ Standalone Mode

Element Call in Standalone Mode

In Standalone mode, Element Call operates as an independent, full-featured video conferencing web application, enabling users to join or host calls without requiring a separate Matrix client.

📲 In-App Calling (Widget Mode in Messenger Apps)

When used as a widget 🧩, Element Call is solely responsible for the core calling functionality (MatrixRTC). Authentication, event handling, and room state updates (via the Client-Server API) are handled by the hosting client. Communication between Element Call and the client is managed through the widget API.

Element Call in Widget Mode

Element Call can be embedded as a widget inside apps like Element Web or Element X (iOS, Android), bringing MatrixRTC capabilities to messenger apps for seamless decentralized video and voice calls within Matrix rooms.

Important

Embedded packaging is recommended for Element Call in widget mode!

📦 Element Call Packaging

Element Call offers two packaging options: one for standalone or widget deployment, and another for seamless widget-based integration into messenger apps. Below is an overview of each option.

Full Package Supports both Standalone and Widget mode. It is hosted as a static web page and can be accessed via a URL when used as a widget.

Element Call Full Package

Embedded Package Designed specifically for Widget mode only. It is bundled with a messenger app for seamless integration and this is the recommended method for embedding Element Call.

Element Call Embedded Package

For more details on the packages, see the Embedded vs. Standalone Guide.

🛠️ Self-Hosting

For operating and deploying Element Call on your own server, refer to the Self-Hosting Guide.

🧭 MatrixRTC Backend Discovery and Selection

For proper Element Call operation each site deployment needs a MatrixRTC backend setup as outlined in the Self-Hosting Guide. A typical federated site deployment for three different sites A, B and C is depicted below.

Element Call federated setup

Backend Discovery

The MatrixRTC backend (according to MSC4143) is announced by the Matrix site's .well-known/matrix/client file and discovered via the org.matrix.msc4143.rtc_foci key, e.g.:

"org.matrix.msc4143.rtc_foci": [
    {
        "type": "livekit",
        "livekit_service_url": "https://matrix-rtc.example.com/livekit/jwt"
    },
]

where the format for MatrixRTC using LiveKit backend is defined in MSC4195. In the example above Matrix clients do discover a focus of type livekit which points them to a MatrixRTC Authorization Service via livekit_service_url.

Backend Selection

  • Each call participant proposes their discovered MatrixRTC backend from org.matrix.msc4143.rtc_foci in their org.matrix.msc3401.call.member state event.
  • For the LiveKit MatrixRTC backend (MSC4195), the first participant who joined the call defines which backend will be used for this call via the foci_preferred key in their org.matrix.msc3401.call.member state event.
  • During the actual call join flow, the MatrixRTC Authorization Service provides the client with the LiveKit SFU WebSocket URL and an access JWT token in order to exchange media via WebRTC.

The example below illustrates how backend selection works across Matrix federation, using the setup from sites A, B, and C. It demonstrates backend selection for Matrix rooms 123 and 456, which include users from different homeservers.

Element Call SFU selection over Matrix federation

🌍 Translation

If you'd like to help translate Element Call, head over to Localazy. You're also encouraged to join the Element Translators space to discuss and coordinate translation efforts.

🛠️ Development

Dependencies

  • Node.js (e.g. via nvm)
  • Corepack (not bundled with Node.js anymore starting from 25.0.0)
  • Docker client and runtime + Docker Compose (for the backend)
    • On macOS you can install everything with brew install colima docker docker-compose

Frontend

To get started clone and set up this project:

git clone https://github.com/element-hq/element-call.git
cd element-call
corepack enable
pnpm install

To use it, create a local config by, e.g., cp ./config/config.devenv.json ./public/config.json and adapt it if necessary. The config.devenv.json config should work with the backend development environment as outlined in the next section out of box.

You're now ready to launch the development server:

pnpm dev

See also:

Backend

A docker compose file docker-compose-dev.yml is provided to start the whole stack of components which is required for a local development environment including federation:

  • Minimum Synapse Setup (servernames: synapse.m.localhost, synapse.othersite.m.localhost)
  • MatrixRTC Authorization Service (Note: requires Federation API and hence a TLS reverse proxy)
  • Minimum LiveKit SFU setup using dev defaults for config
  • Minimum localhost Certificate Authority (CA) for Transport Layer Security (TLS)
  • Minimum TLS reverse proxy for
    • Synapse homeserver: synapse.m.localhost and synapse.othersite.m.localhost
    • MatrixRTC backend: matrix-rtc.m.localhost and matrix-rtc.othersite.m.localhost
    • Local Element Call development call.m.localhost via pnpm dev --host
    • Element Web app.m.localhost and app.othersite.m.localhost
    • Note certificates will expire on Thr, 20 September 2035 14:27:35 CEST

These use a test 'secret' published in this repository, so this must be used only for local development and never be exposed to the public Internet.

Make sure your Docker runtime is running (e.g. via colima start) and then start the backend components:

pnpm backend
# or for podman-compose:
# podman-compose -f docker-compose-dev.yml up

Note

To ensure your local development frontend functions properly, youll need to add certificate exceptions in your browser for https://localhost:3000, https://matrix-rtc.m.localhost/livekit/jwt/healthz and https://synapse.m.localhost/.well-known/matrix/client. This can be either done by adding the minimum localhost CA (./backend/dev_tls_local-ca.crt) to your web browser's trusted certificates or by simply copying and pasting each URL into your browsers address bar and follow the prompts to add the exception.

Updating snapshots

To update snapshots used in tests, use Vitest's -u flag, e.g.:

pnpm test DeveloperSettingsTab -u

Playwright tests

Our Playwright tests run automatically as part of our CI along with our other tests, on every pull request.

You may need to follow instructions to set up your development environment for running Playwright by following https://playwright.dev/docs/browsers#install-browsers and https://playwright.dev/docs/browsers#install-system-dependencies.

However the Playwright tests are run, an element-call instance must be running on https://localhost:3000 (this is configured in playwright.config.ts) - this is what will be tested.

The local backend environment should be running for the test to work: pnpm backend

There are a few different ways to run the tests yourself. The simplest is to run:

pnpm run test:playwright

This will run the Playwright tests once, non-interactively.

There is a more user-friendly way to run the tests in interactive mode:

pnpm run test:playwright:open

The easiest way to develop new test is to use the codegen feature of Playwright:

npx playwright codegen

This will record your action and write the test code for you. Use the tool bar to test visibility, text content and clicking.

Investigate a failed test from the CI

In the failed action page, click on the failed job, then scroll down to the upload-artifact step. You will find a link to download the zip report, as per:

Artifact playwright-report has been successfully uploaded! Final size is 1360358 bytes. Artifact ID is 2746265841
Artifact download URL: https://github.com/element-hq/element-call/actions/runs/13837660687/artifacts/2746265841

Unzip the report then use this command to open the report in your browser:

npx playwright show-report ~/Downloads/playwright-report/

Under the failed test there is a small icon looking like "3 columns" (next to the test name file name), click on it to see the live screenshots/console output.

Test Coverage

Add a new translation key

To add a new translation key you can do these steps:

  1. Add the new key entry to the code where the new key is used: t("some_new_key")

  2. Run pnpm i18n to extract the new key and update the translation files. This will add a skeleton entry to the locales/en/app.json file:

    {
        ...
        "some_new_key": "",
        ...
    }
    
  3. Update the skeleton entry in the locales/en/app.json file with the English translation:

    {
        ...
        "some_new_key": "Some new key",
        ...
    }
    

📖 Documentation

Usage and other technical details about the project can be found here:

Docs

GitHub Labels

GitHub labels in this repository are maintained in the labels.yml file and automatically synced to GitHub using the sync-labels workflow. We do this so that we can reuse the labels between repositories.

Warning

Do not manually edit labels in the GitHub UI. Any manual changes will be overridden by the workflow on its next invocation.

Copyright 2021-2025 New Vector Ltd

This software is dual-licensed by New Vector Ltd (Element). It can be used either:

(1) for free under the terms of the GNU Affero General Public License (as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version); OR

(2) under the terms of a paid-for Element Commercial License agreement between you and Element (the terms of which may vary depending on what you and Element have agreed to). Unless required by applicable law or agreed to in writing, software distributed under the Licenses is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the Licenses for the specific language governing permissions and limitations under the Licenses.