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

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

diff --git a/conf/synapse/README.md b/conf/synapse/README.md
new file mode 100644
index 0000000..eb5068f
--- /dev/null
+++ b/conf/synapse/README.md
@@ -0,0 +1,9 @@
+# Synapse
+
+This directory will contain the generate configuration for Synapse.
+
+`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.