diff --git a/charts/stable/synapse/CHANGELOG.md b/charts/stable/synapse/CHANGELOG.md index 8072f0b2f87..b995e017dee 100644 --- a/charts/stable/synapse/CHANGELOG.md +++ b/charts/stable/synapse/CHANGELOG.md @@ -1,6 +1,15 @@ # Changelog
+ +### [synapse-1.0.0](https://github.com/truecharts/apps/compare/synapse-0.0.14...synapse-1.0.0) (2022-01-31) + +#### Feat + +* move synapse to stable + + + ### [synapse-0.0.14](https://github.com/truecharts/apps/compare/synapse-0.0.13...synapse-0.0.14) (2022-01-31) diff --git a/docs/apps/stable/synapse/CHANGELOG.md b/docs/apps/stable/synapse/CHANGELOG.md new file mode 100644 index 00000000000..b995e017dee --- /dev/null +++ b/docs/apps/stable/synapse/CHANGELOG.md @@ -0,0 +1,118 @@ +# Changelog
+ + + +### [synapse-1.0.0](https://github.com/truecharts/apps/compare/synapse-0.0.14...synapse-1.0.0) (2022-01-31) + +#### Feat + +* move synapse to stable + + + + +### [synapse-0.0.14](https://github.com/truecharts/apps/compare/synapse-0.0.13...synapse-0.0.14) (2022-01-31) + +#### Fix + +* use opencors headerset + + + + +### [synapse-0.0.13](https://github.com/truecharts/apps/compare/synapse-0.0.12...synapse-0.0.13) (2022-01-31) + + + + +### [synapse-0.0.12](https://github.com/truecharts/apps/compare/synapse-0.0.11...synapse-0.0.12) (2022-01-31) + +#### Fix + +* secret tweaking + + + + +### [synapse-0.0.11](https://github.com/truecharts/apps/compare/synapse-0.0.10...synapse-0.0.11) (2022-01-31) + + + + +### [synapse-0.0.10](https://github.com/truecharts/apps/compare/synapse-0.0.9...synapse-0.0.10) (2022-01-31) + +#### Fix + +* fix mistake in variable definition + + + + +### [synapse-0.0.9](https://github.com/truecharts/apps/compare/synapse-0.0.8...synapse-0.0.9) (2022-01-31) + + + + +### [synapse-0.0.8](https://github.com/truecharts/apps/compare/synapse-0.0.7...synapse-0.0.8) (2022-01-31) + +#### Fix + +* fix federation service + + + + +### [synapse-0.0.7](https://github.com/truecharts/apps/compare/synapse-0.0.5...synapse-0.0.7) (2022-01-31) + +#### Fix + +* Try another way of defining the macaroon secret + + + + +### [synapse-0.0.5](https://github.com/truecharts/apps/compare/synapse-0.0.4...synapse-0.0.5) (2022-01-31) + +#### Fix + +* fix custom config and don't decode stringData + + + + +### [synapse-0.0.4](https://github.com/truecharts/apps/compare/synapse-0.0.3...synapse-0.0.4) (2022-01-31) + +#### Fix + +* update questions.yaml to beter reflect values.yaml + + + + +### [synapse-0.0.3](https://github.com/truecharts/apps/compare/synapse-0.0.2...synapse-0.0.3) (2022-01-25) + +#### Chore + +* update helm general non-major helm releases ([#1791](https://github.com/truecharts/apps/issues/1791)) + + + + +### [synapse-0.0.2](https://github.com/truecharts/apps/compare/synapse-0.0.1...synapse-0.0.2) (2022-01-24) + +#### Chore + +* update docker general non-major docker tags ([#1787](https://github.com/truecharts/apps/issues/1787)) + +#### Fix + +* update UI ([#1778](https://github.com/truecharts/apps/issues/1778)) + + + + +### synapse-0.0.1 (2022-01-23) + +#### Feat + +* add synapse ([#1768](https://github.com/truecharts/apps/issues/1768)) diff --git a/docs/apps/stable/synapse/CONFIG.md b/docs/apps/stable/synapse/CONFIG.md new file mode 100644 index 00000000000..fc9b2fa2d5f --- /dev/null +++ b/docs/apps/stable/synapse/CONFIG.md @@ -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. diff --git a/docs/apps/stable/synapse/helm-values.md b/docs/apps/stable/synapse/helm-values.md new file mode 100644 index 00000000000..7093170e611 --- /dev/null +++ b/docs/apps/stable/synapse/helm-values.md @@ -0,0 +1,129 @@ +# 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.2"` | | +| installContainers.generate-signing-key.args[0] | string | `"-m"` | | +| installContainers.generate-signing-key.args[10] | string | `"--generate-keys"` | | +| 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 | `"--config-path"` | | +| installContainers.generate-signing-key.args[5] | string | `"/data/secret/secret.yaml"` | | +| installContainers.generate-signing-key.args[6] | string | `"--config-path"` | | +| installContainers.generate-signing-key.args[7] | string | `"/data/custom.yaml"` | | +| installContainers.generate-signing-key.args[8] | string | `"--keys-directory"` | | +| installContainers.generate-signing-key.args[9] | string | `"/data/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 "` | | +| 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` | | +| service.federation.enabled | bool | `true` | | +| service.federation.ports.federation.enabled | bool | `true` | | +| service.federation.ports.federation.port | int | `8448` | | +| service.federation.ports.federation.targetPort | int | `8008` | | +| 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 | `9093` | | +| 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 diff --git a/docs/apps/stable/synapse/index.md b/docs/apps/stable/synapse/index.md new file mode 100644 index 00000000000..467da7b36ae --- /dev/null +++ b/docs/apps/stable/synapse/index.md @@ -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.58 | +| https://truecharts.org | common | 8.14.2 | + +## 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 diff --git a/docs/apps/stable/synapse/security.md b/docs/apps/stable/synapse/security.md new file mode 100644 index 00000000000..ac974cb2c40 --- /dev/null +++ b/docs/apps/stable/synapse/security.md @@ -0,0 +1,25 @@ +--- +hide: + - toc +--- + +# Security Overview + + + +## Helm-Chart + +##### Scan Results + + + +| No Misconfigurations found | +|:---------------------------------| + +## Containers + +##### Detected Containers + + +##### Scan Results + diff --git a/docs/index.yaml b/docs/index.yaml index d1400016650..84a420231f0 100644 --- a/docs/index.yaml +++ b/docs/index.yaml @@ -7696,38 +7696,6 @@ entries: - https://github.com/truecharts/apps/releases/download/deepstack-gpu-3.0.0/deepstack-gpu-3.0.0.tgz version: 3.0.0 deluge: - - annotations: - truecharts.org/SCALE-support: "true" - truecharts.org/catagories: | - - media - truecharts.org/grade: U - apiVersion: v2 - appVersion: 2.0.3 - created: "2022-01-31T20:58:39.617999923Z" - dependencies: - - name: common - repository: https://truecharts.org - version: 8.14.2 - description: Deluge App for TrueNAS SCALE - digest: 4772407ccc5b73dfcf47acacf713a708e45a3402a6952848a0eba230b501a9d9 - home: https://github.com/truecharts/apps/tree/master/charts/stable/deluge - icon: https://truecharts.org/_static/img/appicons/deluge-icon.png - keywords: - - transmission - - torrent - - usenet - kubeVersion: '>=1.16.0-0' - maintainers: - - email: info@truecharts.org - name: TrueCharts - url: https://truecharts.org - name: deluge - sources: - - https://github.com/deluge-torrent/deluge - type: application - urls: - - https://github.com/truecharts/apps/releases/download/deluge-9.0.37/deluge-9.0.37.tgz - version: 9.0.37 - annotations: truecharts.org/SCALE-support: "true" truecharts.org/catagories: | @@ -47431,6 +47399,40 @@ entries: - https://github.com/truecharts/apps/releases/download/strapi-0.0.1/strapi-0.0.1.tgz version: 0.0.1 synapse: + - annotations: + truecharts.org/SCALE-support: "true" + truecharts.org/catagories: | + - cloud + truecharts.org/grade: U + apiVersion: v2 + appVersion: 1.50.2 + created: "2022-01-31T21:11:58.88552071Z" + dependencies: + - name: common + repository: https://truecharts.org + version: 8.14.2 + - condition: postgresql.enabled + name: postgresql + repository: https://truecharts.org/ + version: 6.0.58 + description: A Helm chart to deploy a Matrix homeserver stack into Kubernetes + digest: cfeb17d82847da390cd94c419c20f31fb3c239868ba6311bf06d63d89c5e6572 + 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-1.0.0/synapse-1.0.0.tgz + version: 1.0.0 - annotations: truecharts.org/SCALE-support: "true" truecharts.org/catagories: | @@ -54434,4 +54436,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-31T20:58:39.621880444Z" +generated: "2022-01-31T21:11:58.889846915Z"