Advanced Search
Search Results
180 total results found
🗃️ Element Server Suite Documentation LTS 23.10
LTS 23.10 is now out of support, we recommend upgrading to the latest LTS 24.10. To upgrade, please update your deployment to the latest LTS 23.10 release. You can then upgrade to the latest patch release of LTS 24.10.
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.
Element Server Suite Documentation LTS 24.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.
Archived Documentation Repository
Integrations and Add-Ons
Appendices
Installation of Core Components
Breakdown of each section present within the installer, detailing each configurable option. Including how each choice functions, the config it generates and general guidance.
Advanced Configuration
Need help doing something more advanced? See guides for Helm Chart installs, Synapse Workers and more!
Administration
Migrating? Automate your deployment? Configuring Backups? Guides for Administrators here!
Support and Troubleshooting
Need some help? Start here for Troubleshooting guides and how to get in touch for Support
Support Policies
Integrations
Installation of Core Components
Integrations
Advanced Configuration
Need help doing something more advanced? See guides for Helm Chart installs, Synapse Workers and more!
Administration
Migrating? Automate your deployment? Configuring Backups? Guides for Administrators here!
Support and Troubleshooting
Setting up Permalinks With the Installer
Element Extra Configurations Please go to the "Element Web" page of the installer, click on "Advanced" and add the following to "Additional Configuration": { "permalinkPrefix": "https://<element fqdn>" } Re-run the installer.
Setting up Delegated Authentication With the Installer
Delegated Authentication At present, we support delegating the authentication of users to the following provider interfaces: LDAP SAML OIDC CAS When enabling Delegated Auth, you can still allow local users managed by Element to connect to the instance Whe...
Setting up Group Sync with the Installer
What is Group Sync? Group Sync allows you to use the ACLs from your identity infrastructure in order to set up permissions on Spaces and Rooms in the Element Ecosystem. Please note that the initial version we are providing only supports a single node, non-fede...
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 package. This documentation explains how to configure hookshot. Configuring Hookshot with the Installer From the Installer's Integrations page, click "Install" under ...
Troubleshooting
Introduction to Troubleshooting Troubleshooting the Element Installer comes down to knowing a little bit about kubernetes and how to check the status of the various resources. This guide will walk you through some of the initial steps that you'll want to take ...
Using the Installer in an Air-Gapped Environment
Defining Air-Gapped Environments An air-gapped environment is any environment in which the running hosts will not have access to the greater internet. This proposes a situation in which these hosts are unable to get access to various needed bits of software fr...
Setting Up Jitsi and TURN With the Installer
Configure the Installer to install Jitsi and TURN Prerequisites Firewall You will have to open the following ports to your microk8s host (or k8s cluster) to enable coturn and jitsi : For jitsi : 30301/tcp 30300/udp For coturn, allow the following ports :...
Documentation covering v1 and installers prior to 2022-07.03
element-on-premise-documentation-july28-2022.pdf
Setting up Adminbot and Auditbot
Overview Adminbot allows for an Element Administrator to become admin in any existing room or space on a managed homeserver. This enables you to delete rooms for which the room administrator has left your company and other useful administration actions. Auditb...
Kubernetes Installations
Overview Our Installer can handle the installation of Element Enterprise into your existing production kubernetes (k8s) environment. Server minimum requirements The ESS deployment resource usage is described in ESS Sizing. Prerequisites Before beginning the in...
Single Node Installs: Storage and Backup Guidelines
General storage recommentations for single-node instances /data is where the standalone deployment installs PostgreSQL data and Element Deployment data. It should be a distinct mount point. Ideally this would have an independent lifecycle from the server it...
Setting up On-Premise Metrics
Setting up VictoriaMetrics and Grafana From the Installer's Integrations page, click "Install" under "Monitoring" For the provided prom.yml, see the following descriptions of the parameters: If you want to write prometheus data to a remote prometheus instanc...
Setting up Location Sharing
Overview The ability to send a location share, whether static or live, is available without any additional configuration. However, when receiving a location share, in order to display it on a map, the client must have access to a tile server. If it does not, t...
Documentation Covering Installers From 2022.07.03 to 2022.09.05
element-on-premise-documentation-0703-0905.pdf
Setting Up the Telegram Bridge
Configuring Telegram bridge On Telegram platform Login to my.telegram.org to get a telegram app ID and hash (get from ). You should use a phone number associated to your company. Basic config From the Installer's Integrations page, click "Install" under "Tel...
Setting Up the Teams Bridge
Configuring Teams Bridge Register with Microsoft Azure You will first need to generate an "Application" to serve connect your Teams bridge with Microsoft. Connect to Azure on https://portal.azure.com/#blade/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/Overview ...
Setting Up the IRC Bridge
Matrix IRC Bridge The Matrix IRC Bridge is an IRC bridge for Matrix that will pass all IRC messages through to Matrix, and all Matrix messages through to IRC. Please also refer to the bridges' specific documentation for additional guidance. For usage of the IR...
Setting Up the XMPP Bridge
Configuring the XMPP Bridge The XMPP bridge relies on the xmpp "component" feature. It is an equivalent of matrix application services. You need to configure an XMPP Component on an XMPP Server that the bridge will use to bridge matrix and xmpp user. On the ho...
Setting Up the SIP Bridge
Configuring SIP bridge Basic config From the Installer's Integrations page, click "Install" under "SIP Bridge" For the provided sipbridge.yml, please see the following documentation: - `postgres_create_in_cluster`: `true` to create the postgres db into the k8s...
Setting Up Well Known Delegation
Well Known Delegation Configuration From the Installer's Integrations page, click "Install" under "Well-Known Delegation". Add any client configuration here: A sample client configuration might look like: { "im.vector.riot.jitsi": { "preferredDo...