diff options
| author | DMRobertson <DMRobertson@users.noreply.github.com> | 2023-12-05 11:44:33 +0000 |
|---|---|---|
| committer | DMRobertson <DMRobertson@users.noreply.github.com> | 2023-12-05 11:44:33 +0000 |
| commit | 16db5bf99976c745aa1864571a305d98c74297ba (patch) | |
| tree | 3a361c28716a779f235becb3760dea9de2678409 /develop/print.html | |
| parent | deploy: 0aa4d3b6f7193d9721bd484dae0242ccd0cc10b8 (diff) | |
| download | synapse-16db5bf99976c745aa1864571a305d98c74297ba.tar.xz | |
deploy: e87499b3f46a31c25df2da8686d3b913f8094660
Diffstat (limited to 'develop/print.html')
| -rw-r--r-- | develop/print.html | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/develop/print.html b/develop/print.html index 182d319659..80fe289567 100644 --- a/develop/print.html +++ b/develop/print.html @@ -3749,6 +3749,16 @@ messages from the database after 5 minutes, rather than 5 months.</p> </ul> <p>For example, setting <code>max_avatar_size: 10M</code> means that Synapse will not accept files larger than 10,485,760 bytes for a user avatar.</p> +<h2 id="config-validation"><a class="header" href="#config-validation">Config Validation</a></h2> +<p>The configuration file can be validated with the following command:</p> +<pre><code class="language-bash">python -m synapse.config read <config key to print> -c <path to config> +</code></pre> +<p>To validate the entire file, omit <code>read <config key to print></code>:</p> +<pre><code class="language-bash">python -m synapse.config -c <path to config> +</code></pre> +<p>To see how to set other options, check the help reference:</p> +<pre><code class="language-bash">python -m synapse.config --help +</code></pre> <h3 id="yaml"><a class="header" href="#yaml">YAML</a></h3> <p>The configuration file is a <a href="https://yaml.org/">YAML</a> file, which means that certain syntax rules apply if you want your config file to be read properly. A few helpful things to know:</p> |