From 082b97fbd5ad487bfe0700a6244ae21c7e93261a Mon Sep 17 00:00:00 2001 From: Ben Banfield-Zanin Date: Tue, 11 Feb 2025 14:27:16 +0000 Subject: [PATCH] Update user docs with new components and requirements --- charts/matrix-stack/README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/charts/matrix-stack/README.md b/charts/matrix-stack/README.md index e66bd372..4837a1b4 100644 --- a/charts/matrix-stack/README.md +++ b/charts/matrix-stack/README.md @@ -9,6 +9,16 @@ SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial This Helm chart deploys a coherent Matrix Stack. It currently includes the following components * [Synapse](https://github.com/element-hq/synapse) as a Matrix homeserver * [Element Web](https://github.com/element-hq/element-web) as a Matrix client +* [Matrix Authentication Service](https://github.com/element-hq/matrix-authentication-service) for authentication on the Matrix homeserver +* Well Known Delegation file hosting to enable Matrix client and Matrix federation discovery of this deployment + +## Requirements + +The chart requires: +* An ingress controller installed in the cluster already +* TLS certificates for Ingresses +* If using Synapse or Matrix Authentication Service, a Postgres instance +* If using Synapse, the ability to create `PersistentVolumeClaims` to store media ## Common