Create README.md

This commit is contained in:
A 2025-05-05 09:56:34 -07:00 committed by GitHub
parent f8c9ba20dd
commit 7f8d693bb9
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

9
conf/synapse/README.md Normal file
View File

@ -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.