From 16db5bf99976c745aa1864571a305d98c74297ba Mon Sep 17 00:00:00 2001 From: DMRobertson Date: Tue, 5 Dec 2023 11:44:33 +0000 Subject: deploy: e87499b3f46a31c25df2da8686d3b913f8094660 --- develop/usage/configuration/config_documentation.html | 10 ++++++++++ 1 file changed, 10 insertions(+) (limited to 'develop/usage/configuration/config_documentation.html') diff --git a/develop/usage/configuration/config_documentation.html b/develop/usage/configuration/config_documentation.html index f63dd469ad..7e4d1575a6 100644 --- a/develop/usage/configuration/config_documentation.html +++ b/develop/usage/configuration/config_documentation.html @@ -176,6 +176,16 @@ messages from the database after 5 minutes, rather than 5 months.

For example, setting max_avatar_size: 10M means that Synapse will not accept files larger than 10,485,760 bytes for a user avatar.

+

Config Validation

+

The configuration file can be validated with the following command:

+
python -m synapse.config read <config key to print> -c <path to config>
+
+

To validate the entire file, omit read <config key to print>:

+
python -m synapse.config -c <path to config>
+
+

To see how to set other options, check the help reference:

+
python -m synapse.config --help
+

YAML

The configuration file is a YAML file, which means that certain syntax rules apply if you want your config file to be read properly. A few helpful things to know:

-- cgit 1.5.1