Skip to content

Commit e3d1b8a

Browse files
committed
docs: stop talking about the .well-known/matrix/client changes
These were relevant on an old version of the specs, and just confuses people.
1 parent 114ae7d commit e3d1b8a

File tree

4 files changed

+1
-61
lines changed

4 files changed

+1
-61
lines changed

docs/SUMMARY.md

-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@
1212
- [Database setup](./setup/database.md)
1313
- [Homeserver configuration](./setup/homeserver.md)
1414
- [Configuring a reverse proxy](./setup/reverse-proxy.md)
15-
- [Configuring .well-known](./setup/well-known.md)
1615
- [Configure an upstream SSO provider](./setup/sso.md)
1716
- [Running the service](./setup/running.md)
1817
- [Migrating an existing homeserver](./setup/migration.md)

docs/setup/README.md

+1-33
Original file line numberDiff line numberDiff line change
@@ -11,43 +11,11 @@ The authentication service becomes the source of truth for user accounts and acc
1111
At time of writing, the authentication service is meant to be run on a standalone domain name (e.g. `auth.example.com`), and the homeserver on another (e.g. `matrix.example.com`).
1212
This domain will be user-facing as part of the authentication flow.
1313

14-
When a client initiates an authentication flow, it will discover the authentication service through the deployment `.well-known/matrix/client` endpoint.
15-
This file will refer to an `issuer`, which is the canonical name of the authentication service instance.
16-
Out of that issuer, it will discover the rest of the endpoints by calling the `[issuer]/.well-known/openid-configuration` endpoint.
17-
By default, the `issuer` will match the root domain where the service is deployed (e.g. `https://auth.example.com/`), but it can be configured to be different.
18-
1914
An example setup could look like this:
2015

2116
- The deployment domain is `example.com`, so Matrix IDs look like `@user:example.com`
22-
- The issuer chosen is `https://auth.example.com/`
23-
- The homeserver is deployed on `matrix.example.com`
2417
- The authentication service is deployed on `auth.example.com`
25-
- Calling `https://example.com/.well-known/matrix/client` returns the following JSON:
26-
27-
```json
28-
{
29-
"m.homeserver": {
30-
"base_url": "https://matrix.example.com"
31-
},
32-
"org.matrix.msc2965.authentication": {
33-
"issuer": "https://auth.example.com/",
34-
"account": "https://auth.example.com/account"
35-
}
36-
}
37-
```
38-
39-
- Calling `https://auth.example.com/.well-known/openid-configuration` returns a JSON document similar to the following:
40-
41-
```json
42-
{
43-
"issuer": "https://auth.example.com/",
44-
"authorization_endpoint": "https://auth.example.com/authorize",
45-
"token_endpoint": "https://auth.example.com/oauth2/token",
46-
"jwks_uri": "https://auth.example.com/oauth2/keys.json",
47-
"registration_endpoint": "https://auth.example.com/oauth2/registration",
48-
"//": "..."
49-
}
50-
```
18+
- The homeserver is deployed on `matrix.example.com`
5119

5220
With the installation planned, it is time to go through the installation and configuration process.
5321
The first section focuses on [installing the service](./installation.md).

docs/setup/migration.md

-4
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,3 @@ Start up the homeserver again with the new configuration.
203203
### Start up MAS
204204

205205
Start up MAS.
206-
207-
### Update or serve the .well-known
208-
209-
The `.well-known/matrix/client` needs to be served as described [here](./well-known.md).

docs/setup/well-known.md

-23
This file was deleted.

0 commit comments

Comments
 (0)