Doc: Use new naming of jwt auth service (#3455)
* use new naming of jwt auth service * use new name of jwt service * added links the https://github.com/element-hq/lk-jwt-service
11
README.md
@@ -143,7 +143,8 @@ via the `org.matrix.msc4143.rtc_foci` key, e.g.:
|
|||||||
where the format for MatrixRTC using LiveKit backend is defined in
|
where the format for MatrixRTC using LiveKit backend is defined in
|
||||||
[MSC4195](https://github.com/hughns/matrix-spec-proposals/blob/hughns/matrixrtc-livekit/proposals/4195-matrixrtc-livekit.md).
|
[MSC4195](https://github.com/hughns/matrix-spec-proposals/blob/hughns/matrixrtc-livekit/proposals/4195-matrixrtc-livekit.md).
|
||||||
In the example above Matrix clients do discover a focus of type `livekit` which
|
In the example above Matrix clients do discover a focus of type `livekit` which
|
||||||
points them to a Matrix LiveKit JWT Auth Service via `livekit_service_url`.
|
points them to a [MatrixRTC Authorization Service](https://github.com/element-hq/lk-jwt-service)
|
||||||
|
via `livekit_service_url`.
|
||||||
|
|
||||||
### Backend Selection
|
### Backend Selection
|
||||||
|
|
||||||
@@ -154,9 +155,9 @@ points them to a Matrix LiveKit JWT Auth Service via `livekit_service_url`.
|
|||||||
the **first participant who joined the call** defines via the `foci_preferred`
|
the **first participant who joined the call** defines via the `foci_preferred`
|
||||||
key in their `org.matrix.msc3401.call.member` which actual MatrixRTC backend
|
key in their `org.matrix.msc3401.call.member` which actual MatrixRTC backend
|
||||||
will be used for this call.
|
will be used for this call.
|
||||||
- During the actual call join flow, the **LiveKit JWT Auth Service** provides
|
- During the actual call join flow, the **[MatrixRTC Authorization Service](https://github.com/element-hq/lk-jwt-service)**
|
||||||
the client with the **LiveKit SFU WebSocket URL** and an **access JWT token**
|
provides the client with the **LiveKit SFU WebSocket URL** and an
|
||||||
in order to exchange media via WebRTC.
|
**access JWT token** in order to exchange media via WebRTC.
|
||||||
|
|
||||||
The example below illustrates how backend selection works across **Matrix
|
The example below illustrates how backend selection works across **Matrix
|
||||||
federation**, using the setup from sites A, B, and C. It demonstrates backend
|
federation**, using the setup from sites A, B, and C. It demonstrates backend
|
||||||
@@ -208,7 +209,7 @@ A docker compose file `dev-backend-docker-compose.yml` is provided to start the
|
|||||||
whole stack of components which is required for a local development environment:
|
whole stack of components which is required for a local development environment:
|
||||||
|
|
||||||
- Minimum Synapse Setup (servername: `synapse.m.localhost`)
|
- Minimum Synapse Setup (servername: `synapse.m.localhost`)
|
||||||
- LiveKit Authorization Service (Note requires Federation API and hence a TLS reverse proxy)
|
- MatrixRTC Authorization Service (Note requires Federation API and hence a TLS reverse proxy)
|
||||||
- Minimum LiveKit SFU Setup using dev defaults for config
|
- Minimum LiveKit SFU Setup using dev defaults for config
|
||||||
- Redis db for completeness
|
- Redis db for completeness
|
||||||
- Minimum `localhost` Certificate Authority (CA) for Transport Layer Security (TLS)
|
- Minimum `localhost` Certificate Authority (CA) for Transport Layer Security (TLS)
|
||||||
|
|||||||
|
Before Width: | Height: | Size: 86 KiB After Width: | Height: | Size: 91 KiB |
|
Before Width: | Height: | Size: 67 KiB After Width: | Height: | Size: 67 KiB |
|
Before Width: | Height: | Size: 929 KiB After Width: | Height: | Size: 941 KiB |
|
Before Width: | Height: | Size: 886 KiB After Width: | Height: | Size: 908 KiB |
@@ -64,7 +64,7 @@ rc_delayed_event_mgmt:
|
|||||||
```
|
```
|
||||||
|
|
||||||
As a prerequisite for the
|
As a prerequisite for the
|
||||||
[Matrix LiveKit JWT auth service](https://github.com/element-hq/lk-jwt-service)
|
[MatrixRTC Authorization Service](https://github.com/element-hq/lk-jwt-service)
|
||||||
make sure that your Synapse server has either a `federation` or `openid`
|
make sure that your Synapse server has either a `federation` or `openid`
|
||||||
[listener configured](https://element-hq.github.io/synapse/latest/usage/configuration/config_documentation.html#listeners).
|
[listener configured](https://element-hq.github.io/synapse/latest/usage/configuration/config_documentation.html#listeners).
|
||||||
|
|
||||||
@@ -77,7 +77,7 @@ required for each site deployment.
|
|||||||
|
|
||||||
As depicted above in the `example.com` site deployment, Element Call requires a
|
As depicted above in the `example.com` site deployment, Element Call requires a
|
||||||
[Livekit SFU](https://github.com/livekit/livekit) alongside a
|
[Livekit SFU](https://github.com/livekit/livekit) alongside a
|
||||||
[Matrix Livekit JWT auth service](https://github.com/element-hq/lk-jwt-service)
|
[MatrixRTC Authorization Service](https://github.com/element-hq/lk-jwt-service)
|
||||||
to implement
|
to implement
|
||||||
[MSC4195: MatrixRTC using LiveKit backend](https://github.com/hughns/matrix-spec-proposals/blob/hughns/matrixrtc-livekit/proposals/4195-matrixrtc-livekit.md).
|
[MSC4195: MatrixRTC using LiveKit backend](https://github.com/hughns/matrix-spec-proposals/blob/hughns/matrixrtc-livekit/proposals/4195-matrixrtc-livekit.md).
|
||||||
|
|
||||||
@@ -89,7 +89,7 @@ the example above, this results in:
|
|||||||
| Service | Endpoint | Example |
|
| Service | Endpoint | Example |
|
||||||
| -------- | ------- | ------- |
|
| -------- | ------- | ------- |
|
||||||
| [Livekit SFU](https://github.com/livekit/livekit) WebSocket signalling connection | `/livekit/sfu` | `matrix-rtc.example.com/livekit/sfu` |
|
| [Livekit SFU](https://github.com/livekit/livekit) WebSocket signalling connection | `/livekit/sfu` | `matrix-rtc.example.com/livekit/sfu` |
|
||||||
| [Matrix Livekit JWT auth service](https://github.com/element-hq/lk-jwt-service) | `/livekit/jwt` | `matrix-rtc.example.com/livekit/jwt` |
|
| [MatrixRTC Authorization Service](https://github.com/element-hq/lk-jwt-service) | `/livekit/jwt` | `matrix-rtc.example.com/livekit/jwt` |
|
||||||
|
|
||||||
Using Nginx, you can achieve this by:
|
Using Nginx, you can achieve this by:
|
||||||
|
|
||||||
@@ -102,7 +102,7 @@ server {
|
|||||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||||
proxy_set_header X-Forwarded-Proto $scheme;
|
proxy_set_header X-Forwarded-Proto $scheme;
|
||||||
|
|
||||||
# JWT Service running at port 8080
|
# MatrixRTC Authorization Service running at port 8080
|
||||||
proxy_pass http://localhost:8080/;
|
proxy_pass http://localhost:8080/;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||