summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorAndrew Morgan <1342360+anoadragon453@users.noreply.github.com>2020-04-15 13:35:29 +0100
committerGitHub <noreply@github.com>2020-04-15 13:35:29 +0100
commita48138784ea20dd8d8a68ce5c3563da6f3fbde43 (patch)
tree24cb8055a17659b04af5b5ef271457969e8b85fa /docs
parentFix a potentially-huge sql query (#7274) (diff)
downloadsynapse-a48138784ea20dd8d8a68ce5c3563da6f3fbde43.tar.xz
Allow specifying the value of Accept-Language header for URL previews (#7265)
Diffstat (limited to 'docs')
-rw-r--r--docs/sample_config.yaml25
1 files changed, 25 insertions, 0 deletions
diff --git a/docs/sample_config.yaml b/docs/sample_config.yaml
index 3417813750..81dccbd997 100644
--- a/docs/sample_config.yaml
+++ b/docs/sample_config.yaml
@@ -859,6 +859,31 @@ media_store_path: "DATADIR/media_store"
 #
 #max_spider_size: 10M
 
+# A list of values for the Accept-Language HTTP header used when
+# downloading webpages during URL preview generation. This allows
+# Synapse to specify the preferred languages that URL previews should
+# be in when communicating with remote servers.
+#
+# Each value is a IETF language tag; a 2-3 letter identifier for a
+# language, optionally followed by subtags separated by '-', specifying
+# a country or region variant.
+#
+# Multiple values can be provided, and a weight can be added to each by
+# using quality value syntax (;q=). '*' translates to any language.
+#
+# Defaults to "en".
+#
+# Example:
+#
+# url_preview_accept_language:
+#   - en-UK
+#   - en-US;q=0.9
+#   - fr;q=0.8
+#   - *;q=0.7
+#
+url_preview_accept_language:
+#   - en
+
 
 ## Captcha ##
 # See docs/CAPTCHA_SETUP for full details of configuring this.