Skip to content
Snippets Groups Projects
Unverified Commit e87499b3 authored by Amanda H. L. de Andrade Katz's avatar Amanda H. L. de Andrade Katz Committed by GitHub
Browse files

Add how to validate configuration file with synapse.config script (#16714)

parent ea783550
No related branches found
No related tags found
No related merge requests found
Add documentation for how to validate the configuration file with synapse.config script.
......@@ -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 <config key to print> -c <path to config>
```
To validate the entire file, omit `read <config key to print>`:
```bash
python -m synapse.config -c <path to config>
```
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:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment