Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.

Commit e87499b

Browse files
authored
Add how to validate configuration file with synapse.config script (#16714)
1 parent ea78355 commit e87499b

File tree

2 files changed

+18
-0
lines changed

2 files changed

+18
-0
lines changed

changelog.d/16714.doc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Add documentation for how to validate the configuration file with synapse.config script.

docs/usage/configuration/config_documentation.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,23 @@ In addition, configuration options referring to size use the following suffixes:
3333
For example, setting `max_avatar_size: 10M` means that Synapse will not accept files larger than 10,485,760 bytes
3434
for a user avatar.
3535

36+
## Config Validation
37+
38+
The configuration file can be validated with the following command:
39+
```bash
40+
python -m synapse.config read <config key to print> -c <path to config>
41+
```
42+
43+
To validate the entire file, omit `read <config key to print>`:
44+
```bash
45+
python -m synapse.config -c <path to config>
46+
```
47+
48+
To see how to set other options, check the help reference:
49+
```bash
50+
python -m synapse.config --help
51+
```
52+
3653
### YAML
3754
The configuration file is a [YAML](https://yaml.org/) file, which means that certain syntax rules
3855
apply if you want your config file to be read properly. A few helpful things to know:

0 commit comments

Comments
 (0)