Browse Source

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

tags/v1.98.0rc1
Amanda H. L. de Andrade Katz 5 months ago
committed by GitHub
parent
commit
e87499b3f4
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 18 additions and 0 deletions
  1. +1
    -0
      changelog.d/16714.doc
  2. +17
    -0
      docs/usage/configuration/config_documentation.md

+ 1
- 0
changelog.d/16714.doc View File

@@ -0,0 +1 @@
Add documentation for how to validate the configuration file with synapse.config script.

+ 17
- 0
docs/usage/configuration/config_documentation.md View File

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


Loading…
Cancel
Save