summary refs log tree commit diff
path: root/synapse/config/server.py
diff options
context:
space:
mode:
authorNeil Johnson <neil@matrix.org>2019-01-24 12:36:09 +0000
committerGitHub <noreply@github.com>2019-01-24 12:36:09 +0000
commit5c41b223593f811a88e5ac2ca3f03b6dbdecb99b (patch)
treef162177001da8b3e7533a5e76d72299ca15ea125 /synapse/config/server.py
parentFix UPSERT check (#4459) (diff)
parentChangelog (diff)
downloadsynapse-5c41b223593f811a88e5ac2ca3f03b6dbdecb99b.tar.xz
Merge pull request #4458 from matrix-org/dbkr/public_baseurl_doc
Clarify docs for public_baseurl
Diffstat (limited to 'synapse/config/server.py')
-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