Advanced Search
Search Results
380 total results found
Using the WhatsApp bridge
Overview This guide describes how to bridge your Element and WhatsApp accounts. This allows you to chat with WhatsApp contacts and groups natively within Element. Before you can carry out the steps in this guide, ensure you have the following: WhatsApp - You ...
New Page
Getting Started Using the Client-Server API
The Client-Server API allows a user to perform any action they could via a Matrix client programatically. In order to make use of the API you will need to retrieve an access token for your account. Getting your access_token In order to use the Client-Server ...
Customize containers ran by ESS
Issue In some deployments, you might want to customize the containers, because you want to add contents, change the web clients features, etc. Environment Element Server Suite (ESS) On-Premise Resolution The steps are: Create a new configmap definition wi...
Using the Telegram Bridge
Overview This guide describes how to bridge your Element and Telegram accounts. This allows you to chat with Telegram contacts and groups natively within Element. Before you can carry out the steps in this guide, ensure you have the following: Telegram - You ...
Migrate From EMS to Self-Hosted
For support on Synapse or matrix-media-repo, ask in the Matrix rooms #synapse:matrix.org and #mediarepo:t2bot.io. For support on bridges, see the bridge documentation for each bridge's support channel. See also this excellent blog post by Robin Riley at The Ma...
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...