This repository has been archived by the owner on Apr 26, 2024. It is now read-only.
Update installation.md to fix a confusion that whether synapse can serve Client Well-Known URI #16678
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
fix some confusion
clokep
reviewed
Nov 29, 2023
Comment on lines
+499
to
+507
| Synapse will serve it once you set `public_baseurl` in your `homeserver.yaml`. | ||
|
|
||
| Just like: | ||
|
|
||
| ```yaml | ||
| public_baseurl: "https://<matrix.example.com>" | ||
| ``` | ||
|
|
||
| Alternatively, you can set your reverse proxy to serve it. |
There was a problem hiding this comment.
Suggested change
| Synapse will serve it once you set `public_baseurl` in your `homeserver.yaml`. | |
| Just like: | |
| ```yaml | |
| public_baseurl: "https://<matrix.example.com>" | |
| ``` | |
| Alternatively, you can set your reverse proxy to serve it. | |
| Synapse will generate a response if `public_baseurl` is configured in `homeserver.yaml`: | |
| ```yaml | |
| public_baseurl: "https://<matrix.example.com>" |
Alternatively, you can set your reverse proxy to serve it.
There was a problem hiding this comment.
Should this cross-reference the configuration manual w/ the various settings it can include?
Comment on lines
+519
to
+523
| You should always ensure the `public_baseurl` option in `homeserver.yaml` is set | ||
| correctly. `public_baseurl` should be set to the URL that clients will use to | ||
| connect to your server. This is the same URL you put for the `m.homeserver` | ||
| `base_url` above. | ||
|
|
||
| ```yaml | ||
| public_baseurl: "https://<matrix.example.com>" | ||
| ``` | ||
| connect to your server. If you use reverse proxy to serve client Well-Known URI, | ||
| you should ensure the URL you put for the `public_baseurl` in `homeserver.yaml` | ||
| and `m.homeserver` `base_url` in your reverse proxy config must be the same. |
There was a problem hiding this comment.
I find this paragraph a bit confusing now... it might be clearer to do the following:
- Add a new sub-heading (under "Client Well-Known URI") which is "Serve client well-known with Synapse", this would contain the new bits you added about this.
- Put the reverse proxy bits into a new sub-heading "Serve client well-known with reverse proxy"
Maybe include the public_baseurl before either section then since it is needed for both?
4 tasks
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Actually, by my test, Synapse can serve Client Well-Known URI once you set
public_baseurlinhomeserver.yaml. But current document seems unclear on this and make newbies feel "Synapse can't serve Client Well-Known URI and I must use a reverse proxy to do it".In fact, I was stuck in it at first...
Pull Request Checklist
EventStoretoEventWorkerStore.".code blocks.(run the linters)
Signed-off-by: LiAlH4 [email protected]