https://github.com/small-hack/matrix-authentication-service-chart
matrix authentication service chart
https://github.com/small-hack/matrix-authentication-service-chart
Last synced: 12 months ago
JSON representation
matrix authentication service chart
- Host: GitHub
- URL: https://github.com/small-hack/matrix-authentication-service-chart
- Owner: small-hack
- License: agpl-3.0
- Created: 2024-05-19T19:12:10.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-10T04:27:24.000Z (about 1 year ago)
- Last Synced: 2025-02-22T22:17:52.025Z (12 months ago)
- Language: Smarty
- Size: 2.02 MB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Matrix Authentication Service Helm chart
A helm chart for deploying the [matrix-authentication-service](https://github.com/matrix-org/matrix-authentication-service) on Kubernetes.
## TLDR
Read through the [parameters](./charts/matrix-authentication-service/README.md) and modify them locally before installing the chart:
```bash
# add the helm repo locally
helm repo add matrix-authentication-service https://small-hack.github.io/matrix-authentication-service-chart
# downloads the values.yaml locally
helm show values matrix-authentication-service/matrix-authentication-service > values.yaml
# install the chart
helm install my-release-name matrix-authentication-service/matrix-authentication-service --values values.yaml
```
# Notes
You can find the official docs for the Matrix Authentication Service at [matrix-org.github.io/matrix-authentication-service](https://matrix-org.github.io/matrix-authentication-service/index.html) for now, but this is expected to change to [element-hq.github.io/matrix-authentication-service](https://element-hq.github.io/matrix-authentication-service/index.html) in the near future.
## Database
By default, no database is enabled. To enable the built-in Bitnami hosted postgresql sub chart, use:
```yaml
postgresql:
enabled: true
```
To enable using an external database instead of the built-in sub chart, use:
```yaml
externalDatabase:
enabled: true
```
**NOTE**: You can only use `externalDatabase.enabled=True` *OR* `postgresql.enabled=True`. You cannot use both. You must pick one. If you're still using Bitnami postgresql, but not the one that is bundled as a subchart to this one, you want to use the `externalDatabase` section.
**TLS/SSL NOTE**: TLS cannot be enabled for database connections yet due to [matrix-org/matrix-authentication-service:#2799](https://github.com/matrix-org/matrix-authentication-service/issues/2799)
## Config.yaml
Matrix Authentication Service requires a [`config.yaml`](https://matrix-org.github.io/matrix-authentication-service/reference/configuration.html) to function. You can set it up by either using the values under `mas`, or you can provide your own complete config file via an existing Kubernetes Secret.
### Providing an existing Kubernetes secret for `config.yaml`
You can can provide your own complete config file via an existing Kubernetes Secret with `config.yaml` as the secret key via values.yaml:
```yaml
# -- Existing Kubernetes Secret for entire matrix authentication service `config.yaml` file.
# If set, everything under the mas section of the values.yaml is ignored.
existingMasConfigSecret: "my-mas-secret-name"
```
You can also do it an argument to `helm install` with `--set=existingMasConfigSecret.my-mas-secret-name`.
## Status
This chart was developed for use with the [small-hack/matrix-chart](https://github.com/small-hack/matrix-chart), but can be used independently. Feel free to open PRs and Issues if you see anything broken or want a feature.
It's sub-charts are kept up-to-date by [renovatebot](https://github.com/renovatebot/renovate).
If the official repo deploys a chart, and it doesn't meet our security needs, we'll submit PRs till it does and when it's in a good state, you can expect this chart to be publicly archived with a link to the official chart.