summary refs log tree commit diff
path: root/develop/usage/configuration/config_documentation.html
diff options
context:
space:
mode:
authorDMRobertson <DMRobertson@users.noreply.github.com>2022-06-16 10:48:52 +0000
committerDMRobertson <DMRobertson@users.noreply.github.com>2022-06-16 10:48:52 +0000
commit29737f643849fb53701048c53d4dac84c693e53a (patch)
tree4622c4bc0c36617ad10e061961b92f2cb598fcc9 /develop/usage/configuration/config_documentation.html
parentdeploy: ffe2464836dec7bbce2659b2b4e62eb956bf2a90 (diff)
downloadsynapse-29737f643849fb53701048c53d4dac84c693e53a.tar.xz
deploy: 0ef1307619799bec2bbb96ce6516f307b0f8f217
Diffstat (limited to '')
-rw-r--r--develop/usage/configuration/config_documentation.html12
1 files changed, 12 insertions, 0 deletions
diff --git a/develop/usage/configuration/config_documentation.html b/develop/usage/configuration/config_documentation.html
index 1739d97c4c..ea72828118 100644
--- a/develop/usage/configuration/config_documentation.html
+++ b/develop/usage/configuration/config_documentation.html
@@ -316,6 +316,18 @@ information.</p>
 <pre><code class="language-yaml">serve_server_wellknown: true
 </code></pre>
 <hr />
+<h3 id="extra_well_known_client_content"><a class="header" href="#extra_well_known_client_content"><code>extra_well_known_client_content </code></a></h3>
+<p>This option allows server runners to add arbitrary key-value pairs to the <a href="https://spec.matrix.org/latest/client-server-api/#well-known-uri">client-facing <code>.well-known</code> response</a>.
+Note that the <code>public_baseurl</code> config option must be provided for Synapse to serve a response to <code>/.well-known/matrix/client</code> at all.</p>
+<p>If this option is provided, it parses the given yaml to json and 
+serves it on <code>/.well-known/matrix/client</code> endpoint
+alongside the standard properties.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">extra_well_known_client_content : 
+  option1: value1
+  option2: value2
+</code></pre>
+<hr />
 <h3 id="soft_file_limit"><a class="header" href="#soft_file_limit"><code>soft_file_limit</code></a></h3>
 <p>Set the soft limit on the number of file descriptors synapse can use.
 Zero is used to indicate synapse should set the soft limit to the hard limit.