Element Server Suite Documentation LTS 24.04
We recommend upgrading to the latest LTS 24.10, before doing so please upgrade to the latest patch release available.
For customers using the GroupSync integration, it is recommended to turn on Dry Run mode before performing an upgrade.
Introduction to Element Server Suite
What is Element Server Suite and how does it work? ...
Requirements and Recommendations
What do you need to get started, covering hardware, software and your environment? ...
ESS Sizing Calculator
Use this tool to understand the recommended resources for your desired ESS configuration. ...
Preparing Element Server Suite PoC
Please reach out our Element Sales Team if you want to run a Proof of Concept for Element Server ...
Installing Element Server Suite
First-time installation, Upgrading or Reconfiguring ESS? See here for advice on getting started....
Post-Installation Essentials
You've installed Element Server Suite, what do you need to know? Check here for some essentials....
Installation of Core Components
Breakdown of each section present within the installer, detailing each configurable option. Inclu...
Host Section
Initial configuration options specific to the installer, including how ESS should be deployed. ...
Domains Section
Configure the domains ESS should use for the main components deployed by ESS. ...
Certificates Section
Configure and/or provide the certificates that should be used for each domain served by ESS. ...
Database Section
Configuration options for how ESS can communicate with your PostgreSQL database. ...
Media Section
Configuration options relating to how Media uploaded to your homeserver is handled by ESS. ...
Cluster Section
Settings specific to the environment which you are deploying ESS into such as CA. ...
Synapse Section
The Synapse configuration options for your Matrix Homeserver incl. registration & encryption. ...
Synapse Section: Delegated Auth
A detailed look at Delegated Authentication options available and setup examples. ...
Synapse Section: Federation
Detailed information on configuring homeserver Federation including Trusted Key Servers. ...
Element Web Section
Configuration options relating to the deployed Element Web instance provided by ESS. ...
Homeserver Admin Section
Configuration options relating to the deployed Homeserver Admin instance provided by ESS. ...
Integrator Section
Configuration options relating to the Integrator provided by ESS. ...
Integrations
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 ...
Advanced Configuration
Need help doing something more advanced? See guides for Helm Chart installs, Synapse Workers and ...
Synapse Section: Additional Config
The Additional Config section, which allows including config not currently configurable via the U...
Synapse Section: Workers
The Workers section, which allows you to configure Synape Workers, is available under the 'Advanc...
Kubernetes Override Sections
Found in under Advanced in any section where you configure a component of the installer, under t...
Customise Containers used by ESS
How to change an image used by a container deployed by ESS. ...
Secrets
Find out more about the Secrets block found under each Sections' Advanced configuration options ...
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 (...
ESS CRDs support in ArgoCD
ArgoCD can support getting the ESS CRDs Status as resource health using Custom Health Checks You ...
Verifying ESS releases against Cosign
Cosign ESS Verification Key ESS does not use Cosign transaction log to be able to support airgapp...
Notifications, MDM & Push Gateway
The stock Android and iOS Apps will use an Element owned Push Gateway to send Notification via th...
Helm Chart Installation
Introduction This document will walk you through how to get started with our Element Server Suite...
Administration
Migrating? Automate your deployment? Configuring Backups? Guides for Administrators here!
Automating ESS Deployment
Understand your ESS configuration files and how you can automate ESS deployment(s). ...
Backup and Restore
An ESS Administrators focused guide on backing up and restoring Element Server Suite. ...
Configuring Element Desktop
Element Desktop is a Matrix client for desktop platforms with Element Web at its core. You can do...
Migrating from Self-Hosted to ESS
This document is currently work-in-progress and might not be accurate. Please speak with your Ele...
Using the Admin Console
AKA the Installer GUI, a quick overview of the Configure and Admin tabs and the sections within....
Using the Admin Tab
Users Section By default the users section will display all active user accounts present on your...
Guidance on High Availability
ESS makes use of Kubernetes for deployment so most guidiance on high-availability is tied directl...
Starting and Stopping ESS Services
Stopping a component To stop a component, such as Synapse, it is necessary to stop the operator :...
Support and Troubleshooting
Need some help? Start here for Troubleshooting guides and how to get in touch for Support
ESS LTS 24.04 Change Logs and Upgrade Notes
LTS 24.04 Changelogs and important Update Notes, always check here before upgrading! ...