This repository has been archived by the owner on Apr 26, 2024. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Update installation.md to fix a confusion that whether synapse can serve Client Well-Known URI #16678
Open
XingLiAl
wants to merge
2
commits into
matrix-org:develop
Choose a base branch
from
XingLiAl:patch-1
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Update installation.md to fix a confusion that whether synapse can serve Client Well-Known URI #16678
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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. |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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. | ||
|
||
In nginx this would be something like: | ||
|
||
```nginx | ||
|
@@ -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
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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:
Maybe include the |
||
|
||
|
||
|
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Alternatively, you can set your reverse proxy to serve it.
There was a problem hiding this comment.
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?