Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
Matrix
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Container Registry
Model registry
Operate
Environments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
TeDomum
Matrix
Commits
e87499b3
Unverified
Commit
e87499b3
authored
1 year ago
by
Amanda H. L. de Andrade Katz
Committed by
GitHub
1 year ago
Browse files
Options
Downloads
Patches
Plain Diff
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
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
changelog.d/16714.doc
+1
-0
1 addition, 0 deletions
changelog.d/16714.doc
docs/usage/configuration/config_documentation.md
+17
-0
17 additions, 0 deletions
docs/usage/configuration/config_documentation.md
with
18 additions
and
0 deletions
changelog.d/16714.doc
0 → 100644
+
1
−
0
View file @
e87499b3
Add documentation for how to validate the configuration file with synapse.config script.
This diff is collapsed.
Click to expand it.
docs/usage/configuration/config_documentation.md
+
17
−
0
View file @
e87499b3
...
...
@@ -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:
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment