Skip to content

Commit 8757445

Browse files
authored
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
1 parent a0d7780 commit 8757445

File tree

6 files changed

+10
-9
lines changed

6 files changed

+10
-9
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,8 @@ via the `org.matrix.msc4143.rtc_foci` key, e.g.:
143143
where the format for MatrixRTC using LiveKit backend is defined in
144144
[MSC4195](https://github.com/hughns/matrix-spec-proposals/blob/hughns/matrixrtc-livekit/proposals/4195-matrixrtc-livekit.md).
145145
In the example above Matrix clients do discover a focus of type `livekit` which
146-
points them to a Matrix LiveKit JWT Auth Service via `livekit_service_url`.
146+
points them to a [MatrixRTC Authorization Service](https://github.com/element-hq/lk-jwt-service)
147+
via `livekit_service_url`.
147148

148149
### Backend Selection
149150

@@ -154,9 +155,9 @@ points them to a Matrix LiveKit JWT Auth Service via `livekit_service_url`.
154155
the **first participant who joined the call** defines via the `foci_preferred`
155156
key in their `org.matrix.msc3401.call.member` which actual MatrixRTC backend
156157
will be used for this call.
157-
- During the actual call join flow, the **LiveKit JWT Auth Service** provides
158-
the client with the **LiveKit SFU WebSocket URL** and an **access JWT token**
159-
in order to exchange media via WebRTC.
158+
- During the actual call join flow, the **[MatrixRTC Authorization Service](https://github.com/element-hq/lk-jwt-service)**
159+
provides the client with the **LiveKit SFU WebSocket URL** and an
160+
**access JWT token** in order to exchange media via WebRTC.
160161

161162
The example below illustrates how backend selection works across **Matrix
162163
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
208209
whole stack of components which is required for a local development environment:
209210

210211
- Minimum Synapse Setup (servername: `synapse.m.localhost`)
211-
- LiveKit Authorization Service (Note requires Federation API and hence a TLS reverse proxy)
212+
- MatrixRTC Authorization Service (Note requires Federation API and hence a TLS reverse proxy)
212213
- Minimum LiveKit SFU Setup using dev defaults for config
213214
- Redis db for completeness
214215
- Minimum `localhost` Certificate Authority (CA) for Transport Layer Security (TLS)

docs/Federated_Setup.drawio.png

5.54 KB
Loading

docs/MSC4195_setup.drawio.png

373 Bytes
Loading
12.1 KB
Loading

docs/element_call_widget.drawio.png

21.9 KB
Loading

docs/self-hosting.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ rc_delayed_event_mgmt:
6464
```
6565
6666
As a prerequisite for the
67-
[Matrix LiveKit JWT auth service](https://github.com/element-hq/lk-jwt-service)
67+
[MatrixRTC Authorization Service](https://github.com/element-hq/lk-jwt-service)
6868
make sure that your Synapse server has either a `federation` or `openid`
6969
[listener configured](https://element-hq.github.io/synapse/latest/usage/configuration/config_documentation.html#listeners).
7070

@@ -77,7 +77,7 @@ required for each site deployment.
7777

7878
As depicted above in the `example.com` site deployment, Element Call requires a
7979
[Livekit SFU](https://github.com/livekit/livekit) alongside a
80-
[Matrix Livekit JWT auth service](https://github.com/element-hq/lk-jwt-service)
80+
[MatrixRTC Authorization Service](https://github.com/element-hq/lk-jwt-service)
8181
to implement
8282
[MSC4195: MatrixRTC using LiveKit backend](https://github.com/hughns/matrix-spec-proposals/blob/hughns/matrixrtc-livekit/proposals/4195-matrixrtc-livekit.md).
8383

@@ -89,7 +89,7 @@ the example above, this results in:
8989
| Service | Endpoint | Example |
9090
| -------- | ------- | ------- |
9191
| [Livekit SFU](https://github.com/livekit/livekit) WebSocket signalling connection | `/livekit/sfu` | `matrix-rtc.example.com/livekit/sfu` |
92-
| [Matrix Livekit JWT auth service](https://github.com/element-hq/lk-jwt-service) | `/livekit/jwt` | `matrix-rtc.example.com/livekit/jwt` |
92+
| [MatrixRTC Authorization Service](https://github.com/element-hq/lk-jwt-service) | `/livekit/jwt` | `matrix-rtc.example.com/livekit/jwt` |
9393

9494
Using Nginx, you can achieve this by:
9595

@@ -102,7 +102,7 @@ server {
102102
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
103103
proxy_set_header X-Forwarded-Proto $scheme;
104104
105-
# JWT Service running at port 8080
105+
# MatrixRTC Authorization Service running at port 8080
106106
proxy_pass http://localhost:8080/;
107107
}
108108

0 commit comments

Comments
 (0)