summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorJacek KuĊ›nierz <jacek.kusnierz@tum.de>2022-06-16 12:48:18 +0200
committerGitHub <noreply@github.com>2022-06-16 11:48:18 +0100
commit0ef1307619799bec2bbb96ce6516f307b0f8f217 (patch)
treedfbaaad6bfb22e0244733df8e538bcc6b8d5d660 /docs
parentAdd instructions for running Complement with `gotestfmt`-formatted output loc... (diff)
downloadsynapse-0ef1307619799bec2bbb96ce6516f307b0f8f217.tar.xz
Add custom well-known (#13035)
Co-authored-by: David Robertson <david.m.robertson1@gmail.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/usage/configuration/config_documentation.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md
index 7c9860c3e1..58a74ace48 100644
--- a/docs/usage/configuration/config_documentation.md
+++ b/docs/usage/configuration/config_documentation.md
@@ -230,6 +230,22 @@ Example configuration:
 serve_server_wellknown: true
 ```
 ---
+### `extra_well_known_client_content `
+
+This option allows server runners to add arbitrary key-value pairs to the [client-facing `.well-known` response](https://spec.matrix.org/latest/client-server-api/#well-known-uri).
+Note that the `public_baseurl` config option must be provided for Synapse to serve a response to `/.well-known/matrix/client` at all.
+
+If this option is provided, it parses the given yaml to json and 
+serves it on `/.well-known/matrix/client` endpoint
+alongside the standard properties.
+
+Example configuration:
+```yaml
+extra_well_known_client_content : 
+  option1: value1
+  option2: value2
+```
+---
 ### `soft_file_limit`
  
 Set the soft limit on the number of file descriptors synapse can use.
@@ -3580,3 +3596,4 @@ background_updates:
     min_batch_size: 10
     default_batch_size: 50
 ```
+