Advanced Search
Search Results
61 total results found
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...
Customise Containers used by ESS
How to change an image used by a container deployed by ESS. details > summary::marker { content: "\02699\0FE0F\00020" } ol li::marker { font-size: 150%; color: var(--color-element-green); } ...
Secrets
Find out more about the Secrets block found under each Sections' Advanced configuration options Under 'Advanced' in each section, you may find a block listing all the associated secrets configured as part...
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) product. Use at your own risk. Remember you are responsible of maintaining this software stack yourself. Some config options require a web content to be serve...
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...
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...
Notifications, MDM & Push Gateway
The stock Android and iOS Apps will use an Element owned Push Gateway to send Notification via the Apple or Google Notifiction Services. The URL of our push gateway is https://matrix.org/_matrix/push/v1/notify The apps will on startup register with the Google ...
Helm Chart Installation
Introduction This document will walk you through how to get started with our Element Server Suite Helm Charts. These charts are provided to be used in environments which typically deploy applications by helm charts. If you are unfamiliar with helm charts, we'd...
Automating ESS Deployment
Understand your ESS configuration files and how you can automate ESS deployment(s). The .element-enterprise-server Directory Config examples included on this page may not up-to-date and are solely provide...
Backup and Restore
An ESS Administrators focused guide on backing up and restoring Element Server Suite. .CodeMirror.cm-s-default { margin-bottom: 0px; } Welcome, ESS Administrators. This guide is crafted for your...
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. ...
Migrating from Self-Hosted to ESS
This document is currently work-in-progress and might not be accurate. Please speak with your Element contact if you have any questions. Preparation This section outlines what you should do ahead of the migration in order to ensure the migration goes as quickl...
Using the Admin Console
AKA the Installer GUI, a quick overview of the Configure and Admin tabs and the sections within. Opening the Admin Console First, let’s get started by logging into the admin console. To do this, make sure...
Using the Admin Tab
Users Section By default the users section will display all active user accounts present on your homeserver, listing their Matrix ID followed by their Display Name and whether the user is a Synapse Admin. Navigating Users will be displayed in a list, defaulti...
Guidance on High Availability
ESS makes use of Kubernetes for deployment so most guidiance on high-availability is tied directly with general Kubernetes guidance on high availability. Kubernetes Essential Links Options for Highly Available Topology Creating Highly Available Clusters wi...
Starting and Stopping ESS Services
Stopping a component To stop a component, such as Synapse, it is necessary to stop the operator : kubectl scale deploy/element-operator-controller-manager -n operator-onprem --replicas 0 Once the operator is stopped, you can delete the Synapse resource to rem...
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...
Certificates Section
Configure and/or provide the certificates that should be used for each domain served by ESS. Config: The third section of the ESS installer GUI is the Domains section, here you will configure the certificates to use for...
Media Section
Configuration options relating to how Media uploaded to your homeserver is handled by ESS. Config: The Media section allows you to customise where media uploaded to your homeserver sh...
ESS Sizing Calculator
Use this tool to understand the recommended resources for your desired ESS configuration. .better-spacing-for-sections { margin-block-start: 0em; margin-block-end: 0em; } .tri-layout-sides-content { display: none; } ...