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)

Searching Database…

13.6K ·GitHub
Element-web
Что это такое?Element — это клиент для совместной работы на базе протокола Matrix, работающий в браузере и построенный на Matrix JS SDK. Раньше проект назывался Vector и Riot, а ещё он выпускается в виде настольного приложения.
Это сайт, который я открываю в браузере, или приложение, которое нужно установить?И то и другое. Он работает в браузере (Chrome, Firefox, Edge, Safari), а ещё есть настольное приложение для macOS, Windows и Linux на базе Electron — со готовыми сборками для скачивания.
Как мне попробовать это в деле?Откройте официальную размещённую в интернете копию по ссылке из README — ничего устанавливать не нужно. Есть также ветка develop с непрерывным деплоем для тестирования самых свежих изменений и документация для тех, кто хочет развернуть собственный экземпляр.
Работает ли это на телефонах?Мобильная версия сайта поддерживается сообществом лишь на посильной основе (актуальные Chrome, Firefox и Safari на Android, iOS и iPadOS). Для телефонов в README вместо этого рекомендуются нативные приложения element-x-android и element-x-ios.
Это открытый исходный код, и могут ли компании пользоваться им бесплатно?Проект распространяется по нескольким лицензиям: бесплатно под AGPL v3 или GPL v3 либо по платной Element Commercial License. Компании могут пользоваться им без оплаты, если согласны с условиями copyleft.
Что такое Matrix?Это протокол, на котором построен Element — данный клиент использует Matrix JS SDK для подключения к нему. README описывает только клиентскую часть, поэтому за подробностями о протоколе обратитесь к самому проекту Matrix.
Какие настольные браузеры официально поддерживаются?Две последние основные версии Chrome, Firefox и Edge, а также две последние версии Safari — регрессии в них блокируют релизы. Firefox ESR и Chrome/Edge Extended Stable получают поддержку лишь на посильной основе.
Это официальный клиент Element?Да — репозиторий находится в GitHub-организации element-hq, а права держит New Vector Ltd (Element), компания, стоящая за продуктом.
Что ещё есть в этом репозитории?Это монорепозиторий: помимо Element Web, в отдельных подпапках здесь размещаются другие связанные проекты, так что веб-приложение и его инструменты живут в одном месте.
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
612.7 MB
Stars
13.6K
Updated
CommitOct 19Releasev1.12.32Oct 16
Age
11y
Commits · 90 Days