mirrors/synapse
1
0
Fork 0
mirror of https://github.com/element-hq/synapse.git synced 2024-11-28 15:08:49 +03:00
Code Issues Projects Releases Packages Wiki Activity

deploy: e87499b3f4

Browse source
This commit is contained in:
DMRobertson 2023-12-05 11:44:33 +00:00
parent 47c8d20a2d
commit 16db5bf999
4 changed files with 22 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
develop/print.html
View file

@ -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 &lt;config key to print&gt; -c &lt;path to config&gt;
</code></pre>
<p>To validate the entire file, omit <code>read &lt;config key to print&gt;</code>:</p>
<pre><code class="language-bash">python -m synapse.config -c &lt;path to config&gt;
</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>

2
develop/searchindex.js
View file

File diff suppressed because one or more lines are too long

2
develop/searchindex.json
View file

File diff suppressed because one or more lines are too long

10
develop/usage/configuration/config_documentation.html
View file

@ -176,6 +176,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 &lt;config key to print&gt; -c &lt;path to config&gt;
</code></pre>
<p>To validate the entire file, omit <code>read &lt;config key to print&gt;</code>:</p>
<pre><code class="language-bash">python -m synapse.config -c &lt;path to config&gt;
</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>