From 9e5c562b9cba8d529d776d86d3763c11f906c992 Mon Sep 17 00:00:00 2001
From: A <32370941+aphick@users.noreply.github.com>
Date: Mon, 5 May 2025 09:50:01 -0700
Subject: [PATCH] Create README.md

---
 conf/element/README.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)
 create mode 100644 conf/element/README.md

diff --git a/conf/element/README.md b/conf/element/README.md
new file mode 100644
index 0000000..d1db85a
--- /dev/null
+++ b/conf/element/README.md
@@ -0,0 +1,15 @@
+# Element and Synapse config directory
+
+This directory contains the generated config files for Element-web and the Synapse homeserver.
+
+## Element-web
+
+`config.json` is the configuration file for Element-web, the web front-end for Matrix chat. Available options can be found in the [official repository](https://github.com/element-hq/element-web/blob/develop/docs/config.md).
+
+## Matrix
+
+`homeserver.yaml` is the configuration file for the Synapse homeserver, the back end for Matrix based chat. To view all available configuration options you can see the [official documents](https://element-hq.github.io/synapse/latest/usage/configuration/config_documentation.html).
+
+### Synapse & email
+
+It is recommended to configure an email account for Synapse, which can be used for email validation, and password resets. To do so, edit `homeserver.yaml` using the options available in the [official docs](https://element-hq.github.io/synapse/latest/usage/configuration/config_documentation.html#email), and then reload Synapse.