https://github.com/remram44/matrix-helm

A Helm Chart for matrix.org (Synapse and Element Web)
https://github.com/remram44/matrix-helm

matrix

Last synced: 21 days ago
JSON representation

A Helm Chart for matrix.org (Synapse and Element Web)

• Host: GitHub
• URL: https://github.com/remram44/matrix-helm
• Owner: remram44
• Created: 2023-01-20T15:00:58.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2024-10-15T18:14:14.000Z (29 days ago)
• Last Synced: 2024-10-17T02:37:16.303Z (28 days ago)
• Topics: matrix
• Language: Smarty
• Homepage:
• Size: 148 KB
• Stars: 15
• Watchers: 2
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Helm chart for Matrix (Synapse + Element)

You can use this Helm chart to deploy Synapse, its backing PostgreSQL database, and the Element-Web frontend.

```

helm repo add matrix https://remram44.github.io/matrix-helm

helm install chat matrix/matrix --namespace chat -f values.yaml

```

For example, to deploy both Synapse and Element at `chat.example.org`, with the domain part being simply `example.org` (e.g. `@user:example.org`, `#room:example.org`):

```yaml

homeserverConfig:

  server_name: example.org

  public_baseurl: https://chat.example.org/

  web_client_location: https://chat.example.org/

  email:

    app_name: Example Chat

ingress:

  enabled: true

  hosts:

    - chat.example.org

  tls:

    - hosts:

        - chat.example.org

        - example.org

element:

  config:

    default_server_config:

      m.homeserver:

        base_url: https://chat.example.org

        server_name: Example Chat

  ingress:

    enabled: true

    host: chat.example.org

```

You can also use a different domain for Synapse and Element, for example:

```yaml

homeserverConfig:

  server_name: example.org

  public_baseurl: https://synapse.example.org/

  web_client_location: https://element.example.org/

  email:

    app_name: Example Chat

ingress:

  enabled: true

  hosts:

    - synapse.example.org

  tls:

    - hosts:

        - synapse.example.org

        - example.org

element:

  config:

    default_server_config:

      m.homeserver:

        base_url: https://synapse.example.org

        server_name: Example Chat

  ingress:

    enabled: true

    host: element.example.org

```

For a list of the settings allowed in `homeserverConfig`, check out [Synapse's own documentation](https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html).

# Why do you use a custom Element image?

The official Element image, [`docker.io/vectorim/element-web`](https://hub.docker.com/r/vectorim/element-web), runs as root and is only built for a few architectures. The [image](https://github.com/users/remram44/packages/container/package/matrix-helm%2Felement) in this repo (`element/`) is built from [`docker.io/nginxinc/nginx-unprivileged`](https://hub.docker.com/r/nginxinc/nginx-unprivileged).