Skip to content

Simplify the setup documentation introduction #3994

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 13, 2025
Merged

Simplify the setup documentation introduction #3994

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ee9eeea
Update README.md
escix Feb 9, 2025
da944cc
Update README.md
escix Feb 13, 2025
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
8 changes: 4 additions & 4 deletions docs/setup/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ By default, the `issuer` will match the root domain where the service is deploye
An example setup could look like this:

- The deployment domain is `example.com`, so Matrix IDs look like `@user:example.com`
- The issuer chosen is `https://example.com/`
- The issuer chosen is `https://auth.example.com/`
- The homeserver is deployed on `matrix.example.com`
- The authentication service is deployed on `auth.example.com`
- Calling `https://example.com/.well-known/matrix/client` returns the following JSON:
Expand All @@ -30,17 +30,17 @@ An example setup could look like this:
"base_url": "https://matrix.example.com"
},
"org.matrix.msc2965.authentication": {
"issuer": "https://example.com/",
"issuer": "https://auth.example.com/",
"account": "https://auth.example.com/account"
}
}
```

- Calling `https://example.com/.well-known/openid-configuration` returns a JSON document similar to the following:
- Calling `https://auth.example.com/.well-known/openid-configuration` returns a JSON document similar to the following:

```json
{
"issuer": "https://example.com/",
"issuer": "https://auth.example.com/",
"authorization_endpoint": "https://auth.example.com/authorize",
"token_endpoint": "https://auth.example.com/oauth2/token",
"jwks_uri": "https://auth.example.com/oauth2/keys.json",
Expand Down
Loading