element-web README

The project's README from github.com/element-hq/element-web. As one markdown file: README.md.

Chat Tests Static Analysis Localazy Quality Gate Status Coverage Vulnerabilities Bugs

Element

Element (formerly known as Vector and Riot) is a Matrix web & desktop client built using the Matrix JS SDK.

Supported Environments

Element has several tiers of support for different environments:

The period of support for these tiers should last until the releases specified above, plus 1 app release cycle(2 weeks). In the case of Firefox ESR this is extended further to allow it land in Debian Stable.

For accessing Element on an Android or iOS device, we currently recommend the native apps element-x-android and element-x-ios.

Getting Started

The easiest way to test Element is to just use the hosted copy at https://app.element.io. The develop branch is continuously deployed to https://develop.element.io for those who like living dangerously.

To host your own instance of Element see Installing Element Web.

To install Element as a desktop application, see Running as a desktop app below.

Monorepo

This repository is a monorepo hosting Element Web and other related projects in various subdirectories. You can read more about the structure here.

Element Web

To learn more about Element Web click here

Running as a Desktop app

Element can also be run as a desktop app, wrapped in Electron. You can download a pre-built version from https://element.io/get-started or, if you prefer, build it yourself.

To build it yourself, follow the instructions at https://github.com/element-hq/element-web/tree/develop/apps/desktop.

Many thanks to @aviraldg for the initial work on the Electron integration.

The configuration docs show how to override the desktop app's default settings if desired.

Development

Please read through the following:

  1. Developer guide
  2. Code style
  3. Contribution guide

Translations

To add a new translation, head to the translating doc.

For a developer guide, see the translating dev doc.

Triaging issues

Issues are triaged by community members and the Web App Team, following the triage process.

We use issue labels to sort all incoming issues.

Copyright (c) 2014-2017 OpenMarket Ltd Copyright (c) 2017 Vector Creations Ltd Copyright (c) 2017-2025 New Vector Ltd

This software is multi 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) for free under the terms of the GNU General Public License (as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version); OR

(3) 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.

Please contact [email protected] to purchase an Element commercial license for this software.

element-web (element-hq/element-web)

matrix
Searching Database…

13.6K ·GitHub
Element-web
What is this?Element is a Matrix collaboration client for the web, built on the Matrix JS SDK. It was formerly known as Vector and Riot and also ships as a desktop app.
Is this a website I open in a browser, or an app I install?Either. It runs in the browser (Chrome, Firefox, Edge, Safari), and there is also a desktop app for macOS, Windows, and Linux wrapped in Electron, with pre-built downloads.
How do I try it out?Open the official hosted copy linked in the README — nothing to install. There is also a continuously deployed develop branch for bleeding-edge testing, and docs for hosting your own instance.
Does it work on phones?Mobile web gets only community-supported, best-effort treatment (current Chrome, Firefox, and Safari on Android, iOS, and iPadOS). For phones the README recommends the native element-x-android and element-x-ios apps instead.
Is it open source, and can companies use it for free?It is multi-licensed: free under AGPL v3 or GPL v3, or under a paid Element Commercial License. Companies can use it without paying if they accept the copyleft terms.
What is Matrix?It is the protocol Element is built around — this client uses the Matrix JS SDK to connect to it. The README focuses on the client side, so see the Matrix project itself for details on the protocol.
Which desktop browsers are officially supported?The last two major versions of Chrome, Firefox, and Edge, plus the last two versions of Safari — regressions in those block releases. Firefox ESR and Chrome/Edge Extended Stable only get best-effort support.
Is this the official Element client?Yes — the repo lives under the element-hq GitHub organization, and the copyright is held by New Vector Ltd (Element), the company behind the product.
What else is in this repository?It is a monorepo: alongside Element Web it hosts other related projects in separate subdirectories, so the web app and its tooling live in one place.
What are similar projects?Signal-Desktop, raft-source, electronic-wechat, Mailspring, ZCode, lanmessenger, devhub, zulip
Which topics is it in?matrix, communication, electron-app, messaging, collaboration, chat, monorepo, i18n, electron, agpl, hacktoberfest, desktop
Creator
element-hq
Size
611.7 MB
Stars
13.6K
Updated
CommitOct 16Releasev1.12.32Oct 16
Age
11y
Commits · 90 Days