Element

https://docs.element.io/latest
Admin
Element provides messaging and collaboration applications built on the Matrix communication...
Tokens:298,290
Snippets:4,241
Trust Score:10
Update:4 months ago
Show doc for...
Tokens:
Raw
### Run Element Enterprise Graphical Installer

Source: https://docs.element.io/latest/element-server-suite-classic/administration/using-the-admin-console?q=

Execute the installer binary to start the Element Enterprise graphical installer. Ensure you specify the correct version for your installation.

```bash
./element-enterprise-graphical-installer-2023-06-01.bin

```

--------------------------------

### Jitsi Configuration Example

Source: https://docs.element.io/latest/element-server-suite-classic/integrations/setting-up-jitsi-and-turn-with-the-installer

Example of Jitsi configuration parameters to be set in the installer's jitsi.yml file. Includes FQDN, authentication secrets, and timezone.

```yaml
jitsi_fqdn: jitsi.<fqdn.tld>
jicofo_auth_password: # a secret internal password for Jicofo auth
jicofo_component_secret: # a secret internal password for Jicofo component
jvb_auth_password: # a secret internal password for jvb
helm_override_values: {}
timezone: Europe/Paris
```

--------------------------------

### Run Element Enterprise Installer

Source: https://docs.element.io/latest/element-server-suite-classic/administration/using-the-admin-console

Execute the Element Enterprise graphical installer to initiate the setup process. Ensure you use the correct version number for your installation.

```bash
./element-enterprise-graphical-installer-2023-06.01-gui.bin
```

--------------------------------

### Example cURL command for Hookshot setup

Source: https://docs.element.io/latest/element-support/bridges/setting-up-hookshot-without-e2ee-support-in-encrypted-rooms

An example of the cURL command for setting up Hookshot in an encrypted room, demonstrating the expected format for URLs and data payloads.

```bash
curl --request PUT \
  --url 'https://localhost:8448/_matrix/client/r0/rooms/%21QrmxBsBKPajykCohPz:localhost:8448/send/m.room.message/1234' \
  --header 'Authorization: Bearer syt_YWRtaW4_epoEMAUauwwFpsOGJxIg_471LjM' \
  --header 'content-type: application/json' \
  --data '{
  "msgtype":"m.text",
  "body":"!hookshot setup-widget"
}'

```

--------------------------------

### Example: Get Ingress Controller Logs

Source: https://docs.element.io/latest/element-server-suite-classic/support-and-troubleshooting/troubleshooting

An example demonstrating how to get logs for the Kubernetes ingress controller pod. This helps in diagnosing network-related issues within the cluster.

```bash
kubectl logs -n ingress nginx-ingress-microk8s-controller-w8lcn
```

--------------------------------

### Example PowerShell command for Hookshot setup

Source: https://docs.element.io/latest/element-support/bridges/setting-up-hookshot-without-e2ee-support-in-encrypted-rooms

An example of the PowerShell command for setting up Hookshot in an encrypted room, demonstrating the expected format for URLs, headers, and data payloads.

```powershell
$url = "https://localhost:8448/_matrix/client/r0/rooms/%21QrmxBsBKPajykCohPz:localhost:8448/send/m.room.message/1234"

$headers = @{
    "Authorization" = "Bearer syt_YWRtaW4_epoEMAUauwwFpsOGJxIg_471LjM"
    "Content-Type" = "application/json"
}

$body = @{
    msgtype = "m.text"
    body = "!hookshot setup-widget"
} | ConvertTo-Json

Invoke-RestMethod -Uri $url -Method Put -Headers $headers -Body $body

```

--------------------------------

### Run Element Server Suite Installer

Source: https://docs.element.io/latest/element-server-suite-classic/installing-element-server-suite?q=

Execute the Element Server Suite installer binary to begin the installation process.

```bash
./element-installer-enterprise-edition-YY.MM.00-gui.bin

```

--------------------------------

### Complete Default Configuration Example

Source: https://docs.element.io/latest/element-server-suite-classic/installation-of-core-components/database-section?q=

An example of the complete configuration in deployment.yml when default settings are applied for PostgreSQL.

```yaml
spec:
  components:
    synapse:
      config:
        postgresql:
          database: synapse
          host: db.example.com
          passwordSecretKey: postgresPassword
          user: test-username


```

--------------------------------

### Coturn Configuration Example

Source: https://docs.element.io/latest/element-server-suite-classic/integrations/setting-up-jitsi-and-turn-with-the-installer

Example of Coturn configuration parameters to be set in the installer's coturn.yml file. Ensure coturn_fqdn resolves to the public IP and generate a shared_secret.

```yaml
coturn_fqdn: coturn.<fqdn.tld>
shared_secret: pwgen 32
min_port: 32769
max_port: 65535
```

--------------------------------

### Make Installer Executable

Source: https://docs.element.io/latest/element-server-suite-classic/installing-element-server-suite?q=

Make the Element Server Suite installer binary executable before running it.

```bash
chmod +x ./element-installer-enterprise-edition-YY.MM.00-gui.bin

```

--------------------------------

### Example CRDs Output

Source: https://docs.element.io/latest/element-server-suite-classic/installation-of-core-components/host-section?q=

Example output showing the list of installed Element-related CRDs.

```text
elementwebs.matrix.element.io                         2023-10-11T13:23:14Z
wellknowndelegations.matrix.element.io                2023-10-11T13:23:14Z
elementcalls.matrix.element.io                        2023-10-11T13:23:14Z
hydros.matrix.element.io                           2023-10-11T13:23:14Z
mautrixtelegrams.matrix.element.io                    2023-10-11T13:23:14Z
sydents.matrix.element.io                             2023-10-11T13:23:14Z
synapseusers.matrix.element.io                        2023-10-11T13:23:14Z
bifrosts.matrix.element.io                            2023-10-11T13:23:14Z
lowbandwidths.matrix.element.io                       2023-10-11T13:23:14Z
synapsemoduleconfigs.matrix.element.io                2023-10-11T13:23:14Z
matrixauthenticationservices.matrix.element.io        2023-10-11T13:23:14Z
ircbridges.matrix.element.io                          2023-10-11T13:23:14Z
slidingsyncs.matrix.element.io                        2023-10-11T13:23:14Z
securebordergateways.matrix.element.io                2023-10-11T13:23:14Z
hookshots.matrix.element.io                           2023-10-11T13:23:14Z
matrixcontentscanners.matrix.element.io               2023-10-11T13:23:14Z
sygnals.matrix.element.io                             2023-10-11T13:23:14Z
sipbridges.matrix.element.io                          2023-10-11T13:23:14Z
livekits.matrix.element.io                            2023-10-11T13:23:14Z
integrators.matrix.element.io                         2023-10-11T13:23:14Z
jitsis.matrix.element.io                              2023-10-11T13:23:14Z
mautrixwhatsapps.matrix.element.io                    2023-11-15T09:03:48Z
synapseadminuis.matrix.element.io                     2023-10-11T13:23:14Z
synapses.matrix.element.io                            2023-10-11T13:23:14Z
groupsyncs.matrix.element.io                          2023-10-11T13:23:14Z
pipes.matrix.element.io                               2023-10-11T13:23:14Z
elementdeployments.matrix.element.io                  2023-10-11T13:34:25Z
chatterboxes.matrix.element.io                        2023-11-21T15:55:59Z

```

--------------------------------

### Install K3s

Source: https://docs.element.io/latest/element-server-suite-pro/setting-up-ess-pro-helm-chart?q=

Run this command to install K3s, a lightweight Kubernetes distribution, on your server.

```bash
curl -sfL https://get.k3s.io | sh -
```

--------------------------------

### Install Git and Update Packages on Ubuntu

Source: https://docs.element.io/latest/element-server-suite-classic/requirements-and-recommendations

Run these commands on Ubuntu systems to update package lists, upgrade existing packages, and install Git, which is a prerequisite for the installer.

```bash
sudo apt-get update
sudo apt-get upgrade
sudo apt-get install git

```

--------------------------------

### Install Element Desktop MSI with Custom Directory

Source: https://docs.element.io/latest/element-server-suite-classic/administration/configuring-element-desktop

Use this command to install the Element Desktop MSI and specify a custom installation directory. Ensure you replace the MSI filename and path with your specific details.

```bash
msiexec /i "Element 1.11.66.msi" APPLICATIONFOLDER="C:\Element"
```

--------------------------------

### Jitsi STUN Servers Configuration

Source: https://docs.element.io/latest/element-server-suite-classic/integrations/setting-up-jitsi-and-turn-with-the-installer

Example of how to configure STUN servers in Jitsi if Coturn is not set up via the installer. This should be a YAML list of server:port entries.

```yaml
stun_servers:
- ip:port
- ip:port
```

--------------------------------

### Install Snap on Enterprise Linux

Source: https://docs.element.io/latest/element-server-suite-classic/requirements-and-recommendations

Installs Snapd, enables its socket for communication, and creates a symbolic link for classic snap support. This is part of the microk8s installation prerequisites on RHEL.

```bash
sudo yum install snapd
sudo systemctl enable --now snapd.socket
sudo ln -s /var/lib/snapd/snap /snap

```

--------------------------------

### Cluster Configuration Example

Source: https://docs.element.io/latest/element-server-suite-classic/installation-of-core-components/cluster-section?q=

Example of cluster configuration settings including metadata annotations and component specifications.

```yaml
metadata:
  annotations:
    ui.element.io/layer: |
      global:
        config:
          adminAllowIps:
            _value: defaulted
        k8s:
          ingresses:
            tls:
              certmanager:
                _value: defaulted
spec:
  components:
    synapseAdmin:
      config:
        hostOrigin: >-
          https://admin.example.com,https://admin.example.com:8443
  global:
    config:
      adminAllowIps:
        - 0.0.0.0/0
        - "::/0"
    k8s:
      ingresses:
        tls:
          certmanager:
            issuer: letsencrypt
          mode: certmanager

```

--------------------------------

### Example Output of Dependent Resources

Source: https://docs.element.io/latest/element-server-suite-classic/administration/starting-and-stopping-ess-services?q=

An example output showing the list of dependent resources for an Element deployment, including various services like Synapse and its UI.

```text
kubectl get elementdeployment/first-element-deployment -n element-onprem  --template='{{range $key, $value := .status.dependentCRs}}{{$key}}{"\n"}{{end}}'

ElementWeb/first-element-deployment
Hookshot/first-element-deployment
Integrator/first-element-deployment
MatrixAuthenticationService/first-element-deployment
Synapse/first-element-deployment
SynapseAdminUI/first-element-deployment
SynapseUser/first-element-deployment-adminuser-donotdelete
SynapseUser/first-element-deployment-telemetry-donotdelete
WellKnownDelegation/first-element-deployment
```

--------------------------------

### Install Helm

Source: https://docs.element.io/latest/element-server-suite-pro/setting-up-ess-pro-helm-chart?q=

Use this command to install Helm, the Kubernetes Package Manager, on your system.

```bash
curl -fsSL https://raw.githubusercontent.com/helm/helm/main/scripts/get-helm-3 | bash
```

--------------------------------

### HTML Homepage Example

Source: https://docs.element.io/latest/element-server-suite-classic/advanced-configuration/how-to-run-a-webserver-on-standalone-deployments?q=

An example HTML file for the web server's homepage. This content will be served to users.

```html
<h2 style="text-align:center">
  <br />
  Welcome to the Element Chat Server.
</h2>
<p style="text-align:center">
  You can find a [Getting Started Guide here](https://static.element.io/pdfs/element-user-guide.pdf)
</p>
<p style="text-align:center">
  Powered by&nbsp;[Matrix](https://matrix.org/), provided by [Element](https://element.io).
</p>
<p style="text-align:center">
  [Explore rooms](https://element.BASEDOMAIN/#/directory)
</p>
<p style="text-align:center">
  <strong><span style="font-size:20px"><span style="color:#c0392b">Create a Key Backup &amp; Passphrase now!<br />(see Getting Started Guide p. 5)</span></span></strong>
</p>

```

--------------------------------

### Install PostgreSQL Client

Source: https://docs.element.io/latest/element-server-suite-classic/requirements-and-recommendations

Installs the PostgreSQL client utility on a Debian-based system (like Ubuntu). This is required to connect to and manage PostgreSQL databases.

```bash
sudo apt update
sudo apt install postgresql-client
```

--------------------------------

### Install ESS Stack Helm Chart

Source: https://docs.element.io/latest/element-server-suite-classic/advanced-configuration/classic-ess-helm-chart-installation

Install the ess-stack Helm chart using a custom values file.

```bash
helm install ess-system/ess-stack --namespace element-onprem -f values.yaml  --version ~2.17.0

```

--------------------------------

### Provisioner Configuration Example

Source: https://docs.element.io/latest/element-server-suite-pro/advanced-identity-management/provisioning

Example configuration for the provisioner, detailing settings for default rooms, allowed users, public room invitations, reinvite grace periods, and federation.

```yaml
provisioner:
  # Optional. A list of rooms that'll get automatically created in each managed space.
  # The ID is required to enable Advanced Identity Management to track whether they were already created or not.
  # You can change it, but it'll cause new rooms to be generated.
  default_rooms:
  - id: 'general'
    properties: { name: 'General discussion' }
  # Optional. A list of userid patterns that will not get kicked from rooms
  # even if they don't belong to them according to LDAP.
  # This is useful for things like the auditbot.
  # Patterns listed here will be wrapped in ^ and $ before matching.
  allowed_users:
  - '@adminbot:.*'
  # Optional. Determines whether users will be automatically invited to rooms (default, public and space-joinable)
  # when they gain access to them. Defaults to true. Users will still get invited to spaces regardless of this setting.
  invite_to_public_rooms: false
  # Optional. Users who were previously removed from provisioning will be automatically invited back to rooms,
  # if re-provisioned within this time period.
  # The format is <amount><unit>, with amount being numeric and unit being one of: [s, m, h, d], for seconds, minutes,
  # hours or days respectively (for example: "24h", "31d" etc.).
  # The specified period will be translated into seconds, so won't account for things like DST, leap seconds etc.
  reinvite_to_rooms_grace_period: '1h'
  # Optional: A list of remote Advanced Identity Managements we'll be federating with. Requests from other remote users will be ignored.
  federation:
    federates_with:
    - '@aim_bot:consultancy.test'

```

--------------------------------

### Download ESS Pro Example Values Files

Source: https://docs.element.io/latest/element-server-suite-pro/setting-up-ess-pro-helm-chart?q=

Download the example configuration values files for ESS Pro from the Helm chart archive. The files will be extracted into a 'charts' directory.

```bash
helm pull oci://registry.element.io/matrix-stack --untar -d charts
```

--------------------------------

### Configure Synapse Admin Host Origin

Source: https://docs.element.io/latest/element-server-suite-classic/installation-of-core-components/host-section

Example configuration for the synapseAdmin component, specifying the host origin for the installer GUI.

```yaml
spec:
  components:
    synapseAdmin:
      config:
        hostOrigin: >-
          https://admin.example.com,https://admin.example.com:8443

```

--------------------------------

### Uninstall Cert-Manager

Source: https://docs.element.io/latest/element-server-suite-pro/setting-up-ess-pro-helm-chart?q=

Removes the cert-manager component from the cluster using Helm. This is an optional step if cert-manager was installed as part of the setup.

```bash
# Remove cert-manager from cluster
helm uninstall cert-manager --namespace cert-manager

```

--------------------------------

### Sample Client Configuration

Source: https://docs.element.io/latest/element-server-suite-classic/integrations/setting-up-well-known-delegation

A sample JSON object for client configuration in Well-Known Delegation.

```json
{
  "im.vector.riot.jitsi": {
    "preferredDomain": "jitsi.dev.private"
  }
}

```

--------------------------------

### Calculate Retrospective Monthly Statistics

Source: https://docs.element.io/latest/element-server-suite-classic/administration/calculate-monthly-active-users

Use this query to get MAU for a specific past month by defining a start and end timestamp. It excludes support users.

```sql
SELECT COUNT(*) FROM (
    SELECT
        user_id,
        MAX(timestamp) AS timestamp
    FROM user_daily_visits
    WHERE
        timestamp >= 1730419200000 AND -- Friday, 1 November 2024 00:00:00 GMT
        timestamp < 1733011200000 AND -- Sunday, 1 December 2024 00:00:00 GMT
        user_id NOT IN (
            SELECT name
            FROM users
            WHERE user_type = 'support'
        )
    GROUP BY user_id
) AS temp;

```

--------------------------------

### Default PostgreSQL Configuration Example

Source: https://docs.element.io/latest/element-server-suite-classic/installation-of-core-components/database-section

Illustrates the default PostgreSQL settings that will be added to configuration files if no changes are made.

```yaml
spec:
  components:
    synapse:
      config:
        postgresql:
          database: synapse
          host: db.example.com
          passwordSecretKey: postgresPassword
          user: test-username

```

--------------------------------

### Apache Reverse Proxy Configuration for Well-Known

Source: https://docs.element.io/latest/element-server-suite-classic/integrations/setting-up-well-known-delegation

Example Apache configuration for setting up a reverse proxy for Element's Well-Known endpoint when a web server is in front of the installation.

```apache
    ProxyPass               /.well-known/matrix/ https://matrix.MYBASEDOMAIN/.well-known/matrix/
    ProxyPassReverse        /.well-known/matrix/ https://matrix.MYBASEDOMAIN/.well-known/matrix/
    ProxyPreserveHost On

```

--------------------------------

### Send 'setup-widget' command using cURL (Mac/Linux)

Source: https://docs.element.io/latest/element-support/bridges/setting-up-hookshot-without-e2ee-support-in-encrypted-rooms

Use this command in your terminal to send the setup command to Hookshot in an encrypted room when E2EE is not supported by Hookshot. Replace placeholders with your Matrix server details, room ID, and access token.

```bash
curl --request PUT \
  --url 'https://domain-where-your-matrix-server-is-exposed/_matrix/client/r0/rooms/room-id/send/m.room.message/1234' \
  --header 'Authorization: Bearer access-token' \
  --header 'content-type: application/json' \
  --data '{
  "msgtype":"m.text",
  "body":"!hookshot setup-widget"
}'

```

--------------------------------

### Wipe and Restart Standalone Deployment

Source: https://docs.element.io/latest/element-server-suite-classic/support-and-troubleshooting/troubleshooting?q=

Command to remove MicroK8s, clear data, and reboot for a fresh start on a standalone deployment. Requires passwordless sudo for unattended installer execution.

```bash
sudo snap remove microk8s --purge && sudo rm -rf /data && sudo reboot

```

--------------------------------

### Making a GET request with Authorization header

Source: https://docs.element.io/latest/element-support/advanced-administration/migrating-sso-keeping-a-matrix-account?q=

This example shows how to include an Authorization Bearer token in a curl request to interact with the Admin API. Replace 'syt_adminToken' with your actual admin access token.

```bash
curl --request GET 'https://example.com/_synapse/admin/v2/users?from=0&limit=10&guests=false' --header 'Authorization: Bearer syt_adminToken'
```

--------------------------------

### Configure Basic Connectivity for ESS

Source: https://docs.element.io/latest/element-server-suite-classic/installation-of-core-components/host-section

Example configuration for the general connectivity settings.

```yaml
spec:
  connectivity:

```

--------------------------------

### Nginx Custom HTTP Errors and Server Snippet

Source: https://docs.element.io/latest/element-server-suite-classic/installation-of-core-components/host-section?q=

Configure custom HTTP error pages and server snippets for Nginx within the Element Server Suite installation. This example shows how to replace the default 404 error page.

```yaml
spec:
  install:
    microk8s:
      nginxExtraConfiguration: 
        custom-http-errors: '"404"'
        server-snippet: >-
          error_page 404 /404.html; location = /404.html { internal; return 200
          "<p>Hello World!</p>"; }
```

--------------------------------

### Jitsi Configuration Example

Source: https://docs.element.io/latest/element-server-suite-classic/integrations/setting-up-jitsi-and-turn-with-the-installer?q=

Example configuration for Jitsi, including its fully qualified domain name, authentication secrets for Jicofo and JVB, and timezone. It also shows how to specify STUN servers if Coturn is not used.

```yaml
jitsi_fqdn: jitsi.airgap.private
jicofo_auth_password: "a_secret_password"
jicofo_component_secret: "another_secret_password"
jvb_auth_password: "yet_another_secret_password"
timezone: "Europe/Paris"
helm_override_values: {}
stun_servers:
- ip:port
- ip:port
```

--------------------------------

### Make Admin API Request using cURL

Source: https://docs.element.io/latest/element-support/advanced-administration/getting-started-using-the-admin-api

This example demonstrates how to make a GET request to the Synapse Admin API to retrieve user information, using an Authorization header for authentication. Replace the placeholder token with your actual access token.

```bash
curl --header "Authorization: Bearer syt_AjfVef2_L33JNpafeif_0feKJfeaf0CQpoZk" -X GET http://127.0.0.1:8008/_synapse/admin/v2/users/@foo:example.com

```

--------------------------------

### Authenticate Python Requests to Client-Server API

Source: https://docs.element.io/latest/element-support/advanced-administration/getting-started-using-the-client-server-api?q=

This Python script demonstrates how to make an authenticated GET request to a Client-Server API endpoint using the `requests` library. Ensure you have the library installed and replace the placeholder token and homeserver URL with your actual credentials.

```python
import requests

headers = {
    'Authorization': 'Bearer syt_AjfVef2_L33JNpafeif_0feKJfeaf0CQpoZk',
}

response = requests.get('https://HOMESERVER_URL/_matrix/client/v0/profile/@user:example.com', headers=headers)

```

--------------------------------

### Send setup-widget command (Mac/Linux)

Source: https://docs.element.io/latest/element-support/bridges/setting-up-hookshot-without-e2ee-support-in-encrypted-rooms?q=

Use this cURL command to send the setup-widget command to an encrypted room when E2EE is not enabled for Hookshot. Replace placeholders with your server details, room ID, and access token.

```bash
curl --request PUT \
  --url 'https://domain-where-your-matrix-server-is-exposed/_matrix/client/r0/rooms/room-id/send/m.room.message/1234' \
  --header 'Authorization: Bearer access-token' \
  --header 'content-type: application/json' \
  --data '{
  "msgtype":"m.text",
  "body":"!hookshot setup-widget"
}'
```

```bash
curl --request PUT \
  --url 'https://localhost:8448/_matrix/client/r0/rooms/%21QrmxBsBKPajykCohPz:localhost:8448/send/m.room.message/1234' \
  --header 'Authorization: Bearer syt_YWRtaW4_epoEMAUauwwFpsOGJxIg_471LjM' \
  --header 'content-type: application/json' \
  --data '{
  "msgtype":"m.text",
  "body":"!hookshot setup-widget"
}'
```

--------------------------------

### Example Synapse Federation Key Server Response

Source: https://docs.element.io/latest/element-server-suite-classic/installation-of-core-components/synapse-section-federation

This JSON response is obtained by accessing the `GET /_matrix/key/v2/server` endpoint on a Synapse homeserver. It provides the server's name, valid until timestamp, and verification keys required for establishing trusted federation connections.

```json
{
  "old_verify_keys": {},
  "server_name": "element.io",
  "signatures": {
    "element.io": {
      "ed25519:DnK8xk": "oOgEpir32XvnuMXQs+GvB6nOuIWgYathJ8kbzDhh9TT/BVSEH116Kk9NYUVPeXHJO0HhzBeTjmAiuUTVFS8nCg"
    }
  },
  "valid_until_ts": 1715307962481,
  "verify_keys": {
    "ed25519:DnK8xk": {
      "key": "EgdGx+0oy/9IX5k7tCobr0JoiwMvmmQ8sDOVlZODh/o"
    }
  }
}

```

--------------------------------

### Set Pusher Example (Client-Server API)

Source: https://docs.element.io/latest/element-support/element-androidios-client-settings/understanding-push-notifications

Demonstrates the JSON payload structure for registering a pusher on a Matrix homeserver, including app details, device information, and the push key.

```json
{
  "pushers": [
    {
      "app_display_name": "Appy McAppface",
      "app_id": "face.mcapp.appy.prod",
      "data": {
        "url": "https://example.com/_matrix/push/v1/notify"
      },
      "device_display_name": "Alice's Phone",
      "kind": "http",
      "lang": "en-US",
      "profile_tag": "xyz",
      "pushkey": "Xp/MzCt8/9DcSNE9cuiaoT5Ac55job3TdLSSmtmYl4A="
    }
  ]
}

```

--------------------------------

### Install Snapd and Python venv on Debian 12

Source: https://docs.element.io/latest/element-server-suite-classic/requirements-and-recommendations

These commands are required for Debian 12 installations in addition to standard Ubuntu steps. Ensure snapd is installed and functional.

```bash
sudo apt install snapd python3-venv
sudo snap install snapd

```

--------------------------------

### Send 'setup-widget' command using PowerShell (Windows)

Source: https://docs.element.io/latest/element-support/bridges/setting-up-hookshot-without-e2ee-support-in-encrypted-rooms

Use this PowerShell command to send the setup command to Hookshot in an encrypted room when E2EE is not supported by Hookshot. Replace placeholders with your Matrix server details, room ID, and access token.

```powershell
$url = "https://domain-where-your-matrix-server-is-exposed/_matrix/client/r0/rooms/room-id/send/m.room.message/1234"

$headers = @{
    "Authorization" = "Bearer access-token"
    "Content-Type" = "application/json"
}

$body = @{
    msgtype = "m.text"
    body = "!hookshot setup-widget"
} | ConvertTo-Json

Invoke-RestMethod -Uri $url -Method Put -Headers $headers -Body $body

```

--------------------------------

### Synapse Worker Values Example

Source: https://docs.element.io/latest/element-server-suite-pro/release-notes?q=

Example demonstrating how to update Synapse worker values to show examples for worker types, rather than duplicating values for each worker type.

```yaml
synapse:
  workers:
    worker-type-example:
      image:
        repository: matrixdotorg/synapse
        tag: "1.152.0"
      replicas: 1
      resources: {}
      config:
        loggers:
          synapse.storage.data_stores.db.engines.postgres:
            level: INFO
      functionality:
        - federation: true
        - message_queue: true
        - presence: true
        - push_notifications: true
        - registration_requires_3pid: true
        - room_list: true
        - shared_secret_registration_tokens: true
        - user_directory: true
        - user_stats: true

```

--------------------------------

### Upgrade microk8s using Installer (Prior to 24.04.05)

Source: https://docs.element.io/latest/element-server-suite-classic/post-installation-essentials?q=

Upgrade microk8s by running the installer with the --upgrade-cluster flag, followed by an unattended installation after the machine reboots. This method involves downtime.

```bash
./<installer>.bin --upgrade-cluster
./<installer>.bin unattended

```

--------------------------------

### User Provisioner Configuration Example

Source: https://docs.element.io/latest/element-server-suite-pro/advanced-identity-management/overview?q=

This snippet details the configuration for the userProvisioner, focusing on enabling and configuring deprovisioning, including soft delete periods for delayed account erasure.

```yaml
userProvisioner:
  # Optional. Configure to enable user deprovisioning. Disabled by default.
  deprovisioning:
    enabled: false
    # Optional. When users get removed from the directory their accounts will only be deactivated,
    # but their erasure will be delayed by the specified time period, allowing them to be reactivated in the meantime.
    # The format is <amount><unit>, with amount being numeric and unit being one of: [s, m, h, d], for seconds, minutes,
    # hours or days respectively (for example: "24h", "31d" etc.).
    # The specified period will be translated into seconds, so won't account for things like DST, leap seconds etc.
    # Users will be deleted *no sooner* than that, but may be removed a bit later, depending on other Advanced Identity Management operations.
    # By default set to 30 days.
    soft_delete_period: '30d'
```

--------------------------------

### Example `deployment.yml` Domain Configuration

Source: https://docs.element.io/latest/element-server-suite-classic/installation-of-core-components/domains-section

This YAML snippet shows the structure for configuring fully-qualified domain names (FQDNs) for various Element Server Suite components within the `deployment.yml` file. It includes settings for Element Web, Integrator, Matrix Authentication Service, Synapse, and Synapse Admin, along with the global domain name.

```yaml
spec:
  components:
    elementWeb:
      k8s:
        ingress:
          fqdn: element.example.com
    integrator:
      k8s:
        ingress:
          fqdn: integrator.example.com
    matrixAuthenticationService:
      k8s:
        ingress:
          fqdn: mas.example.com
    synapse:
      k8s:
        ingress:
          fqdn: synapse.example.com
    synapseAdmin:
      k8s:
        ingress:
          fqdn: admin.example.com
  global:
    config:
      domainName: example.com

```

--------------------------------

### Show Synapse Configuration (2023-05-05 and Later)

Source: https://docs.element.io/latest/element-server-suite-classic/support-and-troubleshooting/troubleshooting

Fetch the Synapse instance template configuration for installers version 2023-05-05 and later. This command decodes the base64 encoded instance_template.yaml.

```bash
kubectl --namespace element-onprem get secrets first-element-deployment-synapse-main --output jsonpath='{.data.instance_template\.yaml}' | base64 --decode
```

--------------------------------

### Install PostgreSQL using Helm

Source: https://docs.element.io/latest/element-server-suite-classic/requirements-and-recommendations

Installs the PostgreSQL instance into a specified Kubernetes namespace using the Helm chart and the custom `values.yaml` file. Ensure the namespace is created if it doesn't exist.

```bash
# format:
# helm install --create-namespace -n <namespace> <helm-release-name> <repo/chart> -f <values file> (-f <additional values file>)
helm install --create-namespace -n postgresql postgresql bitnami/postgresql -f values.yaml
```

--------------------------------

### Install Cert-Manager

Source: https://docs.element.io/latest/element-server-suite-pro/setting-up-ess-pro-helm-chart?q=

Installs Cert-Manager version v1.17.0 into the 'cert-manager' namespace. Ensures CRDs are enabled.

```bash
helm install \
  cert-manager jetstack/cert-manager \
  --namespace cert-manager \
  --create-namespace \
  --version v1.17.0 \
  --set crds.enabled=true

```

--------------------------------

### Teams Bridge Configuration Example

Source: https://docs.element.io/latest/element-server-suite-classic/integrations/setting-up-the-teams-bridge?q=

This is a sample configuration block for setting up a Teams Bridge. It includes essential parameters like bot display name, sender local part, and welcome room settings. Ensure all properties for each bridged group are correctly set.

```yaml
bot_display_name: Teams Bridge Bot
bot_sender_localpart: teams-bot
enable_welcome_room: true
welcome_room_text: |
 Welcome, your Element host is configured to bridge to a Teams instance.

 This means that Microsoft Teams messages will appear on your Element
 account and you can send messages in Element rooms to have them appear
 on teams.

 To allow Element to access your Teams account, please say `login` and
 follow the steps to get connected. Once you are connected, you can open
 the 🧭 Explore Rooms dialog to find your Teams rooms.

# namespaces_prefix_user: OPTIONAL: default to _teams_
# namespaces_prefix_aliases: OPTIONAL: default to teams_
```
Tokens:
Raw