docs: Add livekit testing + troubleshooting instructions, and other small changes #1429

Merged
ginger merged 30 commits from stratself/continuwuity:stratself/docs-livekit-fixes into main 2026-03-24 13:20:13 +00:00
Contributor

This pull request adds two new sections for the Livekit page. First, the testing instructions to replicate its token flow against the new /get_token endpoint. Second, the troubleshooting section with commonly-seen issues. It also:

  • Moves Livekit's inbuilt TURN section above the external TURN integration section
  • Advertises both inbuilt + external TURN options in the Calls page
  • Adds a caveat for non-federating deployments (#1440) (now included as part of Troubleshooting section)
  • Smaller fixes:
    • Improves Livekit's related documentations section with organized links
    • Fixes some URLs to match with rest of documentation
    • Add Livekit key:secret pair examples in docs
    • Add matrixrtc room address for further assistance

Pull request checklist:

  • This pull request targets the main branch, and the branch is named something other than
    main.
  • I have written an appropriate pull request title and my description is clear.
  • I understand I am responsible for the contents of this pull request.
  • I have followed the contributing guidelines:
<!-- In order to help reviewers know what your pull request does at a glance, you should ensure that 1. Your PR title is a short, single sentence describing what you changed 2. You have described in more detail what you have changed, why you have changed it, what the intended effect is, and why you think this will be beneficial to the project. If you have made any potentially strange/questionable design choices, but didn't feel they'd benefit from code comments, please don't mention them here - after opening your pull request, go to "files changed", and click on the "+" symbol in the line number gutter, and attach comments to the lines that you think would benefit from some clarification. --> This pull request adds two new sections for the Livekit page. First, the testing instructions to replicate its token flow against the new `/get_token` endpoint. Second, the troubleshooting section with commonly-seen issues. It also: - Moves Livekit's inbuilt TURN section above the external TURN integration section - Advertises both inbuilt + external TURN options in the Calls page - Adds a caveat for non-federating deployments (#1440) (now included as part of Troubleshooting section) - Smaller fixes: - Improves Livekit's related documentations section with organized links - Fixes some URLs to match with rest of documentation - Add Livekit key:secret pair examples in docs - Add matrixrtc room address for further assistance <!-- Example: This pull request allows us to warp through time and space ten times faster than before by double-inverting the warp drive with hyperheated jump fluid, both making the drive faster and more efficient. This resolves the common issue where we have to wait more than 10 milliseconds to engage, use, and disengage the warp drive when travelling between galaxies. --> <!-- Closes: #... --> <!-- Fixes: #... --> <!-- Uncomment the above line(s) if your pull request fixes an issue or closes another pull request by superseding it. Replace `#...` with the issue/pr number, such as `#123`. --> **Pull request checklist:** <!-- You need to complete these before your PR can be considered. If you aren't sure about some, feel free to ask for clarification in #dev:continuwuity.org. --> - [x] This pull request targets the `main` branch, and the branch is named something other than `main`. - [x] I have written an appropriate pull request title and my description is clear. - [x] I understand I am responsible for the contents of this pull request. - I have followed the [contributing guidelines][c1]: - [x] My contribution follows the [code style][c2], if applicable. - [ ] I ran [pre-commit checks][c1pc] before opening/drafting this pull request. - [x] I have [tested my contribution][c1t] (or proof-read it for documentation-only changes) myself, if applicable. This includes ensuring code compiles. - [x] My commit messages follow the [commit message format][c1cm] and are descriptive. - [ ] I have written a [news fragment][n1] for this PR, if applicable<!--(can be done after hitting open!)-->. <!-- Notes on these requirements: - While not required, we encourage you to sign your commits with GPG or SSH to attest the authenticity of your changes. - While we allow LLM-assisted contributions, we do not appreciate contributions that are low quality, which is typical of machine-generated contributions that have not had a lot of love and care from a human. Please do not open a PR if all you have done is asked ChatGPT to tidy up the codebase with a +-100,000 diff. - In the case of code style violations, reviewers may leave review comments/change requests indicating what the ideal change would look like. For example, a reviewer may suggest you lower a log level, or use `match` instead of `if/else` etc. - In the case of code style violations, pre-commit check failures, minor things like typos/spelling errors, and in some cases commit format violations, reviewers may modify your branch directly, typically by making changes and adding a commit. Particularly in the latter case, a reviewer may rebase your commits to squash "spammy" ones (like "fix", "fix", "actually fix"), and reword commit messages that don't satisfy the format. - Pull requests MUST pass the `Checks` CI workflows to be capable of being merged. This can only be bypassed in exceptional circumstances. If your CI flakes, let us know in matrix:r/dev:continuwuity.org. - Pull requests have to be based on the latest `main` commit before being merged. If the main branch changes while you're making your changes, you should make sure you rebase on main before opening a PR. Your branch will be rebased on main before it is merged if it has fallen behind. - We typically only do fast-forward merges, so your entire commit log will be included. Once in main, it's difficult to get out cleanly, so put on your best dress, smile for the cameras! --> [c1]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/CONTRIBUTING.md [c2]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/docs/development/code_style.mdx [c1pc]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/CONTRIBUTING.md#pre-commit-checks [c1t]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/CONTRIBUTING.md#running-tests-locally [c1cm]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/CONTRIBUTING.md#commit-messages [n1]: https://towncrier.readthedocs.io/en/stable/tutorial.html#creating-news-fragments
* separate links into categories in order of importance: guides, specs, source codes
* add short description to included community guides
* add Element Call, lk-jwt-service, and the livekit MSCs too
The purpose is to simplify new deployments, which are more likely
to use Livekit-only calls. This also makes docs flow a bit better
docs: add livekit testing instructions against new /get_token endpoint
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Prek / Pre-commit & Formatting (pull_request) Failing after 15m12s
Checks / Prek / Clippy and Cargo Tests (pull_request) Failing after 20m59s
dece29f19f
ginger requested changes 2026-02-21 16:31:07 +00:00
Dismissed
ginger left a comment

lgtm, just a few copyedits

lgtm, just a few copyedits
@ -262,0 +237,4 @@
To improve LiveKit's reliability, you can configure it to use your coturn server.
Generate a long random secret for LiveKit, and add it to your coturn config under the `static-auth-secret` option. You can add as many secrets as you want - so set a different one for each thing using your TURN server.
Owner

that should probably be a comma, not a hyphen

that should probably be a comma, not a hyphen
stratself marked this conversation as resolved
@ -239,3 +208,1 @@
## LiveKit's built in TURN server
Livekit includes a built in TURN server which can be used in place of an external option. This TURN server will only work with Livekit, so you can't use it for legacy Matrix calling - or anything else.
Livekit includes a built in TURN server which can be used in place of an external option. This TURN server will only work with Livekit, so you can't use it for legacy Matrix calling or anything else.
Owner

inconsistent capitalization of LiveKit

inconsistent capitalization of LiveKit
stratself marked this conversation as resolved
@ -262,0 +239,4 @@
Generate a long random secret for LiveKit, and add it to your coturn config under the `static-auth-secret` option. You can add as many secrets as you want - so set a different one for each thing using your TURN server.
Then configure livekit, making sure to replace `COTURN_SECRET` with the ones you generated:
Owner

inconsistent capitalization of LiveKit

inconsistent capitalization of LiveKit
stratself marked this conversation as resolved
@ -262,0 +261,4 @@
## Testing
To test that Livekit is successfully integrated with Continuwuity, you will need to replicate its [Token Exchange Flow](https://github.com/element-hq/lk-jwt-service?tab=readme-ov-file#%EF%B8%8F-how-it-works--token-exchange-flow). First, request an OpenID token from your Matrix server:
Owner

inconsistent capitalization of LiveKit

inconsistent capitalization of LiveKit
stratself marked this conversation as resolved
@ -262,0 +268,4 @@
https://matrix.example.com/_matrix/client/v3/user/@user:example.com/openid/request_token
```
Your `<session-access-token>` can be found in your client device, or via [this website](https://timedout.uk/mxtoken.html). The step above will respond with an `access_token` for use with the lk-jwt-service.
Owner

s/client device/client's settings

s/client device/client's settings
stratself marked this conversation as resolved
@ -262,0 +303,4 @@
curl -X POST -d @payload.json https://livekit.example.com/get_token
```
The JWT service will respond with a `jwt` token. Use this token to test at the [LiveKit Connection Tester](https://livekit.io/connection-test) - if everything works there, then you have set up Livekit successfully!
Owner

inconsistent capitalization of LiveKit

inconsistent capitalization of LiveKit
stratself marked this conversation as resolved
docs: apply changes from feedback
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Prek / Pre-commit & Formatting (pull_request) Failing after 3m36s
Update flake hashes / update-flake-hashes (pull_request) Successful in 1m11s
Checks / Prek / Clippy and Cargo Tests (pull_request) Failing after 20m0s
5244c55bf9
turn all the things into LiveKit
Author
Contributor

I've applied the corrections

I've applied the corrections
docs: add caveat for deployment with non-federated instances
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Update flake hashes / update-flake-hashes (pull_request) Successful in 1m9s
Checks / Prek / Pre-commit & Formatting (pull_request) Failing after 1m53s
Checks / Prek / Clippy and Cargo Tests (pull_request) Failing after 7m33s
2f1d4ecdbc
Author
Contributor

Added a reference to #1440. Could be removed later

Added a reference to #1440. Could be removed later
stratself force-pushed stratself/docs-livekit-fixes from 2f1d4ecdbc
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Update flake hashes / update-flake-hashes (pull_request) Successful in 1m9s
Checks / Prek / Pre-commit & Formatting (pull_request) Failing after 1m53s
Checks / Prek / Clippy and Cargo Tests (pull_request) Failing after 7m33s
to aa1fcade9d
All checks were successful
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 2m17s
Checks / Prek / Clippy and Cargo Tests (pull_request) Successful in 48m44s
2026-02-24 14:28:44 +00:00
Compare
Henry-Hiles requested changes 2026-03-01 20:07:53 +00:00
Dismissed
@ -241,0 +276,4 @@
```
The JWT service will respond with a `jwt` token. Use this token to test at the [LiveKit Connection Tester](https://livekit.io/connection-test) - if everything works there, then you have set up LiveKit successfully!
<<<<<<< HEAD
Contributor

Uh did you forget to resolve a merge conflict?

Uh did you forget to resolve a merge conflict?
Contributor

Just because this <<<<<<< HEAD I think is not intended.

Just because this `<<<<<<< HEAD` I think is not intended.
stratself marked this conversation as resolved
@ -241,0 +293,4 @@
Guides:
- [Element Call self-hosting documentation](https://github.com/element-hq/element-call/blob/livekit/docs/self-hosting.md)
<<<<<<< HEAD
Contributor

Same here.

Same here.
Author
Contributor

I have resolved the conflicts in a new commit.

I have resolved the conflicts in a new commit.
stratself marked this conversation as resolved
* separate links into categories in order of importance: guides, specs, source codes
* add short description to included community guides
* add Element Call, lk-jwt-service, and the livekit MSCs too
The purpose is to simplify new deployments, which are more likely
to use Livekit-only calls. This also makes docs flow a bit better
docs: add livekit testing instructions against new /get_token endpoint
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Prek / Pre-commit & Formatting (pull_request) Failing after 15m12s
Checks / Prek / Clippy and Cargo Tests (pull_request) Failing after 20m59s
dece29f19f
docs: apply changes from feedback
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Prek / Pre-commit & Formatting (pull_request) Failing after 3m36s
Update flake hashes / update-flake-hashes (pull_request) Successful in 1m11s
Checks / Prek / Clippy and Cargo Tests (pull_request) Failing after 20m0s
5244c55bf9
turn all the things into LiveKit
docs: add caveat for deployment with non-federated instances
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Update flake hashes / update-flake-hashes (pull_request) Successful in 1m9s
Checks / Prek / Pre-commit & Formatting (pull_request) Failing after 1m53s
Checks / Prek / Clippy and Cargo Tests (pull_request) Failing after 7m33s
2f1d4ecdbc
docs(livekit): new troubleshooting section and other small changes
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Prek / Pre-commit & Formatting (pull_request) Has been cancelled
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been cancelled
Update flake hashes / update-flake-hashes (pull_request) Successful in 45s
6f100b73ce
* add link to matrix-rtc room
* include livekit key-secret pair examples for clarity with livekit.yaml
* troubleshooting: add common EC errors and docker networking subsections
* fix a merge conflict issue
stratself changed title from docs: Add livekit testing instructions, prioritize Livekit's inbuilt TURN instructions, and small changes to docs: Add livekit testing + troubleshooting instructions, and other small changes 2026-03-03 19:58:32 +00:00
Henry-Hiles requested changes 2026-03-03 20:06:27 +00:00
Dismissed
@ -25,0 +28,4 @@
~$ docker run --rm livekit/livekit-server:latest generate-keys
API Key: APIUxUnMnSkuFWV
API Secret: t93ZVjPeoEdyx7Wbet3kG4L3NGZIZVEFvqe0UuiVc22A
Contributor

Should there be a newline here?

Should there be a newline here?
Contributor

I'd like to get this newline removed, if it's not intentional, but the rest LGTM now!

I'd like to get this newline removed, if it's not intentional, but the rest LGTM now!
Contributor

This still stands, I think.

This still stands, I think.
Author
Contributor

I see the issue now, fixed

I see the issue now, fixed
stratself marked this conversation as resolved
@ -241,0 +242,4 @@
## Testing
To test that LiveKit is successfully integrated with Continuwuity, you will need to replicate its [Token Exchange Flow](https://github.com/element-hq/lk-jwt-service?tab=readme-ov-file#%EF%B8%8F-how-it-works--token-exchange-flow). First, request an OpenID token from your Matrix server:
Contributor

This one doesn't really matter but you can shorten this a little: https://github.com/element-hq/lk-jwt-service#%EF%B8%8F-how-it-works--token-exchange-flow

This one doesn't really matter but you can shorten this a little: https://github.com/element-hq/lk-jwt-service#%EF%B8%8F-how-it-works--token-exchange-flow
stratself marked this conversation as resolved
@ -241,0 +249,4 @@
https://matrix.example.com/_matrix/client/v3/user/@user:example.com/openid/request_token
```
Your `<session-access-token>` can be found in your client's settings, or via [this website](https://timedout.uk/mxtoken.html). The step above will respond with an `access_token` for use with the lk-jwt-service.
Contributor

Should this maybe be the first step instead? (Fetching an access token)

And then the fetching OpenID can be second step?

Might be more intuitive, when reading this it kind of jumps in order.

Should this maybe be the first step instead? (Fetching an access token) And then the fetching OpenID can be second step? Might be more intuitive, when reading this it kind of jumps in order.
Author
Contributor

You're right, lumping it in this order can be confusing, especially when they're all unhelpfully named access_token

You're right, lumping it in this order can be confusing, especially when they're all unhelpfully named `access_token`
Author
Contributor

I have rewritten the testing steps to be more procedural. If you have time to spend, please kindly check the newly-written Troubleshooting section :)

I have rewritten the testing steps to be more procedural. If you have time to spend, please kindly check the newly-written Troubleshooting section :)
stratself marked this conversation as resolved
fix(docs): apply clarity fixes for livekit testing from feedbacks
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Update flake hashes / update-flake-hashes (pull_request) Successful in 24s
Checks / Prek / Pre-commit & Formatting (pull_request) Failing after 2m12s
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been cancelled
5502e05a59
* clearer wording and ordering on client token versus openid token
* provide outputs for curl examples
fix(docs): little nits for livekit's troubleshooting section
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Update flake hashes / update-flake-hashes (pull_request) Successful in 1m14s
Checks / Prek / Pre-commit & Formatting (pull_request) Failing after 3m7s
Checks / Prek / Clippy and Cargo Tests (pull_request) Successful in 21m5s
f95419ef59
chore: Trim trailing whitespace
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Update flake hashes / update-flake-hashes (pull_request) Successful in 24s
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 1m48s
Checks / Prek / Clippy and Cargo Tests (pull_request) Failing after 6m13s
0e0bd29408
Signed-off-by: Ellis Git <forgejo@mail.ellis.link>
ginger requested changes 2026-03-04 14:34:25 +00:00
Dismissed
@ -241,0 +343,4 @@
- [MatrixRTC proposal](https://github.com/matrix-org/matrix-spec-proposals/pull/4143)
- [LiveKit proposal](https://github.com/matrix-org/matrix-spec-proposals/pull/4195)
Source codes:
Owner

s/codes/code

s/codes/code
stratself marked this conversation as resolved
@ -241,0 +317,4 @@
- Also use `network_mode: host` for `lk-jwt-service`
- (**untested, use as your own risk**) Implement an iptables firewall workaround as shown [here](https://forums.docker.com/t/unable-to-connect-to-host-service-from-inside-docker-container/145749/6).
Owner

s/as/at

s/as/at
stratself marked this conversation as resolved
stratself force-pushed stratself/docs-livekit-fixes from 98a6559c97
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 2m17s
Update flake hashes / update-flake-hashes (pull_request) Successful in 2m34s
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been cancelled
to 7f585a11c6
All checks were successful
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Update flake hashes / update-flake-hashes (pull_request) Successful in 1m41s
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 6m23s
Checks / Prek / Clippy and Cargo Tests (pull_request) Successful in 20m48s
2026-03-05 03:46:42 +00:00
Compare
Henry-Hiles approved these changes 2026-03-05 03:48:18 +00:00
Dismissed
Henry-Hiles left a comment

LGTM

LGTM
Henry-Hiles requested changes 2026-03-06 17:18:37 +00:00
Dismissed
@ -241,0 +308,4 @@
To alleviate this, you can try one of the following workarounds:
- Also use `network_mode: host` for `lk-jwt-service`
Contributor

I don't love this line. The "Also" feels awkward since you weren't talking about it too recently. It's also not particularly descriptive. Could say something more like use network mode host in lk-jwt-service's docker compose or something

I don't love this line. The "Also" feels awkward since you weren't talking about it too recently. It's also not particularly descriptive. Could say something more like use network mode host in lk-jwt-service's docker compose or something
stratself marked this conversation as resolved
stratself force-pushed stratself/docs-livekit-fixes from 22f01e5478
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Update flake hashes / update-flake-hashes (pull_request) Successful in 57s
Checks / Prek / Pre-commit & Formatting (pull_request) Failing after 2m52s
Checks / Prek / Clippy and Cargo Tests (pull_request) Successful in 7m58s
to a8872454a9
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Update flake hashes / update-flake-hashes (pull_request) Successful in 52s
Checks / Prek / Pre-commit & Formatting (pull_request) Failing after 2m54s
Checks / Prek / Clippy and Cargo Tests (pull_request) Successful in 7m29s
2026-03-06 17:30:55 +00:00
Compare
Henry-Hiles approved these changes 2026-03-06 21:38:48 +00:00
Dismissed
Contributor

You'll want to fix the trailing whitespace that prek complains about

You'll want to fix the trailing whitespace that prek complains about
Henry-Hiles approved these changes 2026-03-07 15:06:56 +00:00
Dismissed
ginger approved these changes 2026-03-07 16:37:28 +00:00
Owner

This has merge conflicts with main, although Forgejo isn't showing them for some reason. Once those are resolved this should be good to merge.

This has merge conflicts with main, although Forgejo isn't showing them for some reason. Once those are resolved this should be good to merge.
lveneris requested changes 2026-03-07 17:05:28 +00:00
Dismissed
docs/calls.mdx Outdated
@ -11,3 +11,3 @@
- For legacy calls to work, you need to set up a TURN/STUN server. [Read the TURN guide for tips on how to set up coturn](./calls/turn.mdx)
- For MatrixRTC / Element Call to work, you have to set up the LiveKit backend (foci). LiveKit also uses TURN/STUN to increase reliability, so you might want to configure your TURN server first. [Read the LiveKit guide](./calls/livekit.mdx)
- For MatrixRTC / Element Call to work, you have to set up the LiveKit backend (foci). LiveKit also uses TURN/STUN to increase reliability - you can setup its inbuilt TURN server, or integrate with an existing one. [Read the LiveKit guide](./calls/livekit.mdx)
Contributor

This should read "you can set up its built-in TURN server".

This should read "you can set up its built-in TURN server".
stratself marked this conversation as resolved
@ -96,3 +105,3 @@
Reverse proxies can be configured in many different ways - so we can't provide a step by step for this.
By default, all routes should be forwarded to Livekit with the exception of the following path prefixes, which should be forwarded to the JWT/Authentication service:
By default, all routes should be forwarded to LiveKit with the exception of the following path prefixes, which should be forwarded to the JWT/Authentication service:
Contributor

The clauses here are a little messy. I might suggest something like "All routes should be forwarded to LiveKit by default, except for the following path prefixes, which should be forwarded to the JWT/Authentication service:"

The clauses here are a little messy. I might suggest something like "All routes should be forwarded to LiveKit by default, except for the following path prefixes, which should be forwarded to the JWT/Authentication service:"
stratself marked this conversation as resolved
@ -177,2 +185,3 @@
## Additional TURN configuration
### TURN Integration
### Using LiveKit's built in TURN server
Contributor

Substitute "built-in" for "built in" wherever it appears as a phrasal adjective.

Substitute "built-in" for "built in" wherever it appears as a phrasal adjective.
stratself marked this conversation as resolved
@ -211,3 +189,1 @@
## LiveKit's built in TURN server
Livekit includes a built in TURN server which can be used in place of an external option. This TURN server will only work with Livekit, so you can't use it for legacy Matrix calling - or anything else.
LiveKit includes a built in TURN server which can be used in place of an external option. This TURN server will only work with LiveKit, so you can't use it for legacy Matrix calling or anything else.
Contributor

Maybe "solution" instead of "option"? Incredibly minor nitpick, it just reads strangely.

Maybe "solution" instead of "option"? Incredibly minor nitpick, it just reads strangely.
stratself marked this conversation as resolved
@ -241,0 +221,4 @@
To improve LiveKit's reliability, you can configure it to use your coturn server.
Generate a long random secret for LiveKit, and add it to your coturn config under the `static-auth-secret` option. You can add as many secrets as you want, so set a different one for each thing using your TURN server.
Contributor

Perhaps "service" instead of "thing", depending on how formal you want to be

Perhaps "service" instead of "thing", depending on how formal you want to be
stratself marked this conversation as resolved
@ -241,0 +223,4 @@
Generate a long random secret for LiveKit, and add it to your coturn config under the `static-auth-secret` option. You can add as many secrets as you want, so set a different one for each thing using your TURN server.
Then configure LiveKit, making sure to replace `COTURN_SECRET` with the ones you generated:
Contributor

Substitute "replace" with "replace each instance of"

Substitute "replace" with "replace each instance of"
Author
Contributor

The intent is to use one COTURN_SECRET for all of them. Fixed wording to match that

The intent is to use one `COTURN_SECRET` for all of them. Fixed wording to match that
stratself marked this conversation as resolved
@ -241,0 +333,4 @@
### Workaround for non-federating servers
When deploying on servers with disabled federation (`enable_registration = false`), LiveKit will fail as it can't fetch the required [OpenID endpoint](https://spec.matrix.org/v1.17/server-server-api/#get_matrixfederationv1openiduserinfo) via federation paths. You can find a workaround for this limitation [here](https://forgejo.ellis.link/continuwuation/continuwuity/issues/1440).
Contributor

You mention "disabled federation" and then give enable_registration as your clarification. Is this intentional?

You mention "disabled federation" and then give `enable_registration` as your clarification. Is this intentional?
Author
Contributor

Great catch 🤯. Willfix

Thank you very much for spotting this out

Great catch 🤯. Willfix Thank you very much for spotting this out
Contributor

No worries :) You may also wish to replace it with "non-federated servers" for brevity, or at least "federation disabled"

No worries :) You may also wish to replace it with "non-federated servers" for brevity, or at least "federation disabled"
stratself marked this conversation as resolved
stratself force-pushed stratself/docs-livekit-fixes from 90b019e36b
All checks were successful
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Update flake hashes / update-flake-hashes (pull_request) Successful in 2m26s
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 3m5s
Checks / Prek / Clippy and Cargo Tests (pull_request) Successful in 8m13s
to e22c88ddea
Some checks failed
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 3m17s
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Prek / Clippy and Cargo Tests (pull_request) Failing after 20m49s
2026-03-07 17:20:49 +00:00
Compare
stratself force-pushed stratself/docs-livekit-fixes from 8a6591627e
All checks were successful
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 3m14s
Checks / Prek / Clippy and Cargo Tests (pull_request) Successful in 16m4s
to 44094a9c2e
All checks were successful
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 3m17s
Checks / Prek / Clippy and Cargo Tests (pull_request) Successful in 16m43s
2026-03-08 08:13:41 +00:00
Compare
Author
Contributor

Rebased to latest main to address #1361 being merged, and newsfragment written

Rebased to latest main to address #1361 being merged, and newsfragment written
lveneris left a comment

After these I think this is good to go. Great work.

After these I think this is good to go. Great work.
docs/calls.mdx Outdated
@ -11,3 +11,3 @@
- For legacy calls to work, you need to set up a TURN/STUN server. [Read the TURN guide for tips on how to set up coturn](./calls/turn.mdx)
- For MatrixRTC / Element Call to work, you have to set up the LiveKit backend (foci). LiveKit also uses TURN/STUN to increase reliability, so you might want to configure your TURN server first. [Read the LiveKit guide](./calls/livekit.mdx)
- For MatrixRTC / Element Call to work, you have to set up the LiveKit backend (foci). LiveKit also uses TURN/STUN to increase reliability - you can setup its built-in TURN server, or integrate with an existing one. [Read the LiveKit guide](./calls/livekit.mdx)
Contributor

s/setup/set up/

s/setup/set up/
stratself marked this conversation as resolved
@ -241,0 +333,4 @@
### Workaround for non-federating servers
When deploying on servers with federation disabled (`allow_federation = false`), LiveKit will fail as it can't fetch the required [OpenID endpoint](https://spec.matrix.org/v1.17/server-server-api/#get_matrixfederationv1openiduserinfo) via federation paths. You can find a workaround for this limitation [here](https://forgejo.ellis.link/continuwuation/continuwuity/issues/1440).
Contributor

Not sure how I glossed over this last time, but personally I would prefer you documented the workaround in question here instead of just leaving a link to it. That's up to you, though.

Not sure how I glossed over this last time, but personally I would prefer you documented the workaround in question here instead of just leaving a link to it. That's up to you, though.
Author
Contributor

I have documented the workaround there, and also linked back to the Forgejo issue in case Cloudflare Pages inevitably go down (it will)

I have documented the workaround there, and also linked back to the Forgejo issue in case Cloudflare Pages inevitably go down (it will)
stratself marked this conversation as resolved
lveneris approved these changes 2026-03-08 13:25:57 +00:00
Dismissed
stratself force-pushed stratself/docs-livekit-fixes from 3b14647123
All checks were successful
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 2m57s
Checks / Prek / Clippy and Cargo Tests (pull_request) Successful in 8m26s
to 83a55a70f4
All checks were successful
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 3m1s
Checks / Prek / Clippy and Cargo Tests (pull_request) Successful in 23m8s
2026-03-09 16:46:56 +00:00
Compare
Aranjedeath approved these changes 2026-03-10 02:08:33 +00:00
Dismissed
stratself force-pushed stratself/docs-livekit-fixes from 83a55a70f4
All checks were successful
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 3m1s
Checks / Prek / Clippy and Cargo Tests (pull_request) Successful in 23m8s
to bbe7abcbe2
All checks were successful
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 3m16s
Checks / Prek / Clippy and Cargo Tests (pull_request) Successful in 22m36s
2026-03-16 15:30:48 +00:00
Compare
ginger approved these changes 2026-03-17 13:23:54 +00:00
@ -240,1 +215,3 @@
- [Community guide](https://blog.kimiblock.top/2024/12/24/hosting-element-call/)
### Integration with an external TURN server
If you've already set up coturn, there may be a port clash between the two services. To fix this, make sure coturn's `min-port` and `max-port` do not overlap with LiveKit's range:
Owner

this could be a :::tip

this could be a `:::tip`
Author
Contributor

Done.

Done.
stratself marked this conversation as resolved
docs(livekit): Put livekit+coturn port clash notice in a tip box
All checks were successful
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 3m10s
Update flake hashes / update-flake-hashes (pull_request) Successful in 58s
Checks / Prek / Clippy and Cargo Tests (pull_request) Successful in 9m21s
9a52157d7d
* reworded first part of external TURN integration
* add restart/recreate instructions to apply final TURNs changes
lveneris approved these changes 2026-03-20 12:42:56 +00:00
ginger merged commit ef089c1800 into main 2026-03-24 13:20:13 +00:00
Sign in to join this conversation.
No milestone
No project
No assignees
5 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
continuwuation/continuwuity!1429
No description provided.