Advanced Search
Search Results
257 total results found
Synapse Section: Federation
Detailed information on configuring homeserver Federation including Trusted Key Servers. Federation is the process by which users on different servers can participate in the same room. For this to work, all servers participating in a room m...
Synapse Section
The Synapse configuration options for your Matrix Homeserver incl. registration & encryption. Config: Synapse is the Matrix homeserver that powers ESS, in this section you will be customising settings relating to your h...
Host Section
Initial configuration options specific to the installer, including how ESS should be deployed. Config: The first section of the ESS installer GUI is the Host section, here you will configure essential details of how ESS...
Domains Section
Configure the domains ESS should use for the main components deployed by ESS. Config: The second section of the ESS installer GUI is the Domains section, here you will configure the fully-qualified domain names for each...
Cluster Section
Settings specific to the environment which you are deploying ESS into such as CA. Config: In the Cluster section you will find options to configure settings specific to the cluster which Element Deployment will run on t...
Element Web Section
Configuration options relating to the deployed Element Web instance provided by ESS. Config: Element Web is the web-based client for the Matrix communication protocol. Element Web serves as a user interface for accessin...
Homeserver Admin Section
Configuration options relating to the deployed Homeserver Admin instance provided by ESS. Config: Homeserver Admin is the web-based client for the Synapse Admin API. Homeserver Admin serves as a user interface for admin...
Integrator Section
Configuration options relating to the Integrator provided by ESS. Config: In the Integrator section you will find options to configure settings specific to the integrator which is use...
Kubernetes Override Sections
Found in under Advanced in any section where you configure a component of the installer, under the Kubernetes heading. Here you can override Kubernetes configuration for each component. Common Annotations In Kubernetes, annotations are key-value pairs associ...
Using Python with the Admin + Client-Server APIs
You can use Python to make consume and utilise APIs, including those available with Matrix - such as the Synapse Admin API, and the Matrix Client-Server API. See the below docs to learn more about them before progressing with this guide. Getting Started Usin...
ESS Sizing
The values provided below are indicative and might vary a lot depending on your setup, the volume of federation traffic, active usage, bridged use-cases, integrations enabled, etc. CPU & Memory Synapse Homeserver The installer comes with default installation p...
Synapse Section: Additional Config
The Additional Config section, which allows including config not currently configurable via the UI from the Configuration Manual, is available under the 'Advanced' section of the Synapse page. We strongly advise against including any config not configurable vi...
Configuring Element Desktop
Element Desktop is a Matrix client for desktop platforms with Element Web at its core. You can download Element Desktop for Mac, Linux or Windows from the Element downloads page. See https://web-docs.element.dev/ for the Element Web and Desktop documentation. ...
Synapse Section: Delegated Auth
A detailed look at Delegated Authentication options available and setup examples. At present, we support delegating the authentication of users to the following provider interfaces: LDAP SAML OIDC When enabling Delegated Auth, you can sti...
ESS - Backup & Restore Guide
Introduction Welcome, ESS Administrators. This guide is crafted for your role, focusing on the pragmatic aspects of securing crucial data within the Element Server Suite (ESS). ESS integrates with external PostgreSQL databases and persistent volumes and is dep...
Verifying ESS releases against Cosign
Cosign ESS Verification Key ESS does not use Cosign transaction log to be able to support airgapped deployment. We are instead relying on a public key that you can ask if you need to run image verification in your cluster. The ESS Cosign public key is the foll...
ESS CRDs support in ArgoCD
ArgoCD can support getting the ESS CRDs Status as resource health using Custom Health Checks You need to configure the following under the configmap argocd-cm of argocd : data: resource.customizations: | matrix.element.io/*: health.lua: | h...
Introduction to Element Server Suite
What is Element Server Suite and how does it work? .content-wrap img, .markdown-editor-display img { max-height: 100%; max-width: 100%; } Element Server Suite provides an enterprise-grade secure com...
Installing Element Server Suite
First-time installation, Upgrading or Reconfiguring ESS? See here for advice on getting started. First-Time Installation Make sure you've read the Requirements and Recommendations page so your environment is ready for installation. Running ...
Requirements and Recommendations
What do you need to get started, covering hardware, software and your environment? Software Element Enterprise Server Element Server Suite Download Page To download the installer you require a Element Ser...