matrix-synapse
Usage
Helm must be installed and setup to your kubernetes cluster to use the charts. Refer to Helm’s documentation to get started. Once Helm has been set up correctly, fetch the charts as follows:
helm pull oci://codeberg.org/wrenix/helm-charts/matrix-synapse
You can install a chart release using the following command:
helm install matrix-synapse-release oci://codeberg.org/wrenix/helm-charts/matrix-synapse --values values.yaml
To uninstall a chart release use `helm’s delete command:
helm uninstall matrix-synapse-release
Values
Key | Type | Default | Description |
---|---|---|---|
config.bindAddresses |
list |
|
The bind addresses to use for the default listeners |
config.extraListeners |
list |
|
|
config.extraMainListenerTypes |
list |
|
|
config.reportStats |
bool |
|
|
config.trustedKeyServers |
list |
|
A set of trusted servers to contact if another server doesn’t respond to a signing key request. |
config.useStructuredLogging |
bool |
|
|
externalPostgresql.database |
string |
|
|
externalPostgresql.extraArgs |
object |
|
Extra arguments for the database connection ref: https://github.com/matrix-org/synapse/blob/develop/docs/postgres.md#synapse-config |
externalPostgresql.options |
object |
|
set extra configuration ref: https://github.com/matrix-org/synapse/blob/develop/docs/postgres.md#synapse-config e.g. txn_limit, allow_unsafe_locale |
externalPostgresql.port |
int |
|
|
externalPostgresql.username |
string |
|
|
externalRedis.port |
int |
|
|
extraConfig |
object |
|
|
extraLoggers |
object |
|
|
extraSecrets |
object |
|
|
fullnameOverride |
string |
|
Override the full name of the installed chart. |
global.image.pullPolicy |
string |
|
if set it will overwrite all pullPolicy |
global.image.registry |
string |
|
if set it will overwrite all registry entries |
grafana.dashboards.annotations |
object |
|
|
grafana.dashboards.enabled |
bool |
|
|
grafana.dashboards.labels.grafana_dashboard |
string |
|
|
image.pullPolicy |
string |
|
|
image.registry |
string |
|
|
image.repository |
string |
|
|
image.tag |
string |
|
Overrides the image tag whose default is the chart appVersion. |
ingress.annotations |
object |
|
|
ingress.csHosts |
list |
|
|
ingress.csPaths |
list |
|
|
ingress.enabled |
bool |
|
|
ingress.hosts |
list |
|
|
ingress.includeServerName |
bool |
|
|
ingress.includeUnderscoreSynapse |
bool |
|
|
ingress.paths |
list |
|
|
ingress.tls |
list |
|
|
ingress.traefikPaths |
bool |
|
|
ingress.wkHosts |
list |
|
|
nameOverride |
string |
|
Override part of the installed name, will still keep release name. |
persistence.accessMode |
string |
|
|
persistence.annotations |
object |
|
|
persistence.enabled |
bool |
|
|
persistence.existingClaim |
string |
|
A manually managed Persistent Volume and Claim Requires persistence.enabled: true If defined, PVC must be created manually before volume will be bound |
persistence.hostPath |
string |
|
Do not create an PVC, direct use hostPath in Pod |
persistence.size |
string |
|
|
persistence.storageClass |
string |
|
Persistent Volume Storage Class If defined, storageClassName: <storageClass> If set to "-", storageClassName: "", which disables dynamic provisioning If undefined (the default) or set to null, no storageClassName spec is set, choosing the default provisioner. (gp2 on AWS, standard on GKE, AWS & OpenStack) |
postgresql.auth.database |
string |
|
|
postgresql.auth.password |
string |
|
|
postgresql.auth.username |
string |
|
|
postgresql.enabled |
bool |
|
|
postgresql.extraArgs |
object |
|
Extra arguments for the database connection ref: https://github.com/matrix-org/synapse/blob/develop/docs/postgres.md#synapse-config |
postgresql.options |
object |
|
set extra configuration ref: https://github.com/matrix-org/synapse/blob/develop/docs/postgres.md#synapse-config e.g. txn_limit, allow_unsafe_locale |
postgresql.primary.initdb.args |
string |
|
|
postgresql.primary.persistence.size |
string |
|
|
prometheus.podmonitor.enabled |
bool |
|
|
prometheus.podmonitor.labels |
object |
|
|
prometheus.rules.additionalRules |
list |
|
|
prometheus.rules.defaults.enabled |
bool |
|
|
prometheus.rules.enabled |
bool |
|
|
prometheus.rules.labels |
object |
|
|
publicServerName |
string |
|
The public Matrix server name, this will be used for any public URLs in config as well as for client API links in the ingress. |
redis.architecture |
string |
|
|
redis.auth.enabled |
bool |
|
|
redis.auth.password |
string |
|
|
redis.enabled |
bool |
|
|
redis.master.kind |
string |
|
|
redis.master.persistence.enabled |
bool |
|
|
redis.master.service.port |
int |
|
|
serverName |
string |
|
The Matrix domain name, this is what will be used for the domain part in your MXIDs. |
service.port |
int |
|
|
service.targetPort |
string |
|
|
service.type |
string |
|
|
serviceAccount.annotations |
object |
|
|
serviceAccount.create |
bool |
|
|
signingkey.job.annotations |
object |
|
|
signingkey.job.enabled |
bool |
|
|
signingkey.job.publishImage.pullPolicy |
string |
|
|
signingkey.job.publishImage.registry |
string |
|
|
signingkey.job.publishImage.repository |
string |
|
|
signingkey.job.publishImage.tag |
string |
|
|
signingkey.resources |
object |
|
|
synapse.affinity |
object |
|
|
synapse.annotations |
object |
|
|
synapse.extraCommands |
list |
|
|
synapse.extraEnv |
list |
|
|
synapse.extraVolumeMounts |
list |
|
|
synapse.extraVolumes |
list |
|
|
synapse.labels |
object |
|
|
synapse.livenessProbe.httpGet.path |
string |
|
|
synapse.livenessProbe.httpGet.port |
string |
|
|
synapse.nodeSelector |
object |
|
|
synapse.podSecurityContext |
object |
|
|
synapse.readinessProbe.httpGet.path |
string |
|
|
synapse.readinessProbe.httpGet.port |
string |
|
|
synapse.resources |
object |
|
|
synapse.securityContext |
object |
|
|
synapse.startupProbe.failureThreshold |
int |
|
|
synapse.startupProbe.httpGet.path |
string |
|
|
synapse.startupProbe.httpGet.port |
string |
|
|
synapse.strategy.type |
string |
|
|
synapse.tolerations |
list |
|
|
volumePermissions.enabled |
bool |
|
|
volumePermissions.gid |
int |
|
|
volumePermissions.image.pullPolicy |
string |
|
|
volumePermissions.image.registry |
string |
|
|
volumePermissions.image.repository |
string |
|
|
volumePermissions.image.tag |
string |
|
|
volumePermissions.resources |
object |
|
|
volumePermissions.uid |
int |
|
|
wellknown.affinity |
object |
|
|
wellknown.client |
object |
|
Data to serve on .well-known/matrix/client. m.homeserver: base_url: https://matrix.example.com |
wellknown.containerPort |
int |
|
|
wellknown.enabled |
bool |
|
|
wellknown.env |
list |
|
|
wellknown.image.pullPolicy |
string |
|
|
wellknown.image.registry |
string |
|
|
wellknown.image.repository |
string |
|
|
wellknown.image.tag |
string |
|
|
wellknown.nodeSelector |
object |
|
|
wellknown.podAnnotations |
list |
|
|
wellknown.podLabels |
object |
|
|
wellknown.podSecurityContext |
object |
|
|
wellknown.replicaCount |
int |
|
|
wellknown.resources |
object |
|
|
wellknown.securityContext |
object |
|
|
wellknown.server |
object |
|
The host and port combo to serve on .well-known/matrix/server. m.server: matrix.example.com:443 |
wellknown.service.annotations |
object |
|
|
wellknown.service.port |
int |
|
|
wellknown.service.type |
string |
|
|
wellknown.tolerations |
list |
|
|
workers.appservice.enabled |
bool |
|
|
workers.appservice.generic |
bool |
|
|
workers.appservice.name |
string |
|
|
workers.default.affinity |
object |
|
|
workers.default.annotations |
object |
|
|
workers.default.extraCommands |
list |
|
|
workers.default.extraEnv |
list |
|
|
workers.default.livenessProbe.httpGet.path |
string |
|
|
workers.default.livenessProbe.httpGet.port |
string |
|
|
workers.default.nodeSelector |
object |
|
|
workers.default.podSecurityContext |
object |
|
|
workers.default.readinessProbe.httpGet.path |
string |
|
|
workers.default.readinessProbe.httpGet.port |
string |
|
|
workers.default.replicaCount |
int |
|
|
workers.default.resources |
object |
|
|
workers.default.securityContext |
object |
|
|
workers.default.startupProbe.failureThreshold |
int |
|
|
workers.default.startupProbe.httpGet.path |
string |
|
|
workers.default.startupProbe.httpGet.port |
string |
|
|
workers.default.strategy.type |
string |
|
|
workers.default.tolerations |
list |
|
|
workers.default.volumeMounts |
list |
|
|
workers.default.volumes |
list |
|
|
workers.federation_sender.enabled |
bool |
|
|
workers.frontend_proxy.csPaths[0] |
string |
`"/_matrix/client/(api/v1 |
r0 |
v3 |
unstable)/keys/upload"` |
workers.frontend_proxy.enabled |
|
bool |
|
workers.frontend_proxy.listeners[0] |
|
string |
|
workers.generic_worker.csPaths[0] |
|
string |
`"/_matrix/client/(api/v1 |
r0 |
v3)/events$"` |
workers.generic_worker.csPaths[10] |
string |
`"/_matrix/client/(r0 |
|
v3 |
unstable)/account/3pid$"` |
workers.generic_worker.csPaths[11] |
|
string |
`"/_matrix/client/(r0 |
v3 |
unstable)/account/whoami$"` |
workers.generic_worker.csPaths[12] |
string |
`"/_matrix/client/(r0 |
|
v3 |
unstable)/devices$"` |
workers.generic_worker.csPaths[13] |
|
string |
|
workers.generic_worker.csPaths[14] |
|
string |
`"/_matrix/client/(api/v1 |
r0 |
v3 |
unstable)/voip/turnServer$"` |
workers.generic_worker.csPaths[15] |
string |
|
`"/_matrix/client/(api/v1 |
r0 |
v3 |
unstable)/rooms/.*/event/"` |
workers.generic_worker.csPaths[16] |
string |
`"/_matrix/client/(api/v1 |
|
r0 |
v3 |
unstable)/joined_rooms$"` |
|
workers.generic_worker.csPaths[17] |
string |
`"/_matrix/client/(api/v1 |
r0 |
v3 |
unstable)/search$"` |
workers.generic_worker.csPaths[18] |
|
string |
`"/_matrix/client/(r0 |
v3 |
unstable)/keys/query$"` |
workers.generic_worker.csPaths[19] |
string |
`"/_matrix/client/(r0 |
|
v3 |
unstable)/keys/changes$"` |
workers.generic_worker.csPaths[1] |
|
string |
`"/_matrix/client/(api/v1 |
r0 |
v3 |
unstable)/createRoom$"` |
workers.generic_worker.csPaths[20] |
string |
|
`"/_matrix/client/(r0 |
v3 |
unstable)/keys/claim$"` |
|
workers.generic_worker.csPaths[21] |
string |
`"/_matrix/client/(r0 |
v3 |
unstable)/room_keys/"` |
workers.generic_worker.csPaths[22] |
string |
|
`"/_matrix/client/(api/v1 |
r0 |
v3 |
unstable)/login$"` |
workers.generic_worker.csPaths[23] |
string |
`"/_matrix/client/(r0 |
|
v3 |
unstable)/register$"` |
workers.generic_worker.csPaths[24] |
|
string |
|
workers.generic_worker.csPaths[25] |
|
string |
`"/_matrix/client/(api/v1 |
r0 |
v3 |
unstable)/rooms/.*/redact"` |
workers.generic_worker.csPaths[26] |
string |
|
`"/_matrix/client/(api/v1 |
r0 |
v3 |
unstable)/rooms/.*/send"` |
workers.generic_worker.csPaths[27] |
string |
`"/_matrix/client/(api/v1 |
|
r0 |
v3 |
unstable)/rooms/.*/state/"` |
|
workers.generic_worker.csPaths[28] |
string |
`"/_matrix/client/(api/v1 |
r0 |
v3 |
unstable)/rooms/.*/(join |
invite |
leave |
ban |
unban |
kick)$"` |
|
workers.generic_worker.csPaths[29] |
string |
`"/_matrix/client/(api/v1 |
r0 |
v3 |
unstable)/join/"` |
workers.generic_worker.csPaths[2] |
|
string |
`"/_matrix/client/(api/v1 |
r0 |
v3 |
unstable)/publicRooms$"` |
workers.generic_worker.csPaths[30] |
string |
|
`"/_matrix/client/(api/v1 |
r0 |
v3 |
unstable)/profile/"` |
workers.generic_worker.csPaths[31] |
string |
`"/_matrix/client/(r0 |
|
v3 |
unstable)/user_directory/search"` |
workers.generic_worker.csPaths[3] |
|
string |
`"/_matrix/client/(api/v1 |
r0 |
v3 |
unstable)/rooms/.*/joined_members$"` |
workers.generic_worker.csPaths[4] |
string |
|
`"/_matrix/client/(api/v1 |
r0 |
v3 |
unstable)/rooms/.*/context/"` |
workers.generic_worker.csPaths[5] |
string |
`"/_matrix/client/(api/v1 |
|
r0 |
v3 |
unstable)/rooms/.*/members$"` |
|
workers.generic_worker.csPaths[6] |
string |
`"/_matrix/client/(api/v1 |
r0 |
v3 |
unstable)/rooms/.*/state$"` |
workers.generic_worker.csPaths[7] |
|
string |
|
workers.generic_worker.csPaths[8] |
|
string |
|
workers.generic_worker.csPaths[9] |
|
string |
|
workers.generic_worker.enabled |
|
bool |
|
workers.generic_worker.generic |
|
bool |
|
workers.generic_worker.listeners[0] |
|
string |
|
workers.generic_worker.listeners[1] |
|
string |
|
workers.generic_worker.paths[0] |
|
string |
|
workers.generic_worker.paths[10] |
|
string |
`"/_matrix/federation/(v1 |
v2)/send_leave/"` |
|
workers.generic_worker.paths[11] |
string |
`"/_matrix/federation/(v1 |
v2)/invite/"` |
workers.generic_worker.paths[12] |
string |
|
|
workers.generic_worker.paths[13] |
string |
|
|
workers.generic_worker.paths[14] |
string |
|
|
workers.generic_worker.paths[15] |
string |
|
|
workers.generic_worker.paths[16] |
string |
|
|
workers.generic_worker.paths[17] |
string |
|
|
workers.generic_worker.paths[1] |
string |
|
|
workers.generic_worker.paths[2] |
string |
|
|
workers.generic_worker.paths[3] |
string |
|
|
workers.generic_worker.paths[4] |
string |
|
|
workers.generic_worker.paths[5] |
string |
|
|
workers.generic_worker.paths[6] |
string |
|
|
workers.generic_worker.paths[7] |
string |
|
|
workers.generic_worker.paths[8] |
string |
|
|
workers.generic_worker.paths[9] |
string |
`"/_matrix/federation/(v1 |
|
v2)/send_join/"` |
workers.media_repository.csPaths[0] |
string |
|
|
workers.media_repository.csPaths[1] |
string |
|
|
workers.media_repository.csPaths[2] |
string |
|
|
workers.media_repository.csPaths[3] |
string |
|
|
workers.media_repository.csPaths[4] |
string |
|
|
workers.media_repository.csPaths[5] |
string |
|
|
workers.media_repository.csPaths[6] |
string |
|
|
workers.media_repository.enabled |
bool |
|
|
workers.media_repository.listeners[0] |
string |
|
|
workers.media_repository.paths[0] |
string |
|
|
workers.pusher.enabled |
bool |
|
|
workers.user_dir.csPaths[0] |
string |
|
`"/_matrix/client/(api/v1 |
r0 |
v3 |
unstable)/user_directory/search$"` |
workers.user_dir.enabled |
bool |
|
|
workers.user_dir.listeners[0] |
string |
|
|
workers.user_dir.name |
string |
|
Autogenerated from chart metadata using helm-docs