mirror of
https://github.com/spantaleev/matrix-docker-ansible-deploy.git
synced 2026-08-20 15:50:51 +00:00
Slavi Pantaleev
421b592690
The org.matrix.msc4143.rtc_foci property has been dropped from MSC4143 and Element Call v0.24.0 no longer reads it, so the homeserver's own RTC transports API is left as the single source of truth. Synapse, continuwuity and tuwunel all serve it at the unstable path which clients request. Keeping both around also made Element Web list the same LiveKit transport twice, as it merges the two sources without deduplicating them. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
48 lines
1.9 KiB
Markdown
48 lines
1.9 KiB
Markdown
<!--
|
|
SPDX-FileCopyrightText: 2024 wjbeckett
|
|
SPDX-FileCopyrightText: 2024 Slavi Pantaleev
|
|
|
|
SPDX-License-Identifier: AGPL-3.0-or-later
|
|
-->
|
|
|
|
# Setting up JWT Service (optional)
|
|
|
|
The playbook can install and configure [LiveKit JWT Service](https://github.com/element-hq/lk-jwt-service) for you.
|
|
|
|
LK-JWT-Service is currently used for a single reason: generate JWT tokens with a given identity for a given room, so that users can use them to authenticate against LiveKit SFU.
|
|
|
|
See the project's [documentation](https://github.com/element-hq/lk-jwt-service/) to learn more.
|
|
|
|
## Decide on a domain and path
|
|
|
|
By default, JWT Service is configured to be served:
|
|
|
|
- on the Matrix domain (`matrix.example.com`), configurable via `matrix_livekit_jwt_service_hostname`
|
|
- under a `/livekit-jwt-service` path prefix, configurable via `matrix_livekit_jwt_service_path_prefix`
|
|
|
|
This makes it easy to set it up, **without** having to adjust your DNS records manually.
|
|
|
|
## Adjusting DNS records
|
|
|
|
If you've changed the default hostname, **you may need to adjust your DNS** records accordingly to point to the correct server.
|
|
|
|
## Adjusting the playbook configuration
|
|
|
|
Add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
|
|
|
|
```yaml
|
|
matrix_livekit_jwt_service_enabled: true
|
|
```
|
|
|
|
## Installing
|
|
|
|
After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: `just install-all` or `just setup-all`
|
|
|
|
## Usage
|
|
|
|
Once installed, the homeserver announces your JWT service URL (e.g., `https://matrix.example.com/livekit-jwt-service`) as a MatrixRTC transport over its `/_matrix/client/unstable/org.matrix.msc4143/rtc/transports` API, which is where Matrix clients discover it.
|
|
|
|
## Additional Information
|
|
|
|
Refer to the LiveKit JWT-Service documentation for more details on configuring and using JWT Service.
|