From 80338ba54b4f39ae838c03baa0f80adfe3936a39 Mon Sep 17 00:00:00 2001 From: Slavi Pantaleev Date: Wed, 19 Aug 2026 13:18:36 +0300 Subject: [PATCH] Remove the orphaned docs/configuring-playbook-jwt-service.md document This document and docs/configuring-playbook-livekit-jwt-service.md were both added in 9970603f1 (Add Element Call support), which squashed a branch that renamed the role along the way (matrix-jwt-service -> matrix-livekit-jwt-service). The document belonging to the old name survived the squash, was never linked to from anywhere and was never touched again, while the other one is the one referenced by the documentation index, the README and the Matrix RTC and Element Call documents. Its remaining content is covered elsewhere, and it was the only place telling people to enable matrix_livekit_jwt_service_enabled by hand. Co-Authored-By: Claude Opus 5 (1M context) --- docs/configuring-playbook-jwt-service.md | 47 ---------- .../docs/configuring-playbook-jwt-service.pot | 93 ------------------- 2 files changed, 140 deletions(-) delete mode 100644 docs/configuring-playbook-jwt-service.md delete mode 100644 i18n/translation-templates/docs/configuring-playbook-jwt-service.pot diff --git a/docs/configuring-playbook-jwt-service.md b/docs/configuring-playbook-jwt-service.md deleted file mode 100644 index 92eb5e3ce..000000000 --- a/docs/configuring-playbook-jwt-service.md +++ /dev/null @@ -1,47 +0,0 @@ - - -# 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. diff --git a/i18n/translation-templates/docs/configuring-playbook-jwt-service.pot b/i18n/translation-templates/docs/configuring-playbook-jwt-service.pot deleted file mode 100644 index db0a12f43..000000000 --- a/i18n/translation-templates/docs/configuring-playbook-jwt-service.pot +++ /dev/null @@ -1,93 +0,0 @@ -# SOME DESCRIPTIVE TITLE. -# Copyright (C) 2018-2026, Slavi Pantaleev, Aine Etke, MDAD community members -# This file is distributed under the same license as the matrix-docker-ansible-deploy package. -# FIRST AUTHOR , YEAR. -# -#, fuzzy -msgid "" -msgstr "" -"Project-Id-Version: matrix-docker-ansible-deploy \n" -"Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2026-02-13 10:32+0000\n" -"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" -"Last-Translator: FULL NAME \n" -"Language-Team: LANGUAGE \n" -"MIME-Version: 1.0\n" -"Content-Type: text/plain; charset=UTF-8\n" -"Content-Transfer-Encoding: 8bit\n" - -#: ../../../docs/configuring-playbook-jwt-service.md:8 -msgid "Setting up JWT Service (optional)" -msgstr "" - -#: ../../../docs/configuring-playbook-jwt-service.md:10 -msgid "The playbook can install and configure [LiveKit JWT Service](https://github.com/element-hq/lk-jwt-service) for you." -msgstr "" - -#: ../../../docs/configuring-playbook-jwt-service.md:12 -msgid "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." -msgstr "" - -#: ../../../docs/configuring-playbook-jwt-service.md:14 -msgid "See the project's [documentation](https://github.com/element-hq/lk-jwt-service/) to learn more." -msgstr "" - -#: ../../../docs/configuring-playbook-jwt-service.md:16 -msgid "Decide on a domain and path" -msgstr "" - -#: ../../../docs/configuring-playbook-jwt-service.md:18 -msgid "By default, JWT Service is configured to be served:" -msgstr "" - -#: ../../../docs/configuring-playbook-jwt-service.md:20 -msgid "on the Matrix domain (`matrix.example.com`), configurable via `matrix_livekit_jwt_service_hostname`" -msgstr "" - -#: ../../../docs/configuring-playbook-jwt-service.md:21 -msgid "under a `/livekit-jwt-service` path prefix, configurable via `matrix_livekit_jwt_service_path_prefix`" -msgstr "" - -#: ../../../docs/configuring-playbook-jwt-service.md:23 -msgid "This makes it easy to set it up, **without** having to adjust your DNS records manually." -msgstr "" - -#: ../../../docs/configuring-playbook-jwt-service.md:25 -msgid "Adjusting DNS records" -msgstr "" - -#: ../../../docs/configuring-playbook-jwt-service.md:27 -msgid "If you've changed the default hostname, **you may need to adjust your DNS** records accordingly to point to the correct server." -msgstr "" - -#: ../../../docs/configuring-playbook-jwt-service.md:29 -msgid "Adjusting the playbook configuration" -msgstr "" - -#: ../../../docs/configuring-playbook-jwt-service.md:31 -msgid "Add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" -msgstr "" - -#: ../../../docs/configuring-playbook-jwt-service.md:37 -msgid "Installing" -msgstr "" - -#: ../../../docs/configuring-playbook-jwt-service.md:39 -msgid "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`" -msgstr "" - -#: ../../../docs/configuring-playbook-jwt-service.md:41 -msgid "Usage" -msgstr "" - -#: ../../../docs/configuring-playbook-jwt-service.md:43 -msgid "Once installed, a new `org.matrix.msc4143.rtc_foci` section is added to the Element Web client to point to your JWT service URL (e.g., `https://matrix.example.com/livekit-jwt-service`)." -msgstr "" - -#: ../../../docs/configuring-playbook-jwt-service.md:45 -msgid "Additional Information" -msgstr "" - -#: ../../../docs/configuring-playbook-jwt-service.md:47 -msgid "Refer to the LiveKit JWT-Service documentation for more details on configuring and using JWT Service." -msgstr ""