From 92d8a068adba8ba8b873521878ed4a70c3fcff60 Mon Sep 17 00:00:00 2001 From: David Baker Date: Thu, 24 Jan 2019 10:52:06 +0000 Subject: [PATCH 1/2] 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. --- synapse/config/server.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/synapse/config/server.py b/synapse/config/server.py index fb5779109..bc97b44a5 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 From 1f2058fca53e19358eeb490b2fc3a2cede106506 Mon Sep 17 00:00:00 2001 From: David Baker Date: Thu, 24 Jan 2019 10:57:12 +0000 Subject: [PATCH 2/2] Changelog --- changelog.d/4458.misc | 1 + 1 file changed, 1 insertion(+) create mode 100644 changelog.d/4458.misc diff --git a/changelog.d/4458.misc b/changelog.d/4458.misc new file mode 100644 index 000000000..8b3bc94a3 --- /dev/null +++ b/changelog.d/4458.misc @@ -0,0 +1 @@ +Clarify documentation for the `public_baseurl` config param