summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorMartin Milata <martin@martinmilata.cz>2020-04-03 17:57:34 +0200
committerGitHub <noreply@github.com>2020-04-03 11:57:34 -0400
commitb0db928c633ad2e225623cffb20293629c5d5a43 (patch)
tree5478d4e177404ec3996f2a946006e8f2364562dd /docs
parentAdd some benchmarks for LruCache (#6446) (diff)
downloadsynapse-b0db928c633ad2e225623cffb20293629c5d5a43.tar.xz
Extend web_client_location to handle absolute URLs (#7006)
Log warning when filesystem path is used.

Signed-off-by: Martin Milata <martin@martinmilata.cz>
Diffstat (limited to 'docs')
-rw-r--r--docs/sample_config.yaml11
1 files changed, 8 insertions, 3 deletions
diff --git a/docs/sample_config.yaml b/docs/sample_config.yaml
index 6a770508f9..be742969cc 100644
--- a/docs/sample_config.yaml
+++ b/docs/sample_config.yaml
@@ -33,10 +33,15 @@ server_name: "SERVERNAME"
 #
 pid_file: DATADIR/homeserver.pid
 
-# The path to the web client which will be served at /_matrix/client/
-# if 'webclient' is configured under the 'listeners' configuration.
+# The absolute URL to the web client which /_matrix/client will redirect
+# to if 'webclient' is configured under the 'listeners' configuration.
 #
-#web_client_location: "/path/to/web/root"
+# This option can be also set to the filesystem path to the web client
+# which will be served at /_matrix/client/ if 'webclient' is configured
+# under the 'listeners' configuration, however this is a security risk:
+# https://github.com/matrix-org/synapse#security-note
+#
+#web_client_location: https://riot.example.com/
 
 # The public-facing base URL that clients use to access this HS
 # (not including _matrix/...). This is the same URL a user would