From 0911e67c7238971f8dae3549b59c216c7f208e71 Mon Sep 17 00:00:00 2001 From: Amanda Hager Lopes de Andrade Katz Date: Fri, 1 Dec 2023 12:19:28 -0300 Subject: [PATCH 1/2] Add how to validate configuration file with synapse.config script --- .../usage/configuration/config_documentation.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md index 7c4e742cd5d5..504da6cc48f8 100644 --- a/docs/usage/configuration/config_documentation.md +++ b/docs/usage/configuration/config_documentation.md @@ -33,6 +33,23 @@ In addition, configuration options referring to size use the following suffixes: 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: +```bash +python -m synapse.config read -c +``` + +To validate the entire file, omit `read `: +```bash +python -m synapse.config -c +``` + +To see how to set other options, check the help reference: +```bash +python -m synapse.config --help +``` + ### YAML The configuration file is a [YAML](https://yaml.org/) file, which means that certain syntax rules apply if you want your config file to be read properly. A few helpful things to know: From f0ab48072524d161edf16edd5e34a1ae1db1afe3 Mon Sep 17 00:00:00 2001 From: Amanda Hager Lopes de Andrade Katz Date: Mon, 4 Dec 2023 18:06:17 -0300 Subject: [PATCH 2/2] Add changelog --- changelog.d/16714.doc | 1 + 1 file changed, 1 insertion(+) create mode 100644 changelog.d/16714.doc diff --git a/changelog.d/16714.doc b/changelog.d/16714.doc new file mode 100644 index 000000000000..511d2b60224d --- /dev/null +++ b/changelog.d/16714.doc @@ -0,0 +1 @@ +Add documentation for how to validate the configuration file with synapse.config script.