You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Latest version of the [Element web app](https://element.io/) to provide a web interface for chat (you can disable this and still use element apps)
42
42
-[Coturn TURN server subchart](https://github.com/small-hack/coturn-chart) for VoIP calls
43
43
- Use s3 to store media using [element-hq/synapse-s3-storage-provider](https://github.com/matrix-org/synapse-s3-storage-provider/tree/main)
44
-
- Use [matrix-sliding-sync-chart](https://github.com/small-hack/matrix-sliding-sync-chart) as a sub chart for using [element-x] which requires [matrix-org/sliding-sync](https://github.com/matrix-org/sliding-sync) (Note: as of Synapse [v1.114.0](https://github.com/element-hq/synapse/releases/tag/v1.114.0) you can now use simplified sliding sync, which doesn't require the separate proxy chart)
45
-
- Use existing Kubernetes secrets and existing Persistent Volume Claims
44
+
- Use existing Kubernetes Secrets and existing Persistent Volume Claims
46
45
-[mautrix/discord](https://github.com/mautrix/discord) - Discord bridge for syncing between matrix and Discord
47
46
-[small-hack/matrix-alertmanager](https://github.com/small-hack/matrix-alertmanager) - Prometheus Alertmanager bridge for syncing between matrix and Alertmanager
48
47
48
+
49
+
#### Features that may not be needed anymore
50
+
51
+
- Use [matrix-sliding-sync-chart](https://github.com/small-hack/matrix-sliding-sync-chart) as a sub chart for using [element-x] which requires [matrix-org/sliding-sync](https://github.com/matrix-org/sliding-sync) (Note: as of Synapse [v1.114.0](https://github.com/element-hq/synapse/releases/tag/v1.114.0) you can now use simplified sliding sync, which doesn't require the separate proxy chart [more info here](https://matrix.org/blog/2024/10/29/matrix-2.0-is-here/#1-simplified-sliding-sync))
52
+
49
53
#### ⚠️ Untested Features
50
54
51
55
These features still need to be tested, but are technically baked into the chart from the fork:
Copy file name to clipboardExpand all lines: charts/matrix/README.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -491,7 +491,7 @@ A Helm chart to deploy a Matrix homeserver stack on Kubernetes
491
491
| mas.configVolume.existingClaim | string |`""`| name of an existing persistent volume claim to use for matrix-authentication-service config. If provided, ignores mas parameter map |
492
492
| mas.configVolume.storage | string |`"500Mi"`| storage capacity for creating a persistent volume |
493
493
| mas.configVolume.storageClassName | string |`"default"`| name of storage class for the persistent volume |
494
-
| mas.enabled | bool |`false`| enable the MAS (Matrix Authentication Service) sub chart to use OIDC This is the only way that's tested to use with element-x beta right now You must also fill out matrix.experimental_feature.masc3861 if you use this method |
494
+
| mas.enabled | bool |`false`| enable the MAS (Matrix Authentication Service) sub chart to use OIDC This is the only way that's tested to use with element-x beta right now You must also fill out matrix.experimental_feature.msc3861 if you use this method |
495
495
| mas.existingMasConfigSecret | string |`""`| Existing Kubernetes Secret for entire matrix authentication service `config.yaml` file. If set, everything under the mas section of the values.yaml is ignored. |
496
496
| mas.externalDatabase.database | string |`"mas"`| name of the database to try and connect to |
497
497
| mas.externalDatabase.enabled | bool |`false`| enable using an external database *instead of* the Bitnami PostgreSQL sub-chart if externalDatabase.enabled is set to true, postgresql.enabled must be set to false |
@@ -684,11 +684,11 @@ A Helm chart to deploy a Matrix homeserver stack on Kubernetes
684
684
| matrix.logging.sqlLogLevel | string |`"WARNING"`| beware: increasing this to DEBUG will make synapse log sensitive information such as access tokens. |
685
685
| matrix.logging.synapseLogLevel | string |`"WARNING"`| The log level for the synapse server |
686
686
| matrix.msc3861ExistingSecret | string |`""`| use an existing secret for all msc3861 (matrix authentication service) related values if set, all other msc3861 values are ignored (issuer, client_id, client_auth_method, client_secret, admin_token, account_management_url) |
687
-
| matrix.msc3861SecretKeys.account_management_url | string |`""`| secret key to use in existing secret for masc3861 account_management_url |
688
-
| matrix.msc3861SecretKeys.admin_token | string |`""`| secret key to use in existing secret for masc3861 admin_token |
689
-
| matrix.msc3861SecretKeys.client_id | string |`""`| secret key to use in existing secret for masc3861 client id |
690
-
| matrix.msc3861SecretKeys.client_secret | string |`""`| secret key to use in existing secret for masc3861 client secret |
691
-
| matrix.msc3861SecretKeys.issuer | string |`""`| secret key to use in existing secret for masc3861 issuer |
687
+
| matrix.msc3861SecretKeys.account_management_url | string |`""`| secret key to use in existing secret for msc3861 account_management_url |
688
+
| matrix.msc3861SecretKeys.admin_token | string |`""`| secret key to use in existing secret for msc3861 admin_token |
689
+
| matrix.msc3861SecretKeys.client_id | string |`""`| secret key to use in existing secret for msc3861 client id |
690
+
| matrix.msc3861SecretKeys.client_secret | string |`""`| secret key to use in existing secret for msc3861 client secret |
691
+
| matrix.msc3861SecretKeys.issuer | string |`""`| secret key to use in existing secret for msc3861 issuer |
692
692
| matrix.oidc.enabled | bool |`false`| set to true to enable authorization against an OpenID Connect server unless using OIDC on synapse AND you want to allow usage of Element-X (the beta of element), then you must set experimental_feature.msc3861.enabled to True to use the MAS (Matrix Authentication Service) and fill out the values there. |
693
693
| matrix.oidc.existingSecret | string |`""`| existing secret to use for the OIDC config |
694
694
| matrix.oidc.providers | list |`[{"authorization_endpoint":"https://accounts.example.com/oauth2/auth","backchannel_logout_enabled":true,"client_auth_method":"client_secret_post","client_id":"provided-by-your-issuer","client_secret":"provided-by-your-issuer","discover":true,"idp_brand":"","idp_id":"","idp_name":"","issuer":"https://accounts.example.com/","scopes":["openid","profile"],"skip_verification":false,"token_endpoint":"https://accounts.example.com/oauth2/token","user_mapping_provider":{"config":{"display_name_template":"","localpart_template":"","picture_template":"{{ user.data.profile_image_url }}","subject_claim":""}},"userinfo_endpoint":"https://accounts.example.com/userinfo"}]`| each of these will be templated under oidc_providers in homeserver.yaml ref: https://element-hq.github.io/synapse/latest/openid.html?search=|
@@ -824,7 +824,7 @@ A Helm chart to deploy a Matrix homeserver stack on Kubernetes
| synapse.service.port | int |`80`| service port for synapse |
826
826
| synapse.service.type | string |`"ClusterIP"`| service type for synpase |
827
-
| syncv3.enabled | bool |`false`| enable sliding sync (required for using element-x). You can see all possible values [here](https://github.com/small-hack/matrix-sliding-sync-chart). If enabled, you must also provide `matrix.extra_well_known_client_content`|
827
+
| syncv3.enabled | bool |`false`| enable the sliding sync proxy (required for using element-x if using Synapse older than v1.114). You can see all possible values [here](https://github.com/small-hack/matrix-sliding-sync-chart). If enabled, you must also provide `matrix.extra_well_known_client_content`. After Synapse v1.114, this is no longer required. Learn more in the matrix [blog post](https://matrix.org/blog/2024/10/29/matrix-2.0-is-here/#1-simplified-sliding-sync)|
828
828
| syncv3.existingEnvSecret | string |`""`| existing kubernetes secret for ALL syncv3 env vars listed below. if set, ignores all values under syncv3 including syncv3.db and syncv3.otlp. |
829
829
| syncv3.externalDatabase.database | string |`"syncv3"`| name of the database to try and connect to |
830
830
| syncv3.externalDatabase.enabled | bool |`false`| enable using an external database *instead of* the Bitnami PostgreSQL sub-chart if externalDatabase.enabled is set to true, postgresql.enabled must be set to false |
@@ -890,4 +890,4 @@ A Helm chart to deploy a Matrix homeserver stack on Kubernetes
890
890
| volumes.synapseConfig.storageClass | string |`""`| Storage class (optional) |
891
891
892
892
----------------------------------------------
893
-
Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
893
+
Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)
0 commit comments