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
Open

Update installation.md to fix a confusion that whether synapse can serve Client Well-Known URI #16678

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a2ef94b
Update installation.md
Nov 23, 2023
c925160
Create 16678-doc
Nov 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog.d/16678-doc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Update installation.md to fix a confusion that whether synapse can serve Client Well-Known URI.
21 changes: 14 additions & 7 deletions docs/setup/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -496,6 +496,16 @@ Cross-Origin Resource Sharing (CORS) headers. A recommended value would be
`Access-Control-Allow-Origin: *` which would allow all browser based clients to
view it.

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.
Comment on lines +499 to +507
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?


In nginx this would be something like:

```nginx
Expand All @@ -506,14 +516,11 @@ location /.well-known/matrix/client {
}
```

You should also ensure the `public_baseurl` option in `homeserver.yaml` is set
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.
Comment on lines +519 to +523
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?


### Email

Expand Down
Loading