summary refs log tree commit diff
diff options
context:
space:
mode:
authorDavid Baker <dave@matrix.org>2019-01-24 10:52:06 +0000
committerDavid Baker <dave@matrix.org>2019-01-24 10:52:06 +0000
commit92d8a068adba8ba8b873521878ed4a70c3fcff60 (patch)
tree73012b41bb58f6c97c0b25baebf352245a7e4eb5
parentUse native UPSERTs where possible (#4306) (diff)
downloadsynapse-92d8a068adba8ba8b873521878ed4a70c3fcff60.tar.xz
Clarify docs for public_baseurl
This is leading to problems with people upgrading to clients that
support MSC1730 because people have this misconfigured, so try
to make the docs completely unambiguous.
-rw-r--r--synapse/config/server.py6
1 files changed, 5 insertions, 1 deletions
diff --git a/synapse/config/server.py b/synapse/config/server.py
index fb57791098..bc97b44a5b 100644
--- a/synapse/config/server.py
+++ b/synapse/config/server.py
@@ -256,7 +256,11 @@ class ServerConfig(Config):
         #
         # web_client_location: "/path/to/web/root"
 
-        # The public-facing base URL for the client API (not including _matrix/...)
+        # The public-facing base URL that clients use to access this HS
+        # (not including _matrix/...). This is the same URL a user would
+        # enter into the 'custom HS URL' field on their client. If you
+        # use synapse with a reverse proxy, this should be the URL to reach
+        # synapse via the proxy.
         # public_baseurl: https://example.com:8448/
 
         # Set the soft limit on the number of file descriptors synapse can use