From bb2d93e42e4e2ca93054337fa4fdd1e5010d822a Mon Sep 17 00:00:00 2001 From: stratself Date: Thu, 21 May 2026 07:47:05 +0000 Subject: [PATCH] docs(turn,livekit): Add references to example conf files and ref URLs indirectly --- docs/calls/livekit.mdx | 35 +++++++++++++++++++++++++++-------- docs/calls/turn.mdx | 7 ++++++- 2 files changed, 33 insertions(+), 9 deletions(-) diff --git a/docs/calls/livekit.mdx b/docs/calls/livekit.mdx index 9e183e218..480f21613 100644 --- a/docs/calls/livekit.mdx +++ b/docs/calls/livekit.mdx @@ -83,6 +83,10 @@ # replace these with your key-secret pair. Example: # APIUxUnMnSkuFWV: t93ZVjPeoEdyx7Wbet3kG4L3NGZIZVEFvqe0UuiVc22A ``` +Consult [`config-sample.yaml`][config-sample-yaml] for all LiveKit options. + +[livekit-config-sample-yaml]: https://github.com/livekit/livekit/blob/master/config-sample.yaml + #### Firewall hints You will need to allow ports `7881/tcp` and `50100:50200/udp` through your firewall. If you use UFW, the commands are: `ufw allow 7881/tcp` and `ufw allow 50100:50200/udp`. @@ -458,17 +462,32 @@ ## Related Documentation Guides: -- [Element Call self-hosting documentation](https://github.com/element-hq/element-call/blob/livekit/docs/self-hosting.md) -- [Community guide with overview of LiveKit's mechanisms](https://tomfos.tr/matrix/livekit/) -- [Community guide using systemd](https://blog.kimiblock.top/2024/12/24/hosting-element-call/) +- [Element Call self-hosting documentation from element-hq][element-call-selfhosting] +- [Community guide with overview of LiveKit's mechanisms][tom-livekit-guide] +- [Community guide using systemd][kimiblock-livekit-guide] + +[element-call-selfhosting]: https://github.com/element-hq/element-call/blob/livekit/docs/self-hosting.md +[tom-livekit-guide]: https://tomfos.tr/matrix/livekit/ +[kimiblock-livekit-guide]: https://blog.kimiblock.top/2024/12/24/hosting-element-call/ + +Configurations: + +- [Livekit's `config-sample.yaml`][livekit-config-sample-yaml] - LiveKit configuration file with full options Specifications: -- [MSC4143 - MatrixRTC proposal](https://github.com/matrix-org/matrix-spec-proposals/pull/4143) -- [MSC4195 - LiveKit proposal](https://github.com/matrix-org/matrix-spec-proposals/pull/4195) +- [MSC4143 - MatrixRTC proposal][MSC4143] +- [MSC4195 - LiveKit proposal][MSC4195] + +[MSC4143]: https://github.com/matrix-org/matrix-spec-proposals/pull/4143 +[MSC4195]: https://github.com/matrix-org/matrix-spec-proposals/pull/4195 Source code: -- [Element Call](https://github.com/element-hq/element-call) -- [lk-jwt-service](https://github.com/element-hq/lk-jwt-service) -- [LiveKit server](https://github.com/livekit/livekit) +- [Element Call][element-call-github] +- [lk-jwt-service][lk-jwt-service-github] +- [LiveKit server][livekit-server-github] + +[element-call-github]: https://github.com/element-hq/element-call +[lk-jwt-service-github]: https://github.com/element-hq/lk-jwt-service +[livekit-server-github]: https://github.com/livekit/livekit diff --git a/docs/calls/turn.mdx b/docs/calls/turn.mdx index f9e5e65f5..09c6c8b94 100644 --- a/docs/calls/turn.mdx +++ b/docs/calls/turn.mdx @@ -39,6 +39,10 @@ ### 2. Configuration The cert and key must be encoded in PEM format and are readable by the coturn user. +Check out the [`turnserver.conf`][turnserver-conf] example for all coturn options. + +[turnserver-conf]: https://github.com/coturn/coturn/blob/master/examples/etc/turnserver.conf + ### 3. Running the coturn container Next, we will start the Coturn container with the [official image][coturn-image]. **Host networking mode** will be used, as it is better for performance and reduces configuration complexity (see [Coturn Docker docs][coturn-docker-docs] for rationale). @@ -202,8 +206,9 @@ ## Related Documentation - [MatrixRTC/LiveKit Setup](./livekit.mdx) - Configure group calling with LiveKit - [Coturn GitHub][coturn] - Official coturn repository +- [`turnserver.conf`][turnserver-conf] - Coturn TURN SERVER configuration file with full options - [Synapse TURN Guide][synapse-turn-guide] - TURN server guide for Synapse -- [Synapse Coturn Guide][synapse-coturn-guide] - Additional security recommendations +- [Synapse Coturn Guide][synapse-coturn-guide] - Coturn-specific guide for Synapse, with important security recommendations [synapse-turn-guide]: https://element-hq.github.io/synapse/latest/turn-howto.html