summary refs log tree commit diff
path: root/docs/sample_config.yaml
diff options
context:
space:
mode:
authorPatrick Cloke <clokep@users.noreply.github.com>2021-08-31 18:37:07 -0400
committerGitHub <noreply@github.com>2021-08-31 18:37:07 -0400
commite2481dbe9325321d460037a2efe9b9ea2ac78057 (patch)
tree3f854d614a5be0e90e8a07ad02e15fb9de143ef4 /docs/sample_config.yaml
parentAdditional type hints for the client REST servlets (part 3). (#10707) (diff)
downloadsynapse-e2481dbe9325321d460037a2efe9b9ea2ac78057.tar.xz
Allow configuration of the oEmbed URLs. (#10714)
This adds configuration options (under an `oembed` section) to
configure which URLs are matched to use oEmbed for URL
previews.
Diffstat (limited to 'docs/sample_config.yaml')
-rw-r--r--docs/sample_config.yaml21
1 files changed, 21 insertions, 0 deletions
diff --git a/docs/sample_config.yaml b/docs/sample_config.yaml
index 935841dbfa..e155b978d8 100644
--- a/docs/sample_config.yaml
+++ b/docs/sample_config.yaml
@@ -1075,6 +1075,27 @@ url_preview_accept_language:
 #   - en
 
 
+# oEmbed allows for easier embedding content from a website. It can be
+# used for generating URLs previews of services which support it.
+#
+oembed:
+  # A default list of oEmbed providers is included with Synapse.
+  #
+  # Uncomment the following to disable using these default oEmbed URLs.
+  # Defaults to 'false'.
+  #
+  #disable_default_providers: true
+
+  # Additional files with oEmbed configuration (each should be in the
+  # form of providers.json).
+  #
+  # By default, this list is empty (so only the default providers.json
+  # is used).
+  #
+  #additional_providers:
+  #  - oembed/my_providers.json
+
+
 ## Captcha ##
 # See docs/CAPTCHA_SETUP.md for full details of configuring this.