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 JS SDK 构建的 Matrix 网页协作客户端。它以前叫 Vector 和 Riot，也有桌面版。
这是在浏览器里打开的网站，还是需要安装的应用？都可以。它能在浏览器（Chrome、Firefox、Edge、Safari）里运行，也有用 Electron 封装、支持 macOS、Windows 和 Linux 的桌面版，可以直接下载预打包的安装包。
我该怎么试用？打开 README 中链接的官方在线版即可——无需安装任何东西。另外还有一个持续部署的 develop 分支，可以体验最新功能，文档里也讲了如何自己搭建一个实例。
手机上能用吗？手机网页版只有社区支持，属于尽力而为（支持 Android、iOS 和 iPadOS 上当前版本的 Chrome、Firefox 和 Safari）。手机上 README 推荐改用原生应用 element-x-android 和 element-x-ios。
它是开源的吗？公司能免费使用吗？它采用多重许可：可以免费地在 AGPL v3 或 GPL v3 下使用，也可以购买付费的 Element Commercial License。公司只要接受 copyleft（同类开源）条款，就可以不付费使用。
Matrix 是什么？Matrix 是 Element 所基于的协议——这个客户端使用 Matrix JS SDK 来连接它。README 主要讲客户端部分，协议本身的详情请看 Matrix 项目。
官方支持哪些桌面浏览器？Chrome、Firefox 和 Edge 的最近两个大版本，以及 Safari 的最近两个版本——这些浏览器上出现的回退问题会阻止版本发布。Firefox ESR 和 Chrome/Edge Extended Stable 只有尽力而为的支持。
这是 Element 的官方客户端吗？是的——这个仓库位于 element-hq GitHub 组织下，版权归 New Vector Ltd（Element）所有，也就是这个产品背后的公司。
这个仓库里还有别的东西吗？它是一个 monorepo：除了 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, chat, collaboration, monorepo, i18n, agpl, electron, hacktoberfest, desktop
Creator
element-hq
Size
611.7 MB
Stars
13.6K
Updated
CommitOct 16Releasev1.12.32Oct 16
Age
11y
Commits · 90 Days