element-web

(★ 13,397)

A glossy Matrix collaboration client for the web.

File Explorer

Download Latest Version (.zip)

Showing a partial file list — download the zip above to see everything.

- - bug-desktop.yml
  - bug-web.yml
  - config.yml
  - enhancement.yml
- - backport.yml
  - build-and-test-netlify.yaml
  - build-and-test.yaml
  - build.yml
  - build_debian.yaml
  - build_desktop_and_deploy.yaml
  - build_desktop_linux.yaml
  - build_desktop_macos.yaml
  - build_desktop_prepare.yaml
  - build_desktop_test.yaml
  - build_desktop_windows.yaml
  - build_develop.yml
  - cd.yaml
  - deploy.yml
  - docker.yaml
  - docs.yml
  - issue_closed.yml
  - localazy_download.yaml
  - localazy_upload.yaml
  - merge-queue.yaml
  - netlify.yaml
  - npm-publish.yaml
  - pull_request.yaml
  - pull_request_base_branch.yaml
  - release-drafter.yml
  - release-gitflow.yml
  - release-module.yml
  - release.yml
  - release_prepare.yml
  - shared-component-storybook-build.yml
  - shared-component-storybook-netlify.yaml
  - shared-component-storybook-publish.yaml
  - shared-component-visual-tests-netlify.yaml
  - shared-component-visual-tests.yaml
  - static_analysis.yaml
  - sync-labels.yml
  - tests.yml
  - triage-assigned.yml
  - triage-incoming.yml
  - triage-labelled.yml
  - triage-move-review-requests.yml
  - triage-stale.yml
  - triage-unlabelled.yml
  - update-jitsi.yml
  - update-topics.yaml
- cfp_headers
- CODEOWNERS
- FUNDING.yml
- labels.yml
- PULL_REQUEST_TEMPLATE.md
- release-drafter.yml
- renovate.json
- SSLcom-sandbox.crt
- pre-commit
- - .gitignore
  - .node-version
  - babel.config.cjs
  - CHANGELOG.md
  - electron-builder.ts
  - package.json
  - playwright.config.ts
  - project.json
  - README.md
  - tsconfig.json
  - tsconfig.node.json
  - vitest.config.ts
- - .gitignore
  - .lintstagedrc
  - .modernizr.json
  - .stylelintrc.cjs
  - babel.config.cjs
  - build_config.sample.yaml
  - components.json
  - config.sample.json
  - Dockerfile
  - Dockerfile.dockerignore
  - I18nWebpackPlugin.ts
  - jest.config.ts
  - package.json
  - playwright.config.ts
  - project.json
  - README.md
  - recorder-worklet-loader.cjs
.editorconfig
.git-blame-ignore-revs
.gitignore
.lintstagedrc
.node-version
.npmignore
.oxfmtrc.jsonc
AUTHORS.rst
CHANGELOG.md
CONTRIBUTING.md
LICENSE-AGPL-3.0
LICENSE-COMMERCIAL
LICENSE-GPL-3.0
README.md

🚀 Installation Guide

1. Get the code

git clone https://github.com/element-hq/element-web

Downloads the entire project code from GitHub to your computer.

cd element-web

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Docker Desktop Needed to build and run containers. Install it and keep it running in the background.

docker build -f apps/desktop/dockerbuild/Dockerfile -t element-web .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 element-web

Runs the built image as an actual container.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Node.js

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

cd apps/desktop

This project's files live in a subfolder, so move into it first.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

element-web

File Explorer

🚀 Installation Guide

2. Docker

3. Node.js

Today's picks

Was this content helpful?

Recent Feedback

element-web

File Explorer

🚀 Installation Guide

2. Docker

3. Node.js

Today's picks

Was this content helpful?

Recent Feedback

Download README