diff --git a/README.md b/README.md index 05d8736..988c418 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,33 @@ -# matrix sliding-sync helm chart +# Matrix Sliding Sync helm chart -This is a helm chart implementing [matrix-org/sliding-sync](https://github.com/matrix-org/sliding-sync/tree/main). + + +This is a helm chart implementing [matrix-org/sliding-sync](https://github.com/matrix-org/sliding-sync/tree/main) for deployment on Kubernetes. It was originally designed for use as a subchart for [small-hack/matrix-chart](https://github.com/small-hack/matrix-chart), but it can be used stand alone as well. + +See the [`README.md`](https://github.com/small-hack/matrix-sliding-sync-chart/blob/main/charts/matrix-sliding-sync/README.md) for docs auto-generated from the [`values.yaml`](https://github.com/small-hack/matrix-sliding-sync-chart/blob/main/charts/matrix-sliding-sync/values.yaml). + +## TLDR + +Read through the parameters and modify them locally before installing the chart: + +```bash +# add the helm repo locally +helm repo add matrix-sliding-sync https://small-hack.github.io/matrix-sliding-sync-chart + +# downloads the values.yaml locally +helm show values matrix-sliding-sync/matrix-sliding-sync > values.yaml + +# install the chart +helm install my-release-name matrix-sliding-sync/matrix-sliding-sync --values values.yaml +``` + +Here's how I've been testing in the ci: + +```bash +helm install matrix matrix/matrix --set postgresql.volumePermissions.enabled=false,postgresql.primary.networkPolicy.enabled=false,element.enabled=true,fullnameOverride=matrix-stack +helm install matrix-sliding-sync --set=postgresql.volumePermissions.enabled=false,postgresql.primary.networkPolicy.enabled=false,syncv3.server=http://matrix-stack-element matrix-sliding-sync/matrix-sliding-sync +``` + +## Status + +Kinda working. Submit PRs or Issues if something specific isn't working