diff options
| author | Neil Johnson <neil@matrix.org> | 2019-01-24 12:36:09 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-01-24 12:36:09 +0000 |
| commit | 5c41b223593f811a88e5ac2ca3f03b6dbdecb99b (patch) | |
| tree | f162177001da8b3e7533a5e76d72299ca15ea125 | |
| parent | Fix UPSERT check (#4459) (diff) | |
| parent | Changelog (diff) | |
| download | synapse-5c41b223593f811a88e5ac2ca3f03b6dbdecb99b.tar.xz | |
Merge pull request #4458 from matrix-org/dbkr/public_baseurl_doc
Clarify docs for public_baseurl
| -rw-r--r-- | changelog.d/4458.misc | 1 | ||||
| -rw-r--r-- | synapse/config/server.py | 6 |
2 files changed, 6 insertions, 1 deletions
diff --git a/changelog.d/4458.misc b/changelog.d/4458.misc new file mode 100644 index 0000000000..8b3bc94a34 --- /dev/null +++ b/changelog.d/4458.misc @@ -0,0 +1 @@ +Clarify documentation for the `public_baseurl` config param 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 |