Skip to content
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

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from

Conversation

XingLiAl
Copy link

@XingLiAl XingLiAl commented Nov 23, 2023

Actually, by my test, Synapse can serve Client Well-Known URI once you set public_baseurl in homeserver.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

  • Pull request is based on the develop branch
  • Pull request includes a changelog file. The entry should:
    • Be a short description of your change which makes sense to users. "Fixed a bug that prevented receiving messages from other servers." instead of "Moved X method from EventStore to EventWorkerStore.".
    • Use markdown where necessary, mostly for code blocks.
    • End with either a period (.) or an exclamation mark (!).
    • Start with a capital letter.
    • Feel free to credit yourself, by adding a sentence "Contributed by @github_username." or "Contributed by [Your Name]." to the end of the entry.
  • Pull request includes a sign off
  • Code style is correct
    (run the linters)

Signed-off-by: LiAlH4 [email protected]

fix some confusion
@XingLiAl XingLiAl requested a review from a team as a code owner November 23, 2023 09:26
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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I find this paragraph a bit confusing now... it might be clearer to do the following:

  1. 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.
  2. 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?

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants