Element Server Suite Documentation LTS 23.10

Having trouble? Login to your EMS Account and use the contact form to raise a ticket with Support. See the Support page for more details.

Introduction to Element Server Suite

What is Element Server Suite? Element Server Suite provides an enterprise-grade secure communicat...

Kubernetes Installations

Overview Our Installer can handle the installation of Element Enterprise into your existing produ...

Kubernetes Installations - Quick Start

For testing and evaluation purposes - Element cannot guarantee production readiness with these sa...

Single Node Installations

Installing a Standalone Server Overview Our installer can handle the installation of environments...

Single Node Installs: Storage and Backup Guidelines

General storage recommentations for single-node instances /data is where the standalone deploym...

Configuring Element Desktop

Element Desktop is a Matrix client for desktop platforms with Element Web at its core. You can do...

Using the Installer in an Air-Gapped Environment

Defining Air-Gapped Environments An air-gapped environment is any environment in which the runnin...

Troubleshooting

Introduction to Troubleshooting Troubleshooting the Element Installer comes down to knowing a lit...

Setting up Permalinks With the Installer

Element Extra Configurations Please go to the "Element Web" page of the installer, click on "A...

Setting Up Well Known Delegation

Well Known Delegation Configuration From the Installer's Integrations page, click "Install" under...

Setting up Delegated Authentication With the Installer

Delegated Authentication At present, we support delegating the authentication of users to the fol...

Integrations and Add-Ons

Setting Up Jitsi and TURN With the Installer

Configure the Installer to install Jitsi and TURN Prerequisites Firewall You will have to open th...

Setting up Group Sync with the Installer

What is Group Sync? Group Sync allows you to use the ACLs from your identity infrastructure in or...

Setting up GitLab, GitHub, JIRA and Webhooks Integrations With the Installer

In Element Server Suite, our GitLab, GitHub, and JIRA extensions are provided by the hookshot pac...

Setting up Adminbot and Auditbot

Overview Adminbot allows for an Element Administrator to become admin in any existing room or spa...

Setting Up Hydrogen

Configuring Hydrogen From the Installer's Integrations page, click "Install" under "Hydrogen". Fo...

Setting up On-Premise Metrics

Setting up VictoriaMetrics and Grafana From the Installer's Integrations page, click "Install" un...

Setting Up the Telegram Bridge

Configuring Telegram bridge On Telegram platform Login to my.telegram.org to get a telegram app ...

Setting Up the Teams Bridge

Configuring Teams Bridge Register with Microsoft Azure You will first need to generate an "Applic...

Setting Up the IRC Bridge

Matrix IRC Bridge The Matrix IRC Bridge is an IRC bridge for Matrix that will pass all IRC messag...

Setting Up the SIP Bridge

Configuring SIP bridge Basic config From the Installer's Integrations page, click "Install" under...

Setting Up the XMPP Bridge

Configuring the XMPP Bridge The XMPP bridge relies on the xmpp "component" feature. It is an equi...

Setting up Location Sharing

Overview The ability to send a location share, whether static or live, is available without any a...

Removing Legacy Integrations

Today, if you remove a Yaml integration's config, its components will not be removed from the clu...

Setting up Sliding Sync

Introduction to Sliding Sync Sliding Sync is a backend component required by the Element X client...

Setting up Element Call

Introduction Element Call is Element's next generation of video calling, set to replace Jitsi in ...

Setting Up the Skype for Business Bridge

Configuring the Skype for Business Bridge Domains and certificates The first step in preparing a ...

Migration from self-hosted to ESS On-Premise

Notes Migrate from self hosted to Element Starter / ESS On-Premise Preparation This section outli...

Configuring Synapse workers

From the Installer's Synapse page, scroll down to Synapse workers view. Click on Add Workers Yo...

Setting up Delegated Authentication with LDAP on Windows AD

In the installer, set the following fields: Base: the distinguished name of the root level Org ...

Setting up Delegated Authentication with OpenID on Microsoft Azure

Before setting up the installer, you have to configure Microsoft Azure Active Directory. Set up M...

Setting up Delegated Authentication with OpenID on Microsoft AD FS

Install Microsoft AD FS Before starting the installation, make sure: your Windows computer name...

Getting Started with the Enterprise Helm Charts

Introduction This document will walk you through how to get started with our Element Server Suite...

Automating ESS Deployment

The .element-enterprise-server Directory When you first run the installer binary, it will create ...

Kubernetes : namespace-scoped deployments

Prepare the cluster - Admin side Installing the Helm Chart Repositories The first step is to star...

Customize containers ran by ESS

Issue In some deployments, you might want to customize the containers, because you want to add c...

Support Policies

On-Premise Support Scope of Coverage

For Element Enterprise On-Premise, we support the following: Installation and Operation (Configu...

Single Node Scope of Coverage Addendum

List of what is supported for this setup exists. Element supports the installation of microk8s ...

Appendices

Preparing Element Server Suite PoC

Please reach out our Element Sales Team if you want to run a Proof of Concept for Element Server ...

How to run a Webserver on Standalone Deployments

This guide is does not come with support by Element. It is not part of the Element Server Suite (...

Notifications, MDM & Push Gateway

The stock Android and iOS Apps will use an Element owned Push Gateway to send Notification via th...

Verifying ESS releases against Cosign

Cosign ESS Verification Key ESS does not use Cosign transaction log to be able to support airgapp...

ESS CRDs support in ArgoCD

ArgoCD can support getting the ESS CRDs Status as resource health using Custom Health Checks You ...

Synapse database troubleshooting

Room Retention policy enabled causes Synapse database to consume a lot of disk space Run the fol...

Auditbot troubleshooting

Auditbot Viewing Error - Bad MAC This is a symptom that Auditbot Secure Storage got corrupted. It...

Archived Documentation Repository

Documentation covering v1 and installers prior to 2022-07.03

element-on-premise-documentation-july28-2022.pdf

Documentation Covering Installers From 2022.07.03 to 2022.09.05

element-on-premise-documentation-0703-0905.pdf

Documentation Covering Installers From 2022.10.01 to 2023.02.01

element-on-premise-documentation.pdf

Documentation Covering Installer 2023-02.02 CLI Only.

element-on-premise-documentation (2).pdf

Documentation Covering Installers from 2023-03.01 to 2023-05.04