Manage your Element Server Suite deployment
  • TypeScript 95.4%
  • CSS 4%
  • JavaScript 0.3%
  • Shell 0.1%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
2026-11-09 09:31:24 +01:00
.github Build(deps): Bump docker/login-action from 4.6.0 to 4.7.0 (#695) 2026-11-06 09:58:44 +01:00
docker Allow remote images in the CSP so client logos load 2026-08-05 17:48:51 +02:00
docs Add a screenshot to the README 2025-09-24 12:06:22 +02:00
LICENSES
public Allow remote images in the CSP so client logos load 2026-08-05 17:48:51 +02:00
scripts Silence no-unsafe-enum-assignment on formatjs printAST call 2026-11-06 10:47:18 +01:00
src Use the stable endpoint for discovering the authentication server information 2026-10-22 12:29:06 +02:00
tests Use the stable endpoint for discovering the authentication server information 2026-10-22 12:29:06 +02:00
translations Translations updates 2026-10-13 09:32:13 +00:00
.browserslistrc Update the copyright holder to Element Creations Ltd. 2026-01-07 13:18:08 +01:00
.dockerignore Update the copyright holder to Element Creations Ltd. 2026-01-07 13:18:08 +01:00
.gitignore Update the copyright holder to Element Creations Ltd. 2026-01-07 13:18:08 +01:00
.oxfmtrc.json Replace Prettier with Oxfmt for code formatting 2026-03-10 10:23:33 +01:00
.oxlintrc.json Migrate to the new react compiler stable lints in oxlint 2026-08-21 14:40:54 +02:00
.stylelintrc.json
Dockerfile Upgrade to Node.js 26, declared once in devEngines 2026-11-06 11:10:06 +01:00
index.html Update the copyright holder to Element Creations Ltd. 2026-01-07 13:18:08 +01:00
LICENSE Symlink the AGPL license at the root of the project 2025-09-23 16:32:30 +02:00
localazy.json Own the English translation files in-repo 2026-09-01 15:21:15 +02:00
openapi-ts.config.ts Fix openapi-ts codegen under TypeScript 7 2026-10-12 11:41:05 +02:00
package.json Build(deps): Bump @formatjs/intl-localematcher 2026-11-06 22:24:14 +00:00
playwright.config.ts Add visual regression baselines for the console 2026-09-01 16:06:19 +02:00
pnpm-lock.yaml Build(deps): Bump @formatjs/intl-localematcher 2026-11-06 22:24:14 +00:00
pnpm-workspace.yaml Upgrade to Node.js 26, declared once in devEngines 2026-11-06 11:10:06 +01:00
README.md Upgrade to Node.js 26, declared once in devEngines 2026-11-06 11:10:06 +01:00
REUSE.toml Cover new config files in REUSE 2026-03-10 10:43:40 +01:00
tsconfig.json Show Synapse federation destinations with their status 2026-06-23 19:07:32 +02:00
vite.config.ts Migrate to the native react compiler integration 2026-08-21 14:40:54 +02:00

Element Admin

Element Admin is a web-based administration panel for the Element Server Suite, available in both ESS Pro and in the free ESS Community edition.

🚀 Try it

You can try the latest Element Admin using the hosted version at https://admin-beta.element.dev/.

Dashboard screenshot

🚀 Getting started

This component is developed and maintained by Element. It gets shipped as part of the Element Server Suite (ESS) which provides the official means of deployment.

ESS is a Matrix distribution from Element with focus on quality and ease of use. It ships a full Matrix stack tailored to the respective use case.

There are three editions of ESS:

  • ESS Community - the free Matrix distribution from Element tailored to small-/mid-scale, non-commercial community use cases
  • ESS Pro - the commercial Matrix distribution from Element for professional use
  • ESS TI-M - a special version of ESS Pro focused on the requirements of TI-Messenger Pro and ePA as specified by the German National Digital Health Agency Gematik

💬 Community room

Developers and users of Element Admin can chat in the #ess-community:element.io room on Matrix.

📝 Prerequisites and standalone installation

Element Admin is designed to work with the components that ship with ESS. It assumes the following, which is handled out of the box by ESS version 25.9.2 or later:

Under the hood, Element Admin is a single-page application React application which can be deployed in any static hosting service or container environment.

🐳 Using Docker

A pre-built Docker image is available on Element's container registry:

docker run -p 8080:8080 oci.element.io/element-admin:latest

It can be configured using the following environment variables:

Variable Description
SERVER_NAME The name of the Matrix server to use. If not set, the user will be prompted to enter a server name.

A local Docker image can be built from the source code using the following command:

docker build -t element-admin .
📦 Building from the source code
  1. Clone the repository:
git clone https://github.com/element-hq/element-admin.git
cd element-admin
  1. Install dependencies with pnpm 11 or later. It also downloads the Node.js version that devEngines.runtime in package.json declares:
pnpm install
  1. Build the application
pnpm build

The built application will be in the dist/ directory, ready to be deployed to any static hosting service.

🌍 Translations

Element Admin is available in multiple languages. Anyone can contribute to translations through Localazy.

🏗️ Contributing

We welcome contributions from the community! If you'd like to suggest changes or contribute to the project, please come and chat with us first in the #ess-community:element.io room on Matrix.

Development workflow

  • Before pushing: Run pnpm check for the same checks CI does: it regenerates the extracted English messages, then lints and looks for unused code
  • Linting & Formatting: Run pnpm lint to check code style and pnpm fix to auto-fix issues
  • Translation extraction: Run pnpm i18n:extract when adding or changing translatable strings, and commit the regenerated English files under translations/. The other languages are translated on Localazy: the extracted messages are uploaded there on every push to main, and the translations come back through the download workflow's automated pull requests
  • End-to-end tests: See tests/README.md for how to run and write the Playwright suite

Copyright 2025 New Vector Ltd. Copyright 2025, 2026 Element Creations Ltd.

This software is dual-licensed by Element Creations Ltd. 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, version 3 of the License); 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.