Docs
Helm-Charts
matrix-synapse

matrix-synapse

matrix-synapse

Version: 2.0.10 Type: application AppVersion: 1.145.0

Matrix reference homeserver

Maintainers

NameEmailUrl
WrenIXhttps://wrenix.eu

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

Requirements

RepositoryNameVersion
https://valkey.io/valkey-helm/valkey^0.9.3
oci://docker.io/bitnamichartspostgresql^16.3.1

Values

KeyTypeDefaultDescription
config.bindAddresseslist["::"]The bind addresses to use for the default listeners
config.extraListenerslist[]
config.extraMainListenerTypeslist[]
config.reportStatsboolfalse
config.trustedKeyServerslist[{"server_name":"matrix.org"}]A set of trusted servers to contact if another server doesn’t respond to a signing key request.
config.useStructuredLoggingboolfalse
externalPostgresql.databasestring"synapse"
externalPostgresql.extraArgsobject{"cp_max":10,"cp_min":5}Extra arguments for the database connection ref: https://github.com/matrix-org/synapse/blob/develop/docs/postgres.md#synapse-config
externalPostgresql.optionsobject{}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.portint5432
externalPostgresql.sslmodestring"prefer"set sslmode
externalPostgresql.usernamestring"synapse"
extraConfigobject{}
extraLoggersobject{}
extraSecretsobject{}
fullnameOverridestringnilOverride the full name of the installed chart.
global.image.pullPolicystringnilif set it will overwrite all pullPolicy
global.image.registrystringnilif set it will overwrite all registry entries
grafana.dashboards.allowCrossNamespaceImportboolfalsejust for GrafanaDashboard resource
grafana.dashboards.annotationsobject{}
grafana.dashboards.enabledboolfalse
grafana.dashboards.folderRefstring""just for GrafanaDashboard resource
grafana.dashboards.instanceSelectorobject{}if defined and grafana-operator deployed it setup instatt an GrafanaDashboard resource
grafana.dashboards.labels.grafana_dashboardstring"1"
image.pullPolicystring"IfNotPresent"This sets the pull policy for images. (could be overwritten by global.image.pullPolicy)
image.pullSecretslist[]Optionally specify an array of imagePullSecrets. Secrets must be manually created in the namespace. ref: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/
image.registrystring"ghcr.io"image registry (could be overwritten by global.image.registry)
image.repositorystring"element-hq/synapse"image repository
image.tagstringnilOverrides the image tag whose default is the chart appVersion.
ingress.annotationsobject{}
ingress.csHostslist[]
ingress.csPathslist[]
ingress.enabledbooltrue
ingress.hostslist[]
ingress.includeServerNamebooltrue
ingress.includeUnderscoreSynapsebooltrue
ingress.pathslist[]
ingress.tlslist[]
ingress.traefikPathsboolfalse
ingress.wkHostslist[]
nameOverridestringnilOverride part of the installed name, will still keep release name.
persistence.accessModestring"ReadWriteOnce"
persistence.annotationsobject{}
persistence.enabledbooltrue
persistence.existingClaimstringnilA manually managed Persistent Volume and Claim Requires persistence.enabled: true If defined, PVC must be created manually before volume will be bound
persistence.hostPathstringnilDo not create an PVC, direct use hostPath in Pod
persistence.sizestring"10Gi"
persistence.storageClassstringnilPersistent Volume Storage Class If defined, storageClassName: 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.databasestring"synapse"
postgresql.auth.passwordstring"synapse"
postgresql.auth.usernamestring"synapse"
postgresql.enabledbooltrue
postgresql.extraArgsobject{"cp_max":10,"cp_min":5}Extra arguments for the database connection ref: https://github.com/matrix-org/synapse/blob/develop/docs/postgres.md#synapse-config
postgresql.image.repositorystring"bitnamilegacy/postgresql"
postgresql.optionsobject{}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.argsstring"--lc-collate=C --lc-ctype=C"
postgresql.primary.persistence.sizestring"16Gi"
postgresql.sslmodestring"prefer"set sslmode
prometheus.podmonitor.enabledboolfalse
prometheus.podmonitor.labelsobject{}
prometheus.rules.additionalRuleslist[]
prometheus.rules.defaults.enabledbooltrue
prometheus.rules.enabledboolfalse
prometheus.rules.labelsobject{}
publicServerNamestringnilThe public Matrix server name, this will be used for any public URLs in config as well as for client API links in the ingress.
serverNamestringnilThe Matrix domain name, this is what will be used for the domain part in your MXIDs.
service.portint8008
service.targetPortstring"http"
service.typestring"ClusterIP"
serviceAccount.annotationsobject{}
serviceAccount.createboolfalse
signingkey.annotationsobject{"helm.sh/hook":"pre-install,pre-upgrade","helm.sh/hook-delete-policy":"before-hook-creation,hook-succeeded"}Annotations to apply to the job and rbac for signing-key.
signingkey.job.enabledbooltrue
signingkey.job.publishImage.pullPolicystring"IfNotPresent"
signingkey.job.publishImage.registrystring"docker.io"
signingkey.job.publishImage.repositorystring"alpine/kubectl"
signingkey.job.publishImage.tagstring"1.35.0"
signingkey.resourcesobject{}
synapse.affinityobject{}
synapse.annotationsobject{}
synapse.extraCommandslist[]
synapse.extraEnvlist[]
synapse.extraVolumeMountslist[]
synapse.extraVolumeslist[]
synapse.labelsobject{}
synapse.livenessProbe.httpGet.pathstring"/health"
synapse.livenessProbe.httpGet.portstring"http"
synapse.nodeSelectorobject{}
synapse.podSecurityContextobject{}
synapse.readinessProbe.httpGet.pathstring"/health"
synapse.readinessProbe.httpGet.portstring"http"
synapse.resourcesobject{}
synapse.securityContextobject{}
synapse.startupProbe.failureThresholdint12
synapse.startupProbe.httpGet.pathstring"/health"
synapse.startupProbe.httpGet.portstring"http"
synapse.strategy.typestring"RollingUpdate"
synapse.tolerationslist[]
valkey.auth.aclUsers.default.passwordstring"synapse"
valkey.auth.aclUsers.default.passwordKeystring""
valkey.auth.aclUsers.default.permissionsstring"~* &* +@all"
valkey.auth.enabledboolfalse
valkey.auth.usersExistingSecretstring""
valkey.dataStorage.classNamestring""
valkey.dataStorage.keepPvcbooltrue
valkey.dbidint0Database ID for non-default database
valkey.external.hoststring"valkey"
valkey.external.portint6379
valkey.external.userstring"default"used together with from valkey.auth.usersExistingSecret and valkey.auth.aclUsers.
valkey.internalbooltrueThis configuration enabled valkey that’s deployed for use with workers/sharding, for an external valkey/redis server you want to set false and configure the external block.
valkey.service.portint6379
volumePermissions.enabledboolfalse
volumePermissions.gidint666
volumePermissions.image.pullPolicystring"Always"
volumePermissions.image.registrystring"docker.io"
volumePermissions.image.repositorystring"library/alpine"
volumePermissions.image.tagstring"3.23.2"
volumePermissions.resourcesobject{}
volumePermissions.uidint666
wellknown.affinityobject{}
wellknown.clientobject{}Data to serve on .well-known/matrix/client. m.homeserver: base_url: https://matrix.example.com
wellknown.containerPortint80
wellknown.elementobject{}Data to serve on .well-known/element/element.json call: widget_url: https://call.element.io
wellknown.enabledboolfalse
wellknown.envlist[]
wellknown.image.pullPolicystring"IfNotPresent"
wellknown.image.registrystring"docker.io"
wellknown.image.repositorystring"library/nginx"
wellknown.image.tagstring"1.29.4"
wellknown.nodeSelectorobject{}
wellknown.podAnnotationslist[]
wellknown.podLabelsobject{}
wellknown.podSecurityContextobject{}
wellknown.replicaCountint1
wellknown.resourcesobject{}
wellknown.securityContextobject{}
wellknown.serverobject{}The host and port combo to serve on .well-known/matrix/server. m.server: matrix.example.com:443
wellknown.service.annotationsobject{}
wellknown.service.portint8080
wellknown.service.typestring"ClusterIP"
wellknown.tolerationslist[]
workers.appservice.enabledboolfalse
workers.appservice.genericbooltrue
workers.appservice.namestring"appservices"
workers.default.affinityobject{}
workers.default.annotationsobject{}
workers.default.extraCommandslist[]
workers.default.extraEnvlist[]
workers.default.livenessProbe.httpGet.pathstring"/health"
workers.default.livenessProbe.httpGet.portstring"metrics"
workers.default.nodeSelectorobject{}
workers.default.podSecurityContextobject{}
workers.default.readinessProbe.httpGet.pathstring"/health"
workers.default.readinessProbe.httpGet.portstring"metrics"
workers.default.replicaCountint1
workers.default.resourcesobject{}
workers.default.securityContextobject{}
workers.default.startupProbe.failureThresholdint6
workers.default.startupProbe.httpGet.pathstring"/health"
workers.default.startupProbe.httpGet.portstring"metrics"
workers.default.strategy.typestring"RollingUpdate"
workers.default.tolerationslist[]
workers.default.volumeMountslist[]
workers.default.volumeslist[]
workers.federation_sender.enabledboolfalse
workers.frontend_proxy.csPaths[0]string`"/_matrix/client/(api/v1r0
workers.frontend_proxy.enabledboolfalse
workers.frontend_proxy.listeners[0]string"client"
workers.generic_worker.csPaths[0]string`"/_matrix/client/(api/v1r0
workers.generic_worker.csPaths[10]string`"/_matrix/client/(r0v3
workers.generic_worker.csPaths[11]string`"/_matrix/client/(r0v3
workers.generic_worker.csPaths[12]string`"/_matrix/client/(r0v3
workers.generic_worker.csPaths[13]string"/_matrix/client/versions$"
workers.generic_worker.csPaths[14]string`"/_matrix/client/(api/v1r0
workers.generic_worker.csPaths[15]string`"/_matrix/client/(api/v1r0
workers.generic_worker.csPaths[16]string`"/_matrix/client/(api/v1r0
workers.generic_worker.csPaths[17]string`"/_matrix/client/(api/v1r0
workers.generic_worker.csPaths[18]string`"/_matrix/client/(r0v3
workers.generic_worker.csPaths[19]string`"/_matrix/client/(r0v3
workers.generic_worker.csPaths[1]string`"/_matrix/client/(api/v1r0
workers.generic_worker.csPaths[20]string`"/_matrix/client/(r0v3
workers.generic_worker.csPaths[21]string`"/_matrix/client/(r0v3
workers.generic_worker.csPaths[22]string`"/_matrix/client/(api/v1r0
workers.generic_worker.csPaths[23]string`"/_matrix/client/(r0v3
workers.generic_worker.csPaths[24]string"/_matrix/client/v1/register/m.login.registration_token/validity$"
workers.generic_worker.csPaths[25]string`"/_matrix/client/(api/v1r0
workers.generic_worker.csPaths[26]string`"/_matrix/client/(api/v1r0
workers.generic_worker.csPaths[27]string`"/_matrix/client/(api/v1r0
workers.generic_worker.csPaths[28]string`"/_matrix/client/(api/v1r0
workers.generic_worker.csPaths[29]string`"/_matrix/client/(api/v1r0
workers.generic_worker.csPaths[2]string`"/_matrix/client/(api/v1r0
workers.generic_worker.csPaths[30]string`"/_matrix/client/(api/v1r0
workers.generic_worker.csPaths[31]string`"/_matrix/client/(r0v3
workers.generic_worker.csPaths[3]string`"/_matrix/client/(api/v1r0
workers.generic_worker.csPaths[4]string`"/_matrix/client/(api/v1r0
workers.generic_worker.csPaths[5]string`"/_matrix/client/(api/v1r0
workers.generic_worker.csPaths[6]string`"/_matrix/client/(api/v1r0
workers.generic_worker.csPaths[7]string"/_matrix/client/v1/rooms/.*/hierarchy$"
workers.generic_worker.csPaths[8]string"/_matrix/client/unstable/org.matrix.msc2716/rooms/.*/batch_send$"
workers.generic_worker.csPaths[9]string"/_matrix/client/unstable/im.nheko.summary/rooms/.*/summary$"
workers.generic_worker.enabledboolfalse
workers.generic_worker.genericbooltrue
workers.generic_worker.listeners[0]string"client"
workers.generic_worker.listeners[1]string"federation"
workers.generic_worker.paths[0]string"/_matrix/federation/v1/event/"
workers.generic_worker.paths[10]string`"/_matrix/federation/(v1v2)/send_leave/"`
workers.generic_worker.paths[11]string`"/_matrix/federation/(v1v2)/invite/"`
workers.generic_worker.paths[12]string"/_matrix/federation/v1/event_auth/"
workers.generic_worker.paths[13]string"/_matrix/federation/v1/exchange_third_party_invite/"
workers.generic_worker.paths[14]string"/_matrix/federation/v1/user/devices/"
workers.generic_worker.paths[15]string"/_matrix/key/v2/query"
workers.generic_worker.paths[16]string"/_matrix/federation/v1/hierarchy/"
workers.generic_worker.paths[17]string"/_matrix/federation/v1/send/"
workers.generic_worker.paths[1]string"/_matrix/federation/v1/state/"
workers.generic_worker.paths[2]string"/_matrix/federation/v1/state_ids/"
workers.generic_worker.paths[3]string"/_matrix/federation/v1/backfill/"
workers.generic_worker.paths[4]string"/_matrix/federation/v1/get_missing_events/"
workers.generic_worker.paths[5]string"/_matrix/federation/v1/publicRooms"
workers.generic_worker.paths[6]string"/_matrix/federation/v1/query/"
workers.generic_worker.paths[7]string"/_matrix/federation/v1/make_join/"
workers.generic_worker.paths[8]string"/_matrix/federation/v1/make_leave/"
workers.generic_worker.paths[9]string`"/_matrix/federation/(v1v2)/send_join/"`
workers.media_repository.csPaths[0]string"/_matrix/media/.*"
workers.media_repository.csPaths[1]string"/_synapse/admin/v1/purge_media_cache$"
workers.media_repository.csPaths[2]string"/_synapse/admin/v1/room/.*/media"
workers.media_repository.csPaths[3]string"/_synapse/admin/v1/user/.*/media"
workers.media_repository.csPaths[4]string"/_synapse/admin/v1/media/"
workers.media_repository.csPaths[5]string"/_synapse/admin/v1/quarantine_media/"
workers.media_repository.csPaths[6]string"/_synapse/admin/v1/users/.*/media$"
workers.media_repository.enabledboolfalse
workers.media_repository.listeners[0]string"media"
workers.media_repository.paths[0]string"/_matrix/media/.*"
workers.pusher.enabledboolfalse
workers.user_dir.csPaths[0]string`"/_matrix/client/(api/v1r0
workers.user_dir.enabledboolfalse
workers.user_dir.listeners[0]string"client"
workers.user_dir.namestring"userdir"

Autogenerated from chart metadata using helm-docs

matrix-sliding-syncmautrix-bridge