Commit released Helm Chart and docs for TrueCharts

Signed-off-by: TrueCharts-Bot <bot@truecharts.org>
This commit is contained in:
TrueCharts-Bot 2022-01-23 23:26:17 +00:00
parent 6e5e9da04c
commit 630447c1d1
12 changed files with 437 additions and 2 deletions

View File

@ -0,0 +1,10 @@
# Changelog<br>
<a name="synapse-0.0.1"></a>
### synapse-0.0.1 (2022-01-23)
#### Feat
* add synapse ([#1768](https://github.com/truecharts/apps/issues/1768))

View File

@ -0,0 +1,8 @@
# Configuration Options
##### Connecting to other apps
If you need to connect this App to other Apps on TrueNAS SCALE, please refer to our "Linking Apps Internally" quick-start guide:
https://truecharts.org/manual/Quick-Start%20Guides/14-linking-apps/
##### Available config options
In the future this page is going to contain an automated list of options available in the installation/edit UI.

View File

@ -1,5 +1,5 @@
apiVersion: v2
appVersion: "23.0.0"
appVersion: "1.50.1"
dependencies:
- name: common
repository: https://truecharts.org

View File

@ -0,0 +1,34 @@
# Introduction
A Helm chart to deploy a Matrix homeserver stack into Kubernetes
TrueCharts are designed to be installed as TrueNAS SCALE app only. We can not guarantee this charts works as a stand-alone helm installation.
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/truecharts/apps/issues/new/choose)**
## Requirements
Kubernetes: `>=1.16.0-0`
## Dependencies
| Repository | Name | Version |
|------------|------|---------|
| https://truecharts.org/ | postgresql | 6.0.56 |
| https://truecharts.org | common | 8.14.1 |
## Installing the Chart
To install this App on TrueNAS SCALE check our [Quick-Start Guide](https://truecharts.org/manual/Quick-Start%20Guides/03-Installing-an-App/).
## Uninstalling the Chart
To remove this App from TrueNAS SCALE check our [Quick-Start Guide](https://truecharts.org/manual/Quick-Start%20Guides/07-Deleting-an-App/).
## Support
- Please check our [quick-start guides](https://truecharts.org/manual/Quick-Start%20Guides/01-Open-Apps/) first.
- See the [Wiki](https://truecharts.org)
- Check our [Discord](https://discord.gg/tVsPTHWTtr)
- Open a [issue](https://github.com/truecharts/apps/issues/new/choose)
---
All Rights Reserved - The TrueCharts Project

View File

@ -0,0 +1,123 @@
# Default Helm-Values
TrueCharts is primarily build to supply TrueNAS SCALE Apps.
However, we also supply all Apps as standard Helm-Charts. In this document we aim to document the default values in our values.yaml file.
Most of our Apps also consume our "common" Helm Chart.
If this is the case, this means that all values.yaml values are set to the common chart values.yaml by default. This values.yaml file will only contain values that deviate from the common chart.
You will, however, be able to use all values referenced in the common chart here, besides the values listed in this document.
## Values
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| command[0] | string | `"sh"` | |
| command[1] | string | `"-c"` | |
| command[2] | string | `"exec python -B -m synapse.app.homeserver \\\n -c /data/homeserver.yaml \\\n -c /data/secret/secret.yaml \\\n -c /data/custom.yaml\n"` | |
| coturn.enabled | bool | `false` | |
| env | object | `{}` | |
| image.pullPolicy | string | `"IfNotPresent"` | |
| image.repository | string | `"matrixdotorg/synapse"` | |
| image.tag | string | `"v1.50.1"` | |
| installContainers.generate-signing-key.args[0] | string | `"-m"` | |
| installContainers.generate-signing-key.args[1] | string | `"synapse.app.homeserver"` | |
| installContainers.generate-signing-key.args[2] | string | `"--config-path"` | |
| installContainers.generate-signing-key.args[3] | string | `"/data/homeserver.yaml"` | |
| installContainers.generate-signing-key.args[4] | string | `"--keys-directory"` | |
| installContainers.generate-signing-key.args[5] | string | `"/data/keys"` | |
| installContainers.generate-signing-key.args[6] | string | `"--generate-keys"` | |
| installContainers.generate-signing-key.command[0] | string | `"python"` | |
| installContainers.generate-signing-key.env[0].name | string | `"SYNAPSE_SERVER_NAME"` | |
| installContainers.generate-signing-key.env[0].value | string | `"{{ .Values.matrix.serverName }}"` | |
| installContainers.generate-signing-key.env[1].name | string | `"SYNAPSE_REPORT_STATS"` | |
| installContainers.generate-signing-key.env[1].value | string | `"no"` | |
| installContainers.generate-signing-key.image | string | `"{{ .Values.image.repository }}:{{ .Values.image.tag }}"` | |
| installContainers.generate-signing-key.volumeMounts[0].mountPath | string | `"/data"` | |
| installContainers.generate-signing-key.volumeMounts[0].name | string | `"config"` | |
| installContainers.generate-signing-key.volumeMounts[1].mountPath | string | `"/data/secret"` | |
| installContainers.generate-signing-key.volumeMounts[1].name | string | `"secret"` | |
| installContainers.generate-signing-key.volumeMounts[2].mountPath | string | `"/data/keys"` | |
| installContainers.generate-signing-key.volumeMounts[2].name | string | `"key"` | |
| mail.enabled | bool | `false` | |
| mail.from | string | `"Matrix <matrix@example.com>"` | |
| mail.host | string | `""` | |
| mail.password | string | `""` | |
| mail.port | int | `25` | |
| mail.requireTransportSecurity | bool | `true` | |
| mail.riotUrl | string | `""` | |
| mail.username | string | `""` | |
| matrix.adminEmail | string | `"admin@example.com"` | |
| matrix.blockNonAdminInvites | bool | `false` | |
| matrix.disabled | bool | `false` | |
| matrix.disabledMessage | string | `""` | |
| matrix.encryptByDefault | string | `"invite"` | |
| matrix.federation.allowPublicRooms | bool | `true` | |
| matrix.federation.blacklist[0] | string | `"127.0.0.0/8"` | |
| matrix.federation.blacklist[1] | string | `"10.0.0.0/8"` | |
| matrix.federation.blacklist[2] | string | `"172.16.0.0/12"` | |
| matrix.federation.blacklist[3] | string | `"192.168.0.0/16"` | |
| matrix.federation.blacklist[4] | string | `"100.64.0.0/10"` | |
| matrix.federation.blacklist[5] | string | `"169.254.0.0/16"` | |
| matrix.federation.blacklist[6] | string | `"::1/128"` | |
| matrix.federation.blacklist[7] | string | `"fe80::/64"` | |
| matrix.federation.blacklist[8] | string | `"fc00::/7"` | |
| matrix.federation.enabled | bool | `true` | |
| matrix.logging.rootLogLevel | string | `"WARNING"` | |
| matrix.logging.sqlLogLevel | string | `"WARNING"` | |
| matrix.logging.synapseLogLevel | string | `"WARNING"` | |
| matrix.presence | bool | `true` | |
| matrix.registration.allowGuests | bool | `false` | |
| matrix.registration.autoJoinRooms | list | `[]` | |
| matrix.registration.enabled | bool | `false` | |
| matrix.retentionPeriod | string | `"7d"` | |
| matrix.search | bool | `true` | |
| matrix.security.surpressKeyServerWarning | bool | `true` | |
| matrix.serverName | string | `"example.com"` | |
| matrix.uploads.maxPixels | string | `"32M"` | |
| matrix.uploads.maxSize | string | `"10M"` | |
| matrix.urlPreviews.enabled | bool | `false` | |
| persistence.config.enabled | bool | `true` | |
| persistence.config.mountPath | string | `"/data"` | |
| persistence.config.objectName | string | `"synapse-config"` | |
| persistence.config.readOnly | bool | `false` | |
| persistence.config.type | string | `"configMap"` | |
| persistence.key.enabled | bool | `true` | |
| persistence.key.mountPath | string | `"/data/keys"` | |
| persistence.media.enabled | bool | `true` | |
| persistence.media.mountPath | string | `"/data/media_store"` | |
| persistence.secret.enabled | bool | `true` | |
| persistence.secret.mountPath | string | `"/data/secret"` | |
| persistence.secret.objectName | string | `"synapse-secret"` | |
| persistence.secret.readOnly | bool | `false` | |
| persistence.secret.type | string | `"secret"` | |
| persistence.uploads.enabled | bool | `true` | |
| persistence.uploads.mountPath | string | `"/uploads"` | |
| postgresql.enabled | bool | `true` | |
| postgresql.env.POSTGRES_INITDB_ARGS | string | `"--encoding=UTF8 --locale=C"` | |
| postgresql.existingSecret | string | `"dbcreds"` | |
| postgresql.postgresqlDatabase | string | `"synapse"` | |
| postgresql.postgresqlUsername | string | `"synapse"` | |
| probes.liveness.path | string | `"/health"` | |
| probes.readiness.path | string | `"/health"` | |
| probes.startup.path | string | `"/health"` | |
| secret | object | `{}` | |
| securityContext.allowPrivilegeEscalation | bool | `true` | |
| securityContext.readOnlyRootFilesystem | bool | `true` | |
| securityContext.runAsNonRoot | bool | `true` | |
| service.main.ports.main.port | int | `8008` | |
| service.main.ports.main.targetPort | int | `8008` | |
| service.metrics.enabled | bool | `true` | |
| service.metrics.ports.metrics.enabled | bool | `true` | |
| service.metrics.ports.metrics.port | int | `9090` | |
| service.metrics.ports.metrics.targetPort | int | `9090` | |
| service.replication.enabled | bool | `true` | |
| service.replication.ports.replication.enabled | bool | `true` | |
| service.replication.ports.replication.port | int | `9092` | |
| service.replication.ports.replication.targetPort | int | `9092` | |
| synapse.appConfig | list | `[]` | List of application config .yaml files to be loaded from /appConfig |
| synapse.loadCustomConfig | bool | `false` | |
| synapse.metrics.annotations | bool | `true` | |
| synapse.metrics.enabled | bool | `true` | |
| synapse.metrics.port | int | `9092` | |
All Rights Reserved - The TrueCharts Project

View File

@ -0,0 +1,25 @@
---
hide:
- toc
---
# Security Overview
<link href="https://truecharts.org/_static/trivy.css" type="text/css" rel="stylesheet" />
## Helm-Chart
##### Scan Results
| No Misconfigurations found |
|:---------------------------------|
## Containers
##### Detected Containers
##### Scan Results

View File

@ -0,0 +1,10 @@
# Changelog<br>
<a name="synapse-0.0.1"></a>
### synapse-0.0.1 (2022-01-23)
#### Feat
* add synapse ([#1768](https://github.com/truecharts/apps/issues/1768))

View File

@ -0,0 +1,8 @@
# Configuration Options
##### Connecting to other apps
If you need to connect this App to other Apps on TrueNAS SCALE, please refer to our "Linking Apps Internally" quick-start guide:
https://truecharts.org/manual/Quick-Start%20Guides/14-linking-apps/
##### Available config options
In the future this page is going to contain an automated list of options available in the installation/edit UI.

View File

@ -0,0 +1,123 @@
# Default Helm-Values
TrueCharts is primarily build to supply TrueNAS SCALE Apps.
However, we also supply all Apps as standard Helm-Charts. In this document we aim to document the default values in our values.yaml file.
Most of our Apps also consume our "common" Helm Chart.
If this is the case, this means that all values.yaml values are set to the common chart values.yaml by default. This values.yaml file will only contain values that deviate from the common chart.
You will, however, be able to use all values referenced in the common chart here, besides the values listed in this document.
## Values
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| command[0] | string | `"sh"` | |
| command[1] | string | `"-c"` | |
| command[2] | string | `"exec python -B -m synapse.app.homeserver \\\n -c /data/homeserver.yaml \\\n -c /data/secret/secret.yaml \\\n -c /data/custom.yaml\n"` | |
| coturn.enabled | bool | `false` | |
| env | object | `{}` | |
| image.pullPolicy | string | `"IfNotPresent"` | |
| image.repository | string | `"matrixdotorg/synapse"` | |
| image.tag | string | `"v1.50.1"` | |
| installContainers.generate-signing-key.args[0] | string | `"-m"` | |
| installContainers.generate-signing-key.args[1] | string | `"synapse.app.homeserver"` | |
| installContainers.generate-signing-key.args[2] | string | `"--config-path"` | |
| installContainers.generate-signing-key.args[3] | string | `"/data/homeserver.yaml"` | |
| installContainers.generate-signing-key.args[4] | string | `"--keys-directory"` | |
| installContainers.generate-signing-key.args[5] | string | `"/data/keys"` | |
| installContainers.generate-signing-key.args[6] | string | `"--generate-keys"` | |
| installContainers.generate-signing-key.command[0] | string | `"python"` | |
| installContainers.generate-signing-key.env[0].name | string | `"SYNAPSE_SERVER_NAME"` | |
| installContainers.generate-signing-key.env[0].value | string | `"{{ .Values.matrix.serverName }}"` | |
| installContainers.generate-signing-key.env[1].name | string | `"SYNAPSE_REPORT_STATS"` | |
| installContainers.generate-signing-key.env[1].value | string | `"no"` | |
| installContainers.generate-signing-key.image | string | `"{{ .Values.image.repository }}:{{ .Values.image.tag }}"` | |
| installContainers.generate-signing-key.volumeMounts[0].mountPath | string | `"/data"` | |
| installContainers.generate-signing-key.volumeMounts[0].name | string | `"config"` | |
| installContainers.generate-signing-key.volumeMounts[1].mountPath | string | `"/data/secret"` | |
| installContainers.generate-signing-key.volumeMounts[1].name | string | `"secret"` | |
| installContainers.generate-signing-key.volumeMounts[2].mountPath | string | `"/data/keys"` | |
| installContainers.generate-signing-key.volumeMounts[2].name | string | `"key"` | |
| mail.enabled | bool | `false` | |
| mail.from | string | `"Matrix <matrix@example.com>"` | |
| mail.host | string | `""` | |
| mail.password | string | `""` | |
| mail.port | int | `25` | |
| mail.requireTransportSecurity | bool | `true` | |
| mail.riotUrl | string | `""` | |
| mail.username | string | `""` | |
| matrix.adminEmail | string | `"admin@example.com"` | |
| matrix.blockNonAdminInvites | bool | `false` | |
| matrix.disabled | bool | `false` | |
| matrix.disabledMessage | string | `""` | |
| matrix.encryptByDefault | string | `"invite"` | |
| matrix.federation.allowPublicRooms | bool | `true` | |
| matrix.federation.blacklist[0] | string | `"127.0.0.0/8"` | |
| matrix.federation.blacklist[1] | string | `"10.0.0.0/8"` | |
| matrix.federation.blacklist[2] | string | `"172.16.0.0/12"` | |
| matrix.federation.blacklist[3] | string | `"192.168.0.0/16"` | |
| matrix.federation.blacklist[4] | string | `"100.64.0.0/10"` | |
| matrix.federation.blacklist[5] | string | `"169.254.0.0/16"` | |
| matrix.federation.blacklist[6] | string | `"::1/128"` | |
| matrix.federation.blacklist[7] | string | `"fe80::/64"` | |
| matrix.federation.blacklist[8] | string | `"fc00::/7"` | |
| matrix.federation.enabled | bool | `true` | |
| matrix.logging.rootLogLevel | string | `"WARNING"` | |
| matrix.logging.sqlLogLevel | string | `"WARNING"` | |
| matrix.logging.synapseLogLevel | string | `"WARNING"` | |
| matrix.presence | bool | `true` | |
| matrix.registration.allowGuests | bool | `false` | |
| matrix.registration.autoJoinRooms | list | `[]` | |
| matrix.registration.enabled | bool | `false` | |
| matrix.retentionPeriod | string | `"7d"` | |
| matrix.search | bool | `true` | |
| matrix.security.surpressKeyServerWarning | bool | `true` | |
| matrix.serverName | string | `"example.com"` | |
| matrix.uploads.maxPixels | string | `"32M"` | |
| matrix.uploads.maxSize | string | `"10M"` | |
| matrix.urlPreviews.enabled | bool | `false` | |
| persistence.config.enabled | bool | `true` | |
| persistence.config.mountPath | string | `"/data"` | |
| persistence.config.objectName | string | `"synapse-config"` | |
| persistence.config.readOnly | bool | `false` | |
| persistence.config.type | string | `"configMap"` | |
| persistence.key.enabled | bool | `true` | |
| persistence.key.mountPath | string | `"/data/keys"` | |
| persistence.media.enabled | bool | `true` | |
| persistence.media.mountPath | string | `"/data/media_store"` | |
| persistence.secret.enabled | bool | `true` | |
| persistence.secret.mountPath | string | `"/data/secret"` | |
| persistence.secret.objectName | string | `"synapse-secret"` | |
| persistence.secret.readOnly | bool | `false` | |
| persistence.secret.type | string | `"secret"` | |
| persistence.uploads.enabled | bool | `true` | |
| persistence.uploads.mountPath | string | `"/uploads"` | |
| postgresql.enabled | bool | `true` | |
| postgresql.env.POSTGRES_INITDB_ARGS | string | `"--encoding=UTF8 --locale=C"` | |
| postgresql.existingSecret | string | `"dbcreds"` | |
| postgresql.postgresqlDatabase | string | `"synapse"` | |
| postgresql.postgresqlUsername | string | `"synapse"` | |
| probes.liveness.path | string | `"/health"` | |
| probes.readiness.path | string | `"/health"` | |
| probes.startup.path | string | `"/health"` | |
| secret | object | `{}` | |
| securityContext.allowPrivilegeEscalation | bool | `true` | |
| securityContext.readOnlyRootFilesystem | bool | `true` | |
| securityContext.runAsNonRoot | bool | `true` | |
| service.main.ports.main.port | int | `8008` | |
| service.main.ports.main.targetPort | int | `8008` | |
| service.metrics.enabled | bool | `true` | |
| service.metrics.ports.metrics.enabled | bool | `true` | |
| service.metrics.ports.metrics.port | int | `9090` | |
| service.metrics.ports.metrics.targetPort | int | `9090` | |
| service.replication.enabled | bool | `true` | |
| service.replication.ports.replication.enabled | bool | `true` | |
| service.replication.ports.replication.port | int | `9092` | |
| service.replication.ports.replication.targetPort | int | `9092` | |
| synapse.appConfig | list | `[]` | List of application config .yaml files to be loaded from /appConfig |
| synapse.loadCustomConfig | bool | `false` | |
| synapse.metrics.annotations | bool | `true` | |
| synapse.metrics.enabled | bool | `true` | |
| synapse.metrics.port | int | `9092` | |
All Rights Reserved - The TrueCharts Project

View File

@ -0,0 +1,34 @@
# Introduction
A Helm chart to deploy a Matrix homeserver stack into Kubernetes
TrueCharts are designed to be installed as TrueNAS SCALE app only. We can not guarantee this charts works as a stand-alone helm installation.
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/truecharts/apps/issues/new/choose)**
## Requirements
Kubernetes: `>=1.16.0-0`
## Dependencies
| Repository | Name | Version |
|------------|------|---------|
| https://truecharts.org/ | postgresql | 6.0.56 |
| https://truecharts.org | common | 8.14.1 |
## Installing the Chart
To install this App on TrueNAS SCALE check our [Quick-Start Guide](https://truecharts.org/manual/Quick-Start%20Guides/03-Installing-an-App/).
## Uninstalling the Chart
To remove this App from TrueNAS SCALE check our [Quick-Start Guide](https://truecharts.org/manual/Quick-Start%20Guides/07-Deleting-an-App/).
## Support
- Please check our [quick-start guides](https://truecharts.org/manual/Quick-Start%20Guides/01-Open-Apps/) first.
- See the [Wiki](https://truecharts.org)
- Check our [Discord](https://discord.gg/tVsPTHWTtr)
- Open a [issue](https://github.com/truecharts/apps/issues/new/choose)
---
All Rights Reserved - The TrueCharts Project

View File

@ -0,0 +1,25 @@
---
hide:
- toc
---
# Security Overview
<link href="https://truecharts.org/_static/trivy.css" type="text/css" rel="stylesheet" />
## Helm-Chart
##### Scan Results
| No Misconfigurations found |
|:---------------------------------|
## Containers
##### Detected Containers
##### Scan Results

View File

@ -45849,6 +45849,41 @@ entries:
urls:
- https://github.com/truecharts/apps/releases/download/statping-4.0.12/statping-4.0.12.tgz
version: 4.0.12
synapse:
- annotations:
truecharts.org/SCALE-support: "true"
truecharts.org/catagories: |
- cloud
truecharts.org/grade: U
apiVersion: v2
appVersion: 1.50.1
created: "2022-01-23T23:26:16.575298968Z"
dependencies:
- name: common
repository: https://truecharts.org
version: 8.14.1
- condition: postgresql.enabled
name: postgresql
repository: https://truecharts.org/
version: 6.0.56
description: A Helm chart to deploy a Matrix homeserver stack into Kubernetes
digest: ace2c16690cb56f5ac18cb07aeb0f5eb24d4f34a5aa15e1aa5753c25fa8f9452
home: https://github.com/truecharts/apps/charts/stable/synapse
icon: https://truecharts.org/_static/img/appicons/synapse-icon.png
keywords:
- chat
- matrix
- synapse
kubeVersion: '>=1.16.0-0'
maintainers:
- email: info@truecharts.org
name: TrueCharts
url: https://truecharts.org
name: synapse
type: application
urls:
- https://github.com/truecharts/apps/releases/download/synapse-0.0.1/synapse-0.0.1.tgz
version: 0.0.1
synclounge:
- annotations:
truecharts.org/SCALE-support: "true"
@ -52224,4 +52259,4 @@ entries:
urls:
- https://github.com/truecharts/apps/releases/download/zwavejs2mqtt-9.0.24/zwavejs2mqtt-9.0.24.tgz
version: 9.0.24
generated: "2022-01-23T22:24:49.089358416Z"
generated: "2022-01-23T23:26:16.578526438Z"