From 6c9e09a27c467da950beaa25ec2d71f1cd63f9a7 Mon Sep 17 00:00:00 2001
From: Nico Schottelius <nico@nico-notebook.schottelius.org>
Date: Sat, 25 Dec 2021 18:27:20 +0100
Subject: [PATCH] [matrix] Documentation / sample usage

---
 apps/matrix/README.md | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

diff --git a/apps/matrix/README.md b/apps/matrix/README.md
index c141cff..308b336 100644
--- a/apps/matrix/README.md
+++ b/apps/matrix/README.md
@@ -1,5 +1,29 @@
 ## Usage and Components
 
+### Sample usage
+
+Setting up matrix for  ...
+
+- the matrix domain "fn.nf"
+- the homeserver matrix.fnnf.svc.p10.k8s.ooo
+- element web on matrix.fn.nf
+
+Using automatic DNS from the p10.k8s.ooo cluster:
+
+```
+helm upgrade --install --create-namespace --namespace fnnf \
+    --set homeServerFQDN=fn.nf,elementWebFQDN=matrix.fn.nf,letsencryptStaging=no matrix matrix/
+```
+
+Setting up matrix.fn.nf in DNS
+
+```
+matrix CNAME matrix-element-web.fnnf.svc.p10.k8s.ooo.
+```
+
+Creating the two json files /.well-known/matrix/server and
+/.well-known/matrix/client on the fn.nf web server.
+
 ### Element-Web
 
 * Includes config.json that is being populated by values.yaml
@@ -37,3 +61,5 @@ See
 ### admin user
 
 docker exec -it synapse register_new_matrix_user http://localhost:8008 -c /data/homeserver.yaml --help
+
+### Resource configuration