

= mycloud-matrix

image::https://img.shields.io/badge/Version-0.1.0-informational?style=flat-square[Version: 0.1.0]
image::https://img.shields.io/badge/Version-application-informational?style=flat-square[Type: application]
== Maintainers

.Maintainers
|===
| Name | Email | Url

| WrenIX
|
| <https://wrenix.eu>
|===

== Values

.Values Commons
|===
| Key | Type | Default | Description

| commons.auth.host
| string
| `nil`
| default auth.(.Values.commons.ingress.domain)

| commons.masterPassword
| string
| `"CHANGEME"`
| masterPassword to generate secrets
|===

.Values Commons Monitoring
|===
| Key | Type | Default | Description

| commons.grafana.dashboards.annotations
| string
| `nil`
| annotations of grafana dashboard configmap

| commons.grafana.dashboards.labels
| object
| `{"grafana_dashboard":"1"}`
| labels of grafana dashboard configmap

| commons.prometheus.monitor.labels
| object
| `{}`
| labels on Pod- and Service-Monitor

| commons.prometheus.rules.labels
| object
| `{}`
| labels on PrometheusRules
|===

.Values Commons helm release
|===
| Key | Type | Default | Description

| commons.helm.release.driftDetection
| object
| `{}`
| driftDetection of FluxCD HelmRelease

| commons.helm.release.install
| object
| `{}`
| install of FluxCD HelmRelease

| commons.helm.release.test
| object
| `{}`
| test of FluxCD HelmRelease

| commons.helm.release.upgrade
| object
| `{}`
| upgrade of FluxCD HelmRelease
|===

.Values Commons Ingress
|===
| Key | Type | Default | Description

| commons.ingress.annotations
| object
| `{"cert-manager.io/cluster-issuer":"letsencrypt-prod"}`
| annotations for all ingress objects

| commons.ingress.domain
| string
| `"wrenix.eu"`
| top domain for all services

| commons.ingress.tls.enabled
| bool
| `true`
| tls on every ingress

| commons.ingress.tls.override
| string
| `nil`
| use own definition of tls (e.g. for own or wildcard certificate)
|===

.Values Commons mail
|===
| Key | Type | Default | Description

| commons.mail.from
| string
| `nil`
| send from address

| commons.mail.host
| string
| `nil`
| smtp server

| commons.mail.password
| string
| `nil`
| smtp password

| commons.mail.use_ssl
| bool
| `false`
| smtp server use ssl

| commons.mail.use_tls
| bool
| `false`
| smtp server use start tls

| commons.mail.username
| string
| `nil`
| smtp username
|===

.Values Commons Persistence
|===
| Key | Type | Default | Description

| commons.persistence.hostPath.enabled
| bool
| `false`
| use hostPath instatt of PVC

| commons.persistence.hostPath.prefix
| string
| `"/var/lib/mycloud"`
| use hostPath under the following path

| commons.persistence.storageClass
| string
| `nil`
| storageClass of PVC
|===

.Values Commons theme
|===
| Key | Type | Default | Description

| commons.theme.favicon
| string
| `"/static/dist/assets/icons/icon.png"`
| favicon everywhere

| commons.theme.logo
| string
| `"/static/dist/assets/icons/icon_left_brand.svg"`
| logo everywhere

| commons.theme.title
| string
| `"myCloud"`
| title everywhere
|===
.Values Other Values
|===
| Key | Type | Default | Description

| bridge.signal.admins
| list
| `[]`
|

| bridge.signal.enabled
| bool
| `false`
|

| databases.authenticationService.host
| string
| `"mycloud-services-postgresql"`
| default is from mycloud-services

| databases.authenticationService.name
| string
| `"matrix-authentication-service"`
|

| databases.authenticationService.password
| string
| `nil`
| generated by .commons.masterPassword (equal to mycloud-services)

| databases.authenticationService.username
| string
| `"matrix-authentication-service"`
|

| databases.bridge.signal.host
| string
| `"mycloud-services-postgresql"`
| default is from mycloud-services

| databases.bridge.signal.name
| string
| `"matrix-bridge-signal"`
|

| databases.bridge.signal.password
| string
| `nil`
| generated by .commons.masterPassword (equal to mycloud-services)

| databases.bridge.signal.username
| string
| `"matrix-bridge-signal"`
|

| databases.server.host
| string
| `"mycloud-services-postgresql"`
| default is from mycloud-services

| databases.server.name
| string
| `"matrix-synapse"`
|

| databases.server.password
| string
| `nil`
| generated by .commons.masterPassword (equal to mycloud-services)

| databases.server.username
| string
| `"matrix-synapse"`
|

| databases.slidingSync.host
| string
| `"mycloud-services-postgresql"`
| default is from mycloud-services

| databases.slidingSync.name
| string
| `"matrix-sliding-sync"`
|

| databases.slidingSync.password
| string
| `nil`
| generated by .commons.masterPassword (equal to mycloud-services)

| databases.slidingSync.username
| string
| `"matrix-sliding-sync"`
|

| ingress.authenticationService.annotations
| string
| `nil`
|

| ingress.authenticationService.host
| string
| `nil`
| default: auth.matrix.(.commons.ingress.domain)

| ingress.element.annotations
| string
| `nil`
|

| ingress.element.enabled
| bool
| `true`
|

| ingress.element.host
| string
| `nil`
| default: element.(.commons.ingress.domain)

| ingress.hydrogen.annotations
| string
| `nil`
|

| ingress.hydrogen.enabled
| bool
| `false`
|

| ingress.hydrogen.host
| string
| `nil`
| default: hydrogen.(.commons.ingress.domain)

| ingress.server.annotations
| string
| `nil`
|

| ingress.server.host
| string
| `nil`
| default: matrix.(.commons.ingress.domain)

| ingress.slidingSync.annotations
| string
| `nil`
|

| ingress.slidingSync.host
| string
| `nil`
| default: sliding.matrix.(.commons.ingress.domain)

| init.namespace
| string
| `"bases"`
|

| init.version
| int
| `0`
|

| persistence.size
| string
| `"16Gi"`
|

| persistence.storageClass
| string
| `nil`
|

| server.auth.clientID
| string
| `nil`
| generated by .commons.masterPassword

| server.auth.clientSecret
| string
| `nil`
| generated by .commons.masterPassword

| server.auth.webClient
| string
| `nil`
| default: element.(.commons.ingress.domain)

| server.authenticationService.admins
| list
| `[]`
|

| server.authenticationService.enabled
| bool
| `false`
|

| server.host
| string
| `nil`
| default: (commons.ingress.domain)

| server.mail.from
| string
| `nil`
| generade by .commons.mail.from

| server.mail.host
| string
| `nil`
| default .commons.mail.host

| server.scaling
| bool
| `false`
|

| server.slidingSync.enabled
| bool
| `false`
|

| server.software
| string
| `"synapse"`
|
|===

Autogenerated from chart metadata using https://github.com/norwoodj/helm-docs[helm-docs]
