From 673ebb07463cf1401f83fdd0db17da501d1a3881 Mon Sep 17 00:00:00 2001 From: kstro1 Date: Thu, 23 Oct 2025 01:49:32 +0300 Subject: [PATCH] Minor improvements to the README. --- README.md | 40 ++++++++++++++++++++-------------------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index e06e76c..d342e1a 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ ## Introduction -To enable audio and video calls for [Matrix](https://matrix.org/) clients such as Element X which implement the current Matrix specification, Matrix servers must provide a [MatrixRTC](https://github.com/element-hq/element-call/blob/livekit/docs/self-hosting.md) back-end, comprised of [LiveKit](https://github.com/livekit/livekit) and [MatrixRTC Authorization Service](https://github.com/element-hq/lk-jwt-service) instances. +To enable audio and video calls for [Matrix](https://matrix.org/) clients such as Element X which implement the current Matrix specification, Matrix servers must provide a [MatrixRTC](https://github.com/element-hq/element-call/blob/livekit/docs/self-hosting.md) back-end, comprised of [LiveKit Server](https://github.com/livekit/livekit) and [MatrixRTC Authorization Service](https://github.com/element-hq/lk-jwt-service) instances. While a number of guides explaining how to deploy a [Synapse](https://github.com/element-hq/synapse) Matrix server instance using Docker Compose and [Traefik](https://doc.traefik.io/traefik/) may be found on the internet, instructions for deploying a MatrixRTC back-end using Traefik as a reverse proxy appear to have been so far unavailable as of the time of writing. This short guide is intended to fill that gap. @@ -189,7 +189,25 @@ curl -XPOST -d \ "https://synapse.example.com/_matrix/client/r0/login" ``` -### Software Updates +### Troubleshooting + +#### General + +At the time of writing, it is possible to configure a homeserver to use the MatrixRTC back-end instance provided by Element by setting the `livekit_service_url` parameter in Synapse's `.well-known/matrix/client` config file to `https://jwt.call.element.io`. This may be useful for testing and debugging. + +#### Firewall + +If using the UFW firewall, run the following command to verify that UFW is not blocking a connection, causing a call to fail. + +``` +journalctl --since "2025-09-07 09:00:00" | grep "UFW BLOCK" +``` + +#### Debug Console + +The debug console in Element Desktop may be opened by pressing `CTRL+SHIFT+I` and switching to the console tab. + +## Software Updates Keeping the MatrixRTC instance up to date with the latest software may be accomplished by pulling the latest images listed in the table below for the corresponding tags. @@ -210,21 +228,3 @@ Obsolete images may be removed as follows: ``` docker image prune ``` - -### Troubleshooting - -#### General - -At the time of writing, it is possible to configure a homeserver to use the MatrixRTC back-end instance provided by Element by setting the `livekit_service_url` parameter in Synapse's `.well-known/matrix/client` config file to `https://jwt.call.element.io`. This may be useful for testing and debugging. - -#### Firewall - -If using the UFW firewall, run the following command to verify that UFW is not blocking a connection, causing a call to fail. - -``` -journalctl --since "2025-09-07 09:00:00" | grep "UFW BLOCK" -``` - -#### Debug Console - -The debug console in Element Desktop may be opened by pressing `CTRL+SHIFT+I` and switching to the console tab.