From 54502f769da44d233020412874472fd95bda554d Mon Sep 17 00:00:00 2001 From: Ladislav Benc Date: Sun, 19 Jul 2020 22:35:50 +0200 Subject: [PATCH 1/5] Adding a clarification for the public_baseurl property. --- docs/sample_config.yaml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/sample_config.yaml b/docs/sample_config.yaml index 0e83f855bbf6..477f3b69c8d0 100644 --- a/docs/sample_config.yaml +++ b/docs/sample_config.yaml @@ -47,7 +47,9 @@ pid_file: DATADIR/homeserver.pid # (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. +# synapse via the proxy. If you use delegation and your synapse URL +# is different from the one specified in server_name, this URL should +# point to Synapse itself. # #public_baseurl: https://example.com/ From 3e8c851582ed93220b6175787bde6dbfd55900e2 Mon Sep 17 00:00:00 2001 From: Ladislav Benc Date: Mon, 20 Jul 2020 14:36:05 +0200 Subject: [PATCH 2/5] Also adding the clarification for the public_baseurl property to server.py. --- synapse/config/server.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/synapse/config/server.py b/synapse/config/server.py index 3586a7d49184..25d86662aa47 100644 --- a/synapse/config/server.py +++ b/synapse/config/server.py @@ -638,7 +638,9 @@ def generate_config_section( # (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. + # synapse via the proxy. If you use delegation and your synapse URL + # is different from the one specified in server_name, this URL should + # point to Synapse itself. # #public_baseurl: https://example.com/ From dc8f00a3b27a761a04cf1a3edcf03feff17816c8 Mon Sep 17 00:00:00 2001 From: Ladislav Benc Date: Mon, 20 Jul 2020 15:24:08 +0200 Subject: [PATCH 3/5] Removing the trailing whitespace --- synapse/config/server.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/synapse/config/server.py b/synapse/config/server.py index 25d86662aa47..16188b380073 100644 --- a/synapse/config/server.py +++ b/synapse/config/server.py @@ -638,7 +638,7 @@ def generate_config_section( # (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. If you use delegation and your synapse URL + # synapse via the proxy. If you use delegation and your synapse URL # is different from the one specified in server_name, this URL should # point to Synapse itself. # From 7ce0e3f50874629c09877175ce9bd4ffb42189bc Mon Sep 17 00:00:00 2001 From: Ladislav Benc Date: Mon, 20 Jul 2020 15:37:43 +0200 Subject: [PATCH 4/5] Removing trailing whitespace in sample_config.yaml Co-authored-by: Patrick Cloke --- docs/sample_config.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sample_config.yaml b/docs/sample_config.yaml index 477f3b69c8d0..15513faa01ee 100644 --- a/docs/sample_config.yaml +++ b/docs/sample_config.yaml @@ -47,7 +47,7 @@ pid_file: DATADIR/homeserver.pid # (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. If you use delegation and your synapse URL +# synapse via the proxy. If you use delegation and your synapse URL # is different from the one specified in server_name, this URL should # point to Synapse itself. # From 0311e6084bf608cc0e2bf5ef50661c2cdf4e7be6 Mon Sep 17 00:00:00 2001 From: Ladislav Benc Date: Fri, 24 Jul 2020 22:01:40 +0200 Subject: [PATCH 5/5] Added the changelog file. --- changelog.d/7906.doc | 1 + 1 file changed, 1 insertion(+) create mode 100644 changelog.d/7906.doc diff --git a/changelog.d/7906.doc b/changelog.d/7906.doc new file mode 100644 index 000000000000..dfdb73bb5bab --- /dev/null +++ b/changelog.d/7906.doc @@ -0,0 +1 @@ +Added an explanatory note for the the public_baseurl property. Contributed by zblesk.