kstro1/matrixrtc-docker-traefik
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Minor improvements to the README.

Browse source
This commit is contained in:
kstro1 2025-09-08 21:30:20 +03:00
parent b38cb46ad8
commit ef38dc67f6
1 changed files with 4 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -2,9 +2,9 @@
## 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 [Matrix-RTC](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.
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 [Matrix-RTC](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.
While instructions 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/) abound on the internet, at the time of writing apparently no instructions concerning how to deploy a Matrix-RTC back-end using Traefik as a reverse proxy are publicly available.
While instructions 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/) abound on the internet, instructions for deploying a Matrix-RTC back-end using Traefik as a reverse proxy appear to have been so far unavailable as of the time of writing. These instructions are intended to fill that gap.
This repository contains a Docker Compose file and associated configuration files enabling the deployment of a Matrix-RTC back-end using Traefik as a reverse proxy. Cloning the repository (or copying the contents of the configuration files) onto a qualified server and performing the configuration described below should result in a functional Matrix-RTC back-end deployment.
@ -131,7 +131,7 @@ sed -i 's/example.com/yourdomain.com/g' docker-compose.yaml
Applying any suitable method, generate a secure random string to use as the LiveKit secret. For example:
```
livekit_secret=$(cat /dev/urandom | tr -dc 'a-zA-Z0-9' | fold -w 40 | head -n 1)
livekit_secret=$(tr -dc 'a-zA-Z0-9' < /dev/urandom | head -c 40)
```
Replace the dummy value "insert_livekit_secret" with the value generated above in the `.env` and `data/livekit/config.yaml` config files:
@ -193,7 +193,7 @@ curl -XPOST -d \
#### General
At the time of writing, it is possible to configure a homeserver to use the Matrix-RTC back-end instance provided by Element by setting the `livekit_service_url` parameter in Synapse's `.well-known/matrix/client` configuration file to `https://jwt.call.element.io`. This may be useful for testing and debugging.
At the time of writing, it is possible to configure a homeserver to use the Matrix-RTC 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