kaslo/synapse
1
0
Fork 0
Code Wiki Activity

deploy: 481c4e2b55

Browse Source
This commit is contained in:
MadLittleMods
2025-07-14 16:39:31 +00:00
parent d642385b2d
commit 72c01e46d4
5 changed files with 60 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
develop/usage/configuration/config_documentation.html
View File

@@ -2190,12 +2190,30 @@ Setting this to a high value allows users to report content quickly, possibly in
<pre><code class="language-yaml">recaptcha_public_key: YOUR_PUBLIC_KEY
</code></pre>
<hr />
<h3 id="recaptcha_public_key_path"><a class="header" href="#recaptcha_public_key_path"><code>recaptcha_public_key_path</code></a></h3>
<p><em>(string|null)</em> An alternative to <a href="#recaptcha_public_key"><code>recaptcha_public_key</code></a>: allows the public key to be specified in an external file.</p>
<p>The file should be a plain text file, containing only the public key. Synapse reads the public key from the given file once at startup.</p>
<p><em>Added in Synapse 1.134.0.</em></p>
<p>Defaults to <code>null</code>.</p>
<p>Example configuration:</p>
<pre><code class="language-yaml">recaptcha_public_key_path: /path/to/key/file
</code></pre>
<hr />
<h3 id="recaptcha_private_key"><a class="header" href="#recaptcha_private_key"><code>recaptcha_private_key</code></a></h3>
<p><em>(string|null)</em> This homeserver's ReCAPTCHA private key. Must be specified if <a href="#enable_registration_captcha"><code>enable_registration_captcha</code></a> is enabled. Defaults to <code>null</code>.</p>
<p>Example configuration:</p>
<pre><code class="language-yaml">recaptcha_private_key: YOUR_PRIVATE_KEY
</code></pre>
<hr />
<h3 id="recaptcha_private_key_path"><a class="header" href="#recaptcha_private_key_path"><code>recaptcha_private_key_path</code></a></h3>
<p><em>(string|null)</em> An alternative to <a href="#recaptcha_private_key"><code>recaptcha_private_key</code></a>: allows the private key to be specified in an external file.</p>
<p>The file should be a plain text file, containing only the private key. Synapse reads the private key from the given file once at startup.</p>
<p><em>Added in Synapse 1.134.0.</em></p>
<p>Defaults to <code>null</code>.</p>
<p>Example configuration:</p>
<pre><code class="language-yaml">recaptcha_private_key_path: /path/to/key/file
</code></pre>
<hr />
<h3 id="enable_registration_captcha"><a class="header" href="#enable_registration_captcha"><code>enable_registration_captcha</code></a></h3>
<p><em>(boolean)</em> Set to <code>true</code> to require users to complete a CAPTCHA test when registering an account. Requires a valid ReCaptcha public/private key.</p>
<p>Note that <a href="#enable_registration"><code>enable_registration</code></a> must also be set to allow account registration.</p>