docs(calls): Various sweepfixes #2118

Merged
Aranjedeath merged 11 commits from stratself/continuwuity:stratself/docs-calls-sweepfixes into main 2026-08-15 15:08:19 +00:00
Member

Continuwuation of #1740 and its unaddressed comments

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. --> Continuwuation of #1740 and its unaddressed comments <!-- 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. - [x] 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. <!-- 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
docs(livekit,turn): Various sweepfixes from #1740 comments
Some checks failed
Auto Labeler / Apply labels based on changed files (pull_request_target) Successful in 3s
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 6s
Checks / Prek / Check changed files (pull_request) Successful in 6s
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been skipped
Checks / Prek / Pre-commit & Formatting (pull_request) Failing after 1m7s
27f8ef5b64
Author
Member

cc @lveneris for review

cc @lveneris for review
lveneris requested changes 2026-08-08 08:49:03 +00:00
Dismissed
@ -441,3 +443,2 @@
- [MSC4143 - MatrixRTC proposal][MSC4143]
- [MSC4195 - LiveKit proposal][MSC4195]
- [MSC4143 - MatrixRTC Real-time communication over Matrix][MSC4143]
Member

You should escape the hyphen here, as noted by Forgejo. I would advise doing this in general, as well. Also, typical style is "MSCXXXX: Example Title"

You should escape the hyphen here, as noted by Forgejo. I would advise doing this in general, as well. Also, typical style is "MSCXXXX: Example Title"
stratself marked this conversation as resolved
@ -476,3 +478,3 @@
<summary>Using LiveKit's built-in TURN server</summary>
First, set up LiveKit's built-in TURN server with its own domain - we'll use `livekit-turn.example.com` in our example.
First, set up LiveKit's built-in TURN server with its own domain - we will use `livekit-turn.example.com` in our example.
Member

Prefer "this example uses" or "this example will use"

Prefer "this example uses" or "this example will use"
stratself marked this conversation as resolved
@ -483,3 +485,3 @@
enabled: true
# note: the TLS port will always be advertised as :443
# Note: LiveKit will always advertise its TURNS-TLS port on 443,
Member

Once again, consistency is important. You must choose one of TURN-over-TLS, TURNS-TLS, TURNS-over-TLS, etc, and stick to it.

Once again, consistency is important. You **must** choose one of TURN-over-TLS, TURNS-TLS, TURNS-over-TLS, etc, and stick to it.
stratself marked this conversation as resolved
@ -484,2 +486,3 @@
# note: the TLS port will always be advertised as :443
# Note: LiveKit will always advertise its TURNS-TLS port on 443,
# so further load balancing is needed to route from 443 back to
Member

"back from port 443 to the port being configured here"

"back from port 443 to the port being configured here"
stratself marked this conversation as resolved
@ -510,3 +514,3 @@
Recreate the LiveKit container (with `docker compose up -d livekit`) to apply these changes. Remember to allow the new `50300:50400/udp` ports through your firewall.
Then, we will configure a route from port 443 of the host back to our `livekit-turn.example.com` service on port 5349. To both **multiplex** this and LiveKit's websocket on the same port, we will use a layer-4 reverse proxy with **SNI routing** capabilities, such as [caddy-l4][caddy-l4] on the host system.
Then, configure a route from port 443 on the host back to the `livekit-turn.example.com` service on port 5349. To multiplex the service and LiveKit's websocket on the same port, use a layer 4 reverse proxy with SNI routing capabilities, such as [caddy-l4], on the host system.
Member

According to their documentation, its name is Caddy-L4.

According to [their documentation](https://github.com/mholt/caddy-l4/blob/master/docs%2FREADME.md), its name is Caddy-L4.
stratself marked this conversation as resolved
@ -557,3 +561,3 @@
```
Then, 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 LiveKit to use.
Then, generate a long random TURN 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 LiveKit to use.
Member

The last sentence here is still unclear, I would say. Try something like "The configuration allows multiple secrets, so generate a unique one for LiveKit to use" if that is the intended meaning. Otherwise, I am unsure.

The last sentence here is still unclear, I would say. Try something like "The configuration allows multiple secrets, so generate a unique one for LiveKit to use" if that is the intended meaning. Otherwise, I am unsure.
stratself marked this conversation as resolved
@ -578,3 +582,3 @@
</details>
After finishing configuration, you can run the Testing steps again to check that TURN-over-TLS is working. In the LiveKit connection test page, there should be a green tick saying "Can connect to TURN".
After you finish configuring the services, you can run the Testing steps again to check that TURNS-over-443 is working. There should now be a green tick in the [LiveKit connection test page][livekit-connection-test] with "Can connect to TURN" to confirm this is set up successfully.
Member
Once the services are configured, run the Testing steps again to check that TURNS-over-443 is working. There should now be a green tick in the [LiveKit connection test page][livekit-connection-test] showing "Can connect to TURN" to confirm this is set up successfully.
``` Once the services are configured, run the Testing steps again to check that TURNS-over-443 is working. There should now be a green tick in the [LiveKit connection test page][livekit-connection-test] showing "Can connect to TURN" to confirm this is set up successfully. ```
stratself marked this conversation as resolved
@ -226,3 +226,3 @@
### TURNS-over-443
Normally, TURN would work on their default setups. However, there are situations where clients are in very restrictive networks that disallows non-standard ports and UDP. In these cases, a TURN-over-TLS server on port :443 could be employed to relay traffic for them.
Normally, TURN would work on their default setups. However, there are situations where clients may be unable to use nonstandard ports or UDP connections, such as in highly restrictive networks. In such cases, a TURN-over-TLS (a.k.a. TURNS) server on port 443 could relay traffic for the clients.
Member

Drop the (a.k.a. TURNS) as part of whatever term you standardise around. Rephrase the first sentence of this paragraph.

Drop the (a.k.a. TURNS) as part of whatever term you standardise around. Rephrase the first sentence of this paragraph.
stratself marked this conversation as resolved
@ -229,2 +228,3 @@
Normally, TURN would work on their default setups. However, there are situations where clients may be unable to use nonstandard ports or UDP connections, such as in highly restrictive networks. In such cases, a TURN-over-TLS (a.k.a. TURNS) server on port 443 could relay traffic for the clients.
However, port 443 is usually utilized by other HTTPS services. Therefore, one would need to **multiplex** both TURN HTTPS on these ports, and filter packets to them via **SNI routing**.
However, port 443 is usually utilized by other HTTPS services. Therefore, one would need to **multiplex** both TURNS and HTTPS on these ports, and filter packets to them via **SNI routing**.
Member

Replace "utilized" with "used". I'm also not sure why multiplex and SNI routing are bold; random terms in bold feel similar to "scare quotes".

Replace "utilized" with "used". I'm also not sure why **multiplex** and **SNI routing** are bold; random terms in bold feel similar to "scare quotes".
stratself marked this conversation as resolved
Owner

I won't close this PR for it since it's just docs, but next time please either open separate PRs or at least make multiple distinct commits. Monolithic, broad PRs like this one are non-trivial to review and take up a lot more time than a properly scoped PR.

I won't close this PR for it since it's just docs, but next time please either open separate PRs or at least make multiple distinct commits. Monolithic, broad PRs like this one are non-trivial to review and take up a lot more time than a properly scoped PR.
fix(docs): Use official "Caddy-L4" name
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 7s
Checks / Prek / Check changed files (pull_request) Successful in 6s
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been skipped
Checks / Prek / Pre-commit & Formatting (pull_request) Failing after 1m8s
5d36959b7e
fix: Trailing whitespaces
All checks were successful
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 7s
Checks / Prek / Check changed files (pull_request) Successful in 6s
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been skipped
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 1m12s
bf347368c8
lveneris requested changes 2026-08-09 11:07:05 +00:00
Dismissed
@ -466,3 +468,3 @@
### Additional TURNS-over-443 configuration
Most of the time, LiveKit [**does not need TURN**][sspaeth-matrix-voip-turn] to function. However, there are situations where clients are in very restrictive networks that disallows non-standard ports and UDP. In these cases, a TURN-over-TLS server on port :443 could be employed to relay traffic for them.
Most of the time, LiveKit [**does not need TURN**][sspaeth-matrix-voip-turn] to function. However, there are situations where clients may be unable to use nonstandard ports or UDP connections, such as in highly restrictive networks. In such cases, a TURN-over-TLS server on port 443 could relay traffic for the clients.
Member

Same here.

Same here.
stratself marked this conversation as resolved
@ -483,3 +485,3 @@
enabled: true
# note: the TLS port will always be advertised as :443
# Note: LiveKit will always advertise its TURN-over-TLS port on 443,
Member

Same here.

Same here.
stratself marked this conversation as resolved
@ -560,2 +563,3 @@
Then, generate a long random TURN secret for LiveKit, and add it to your coturn config under the `static-auth-secret` option. coturn allows multiple secrets in its configuration, so set a different one for LiveKit to use.
After that, refer to the following [**TURN instructions**](./turn#turns-over-443) to set up coturn with TLS, as well as multiplexing with LiveKit's websocket on port 443.
After that, refer to the following [TURNS-over-443 instructions](./turn#turns-over-443) to set up coturn with TLS, as well as multiplexing with LiveKit's websocket on port 443.
Member

My comment about choosing a standard term is clearly unresolved. You mention TURN-over-TLS earlier, and call it TURNS-over-443 here. I will now highlight everywhere this concept is referred to, so that you can apply a uniform solution.

My comment about choosing a standard term is clearly unresolved. You mention TURN-over-TLS earlier, and call it TURNS-over-443 here. I will now highlight everywhere this concept is referred to, so that you can apply a uniform solution.
stratself marked this conversation as resolved
@ -578,3 +582,3 @@
</details>
After finishing configuration, you can run the Testing steps again to check that TURN-over-TLS is working. In the LiveKit connection test page, there should be a green tick saying "Can connect to TURN".
Once the services are configured, run the Testing steps again to check that TURNS-over-443 is working. There should now be a green tick in the [LiveKit connection test page][livekit-connection-test] showing "Can connect to TURN" to confirm this is set up successfully.
Member

Same here.

Same here.
stratself marked this conversation as resolved
@ -35,3 +35,3 @@
:::
If you want to enable TURN-over-TLS (TURNS), add the appropriate cert/key paths to your `coturn.conf` by adding the following lines:
If you want to enable TURN-over-TLS (TURNS), add the appropriate certificate and key paths to your `coturn.conf` by adding the following lines:
Member

Same here.

Same here.
stratself marked this conversation as resolved
@ -226,3 +226,3 @@
### TURNS-over-443
Normally, TURN would work on their default setups. However, there are situations where clients are in very restrictive networks that disallows non-standard ports and UDP. In these cases, a TURN-over-TLS server on port :443 could be employed to relay traffic for them.
TURN servers are generally reachable on their default ports, as configured above. However, there are situations where clients may be unable to use nonstandard ports or UDP connections, such as in highly restrictive networks. In such cases, a TURN-over-TLS server on port 443 could relay traffic for the clients.
Member

Same here. Also, if both this and the point made in livekit.mdx apply to the same conditions (restrictive networks), there should be a unified section for the necessary solutions.

Same here. Also, if both this and the point made in `livekit.mdx` apply to the same conditions (restrictive networks), there should be a unified section for the necessary solutions.
Author
Member

They are in separate pages so LiveKit people don't need to click on the other one (they are already nudged to use the embedded TURN anyways).

They are in separate pages so LiveKit people don't need to click on the other one (they are already nudged to use the embedded TURN anyways).
stratself marked this conversation as resolved
As lk-jwt-service is hosted in a bridge network, the previous
`extra_hosts` using 127.0.0.1 would just loop back to the container
itself. Using `network_mode: host` is unnecessary, and the
`host-gateway` approach works well for both Podman and Docker

Host loopback issues are prevalent in non-Livekit scenarios too: push
gateways is another example. Considering moving these to a dedicated
Docker section of the troubleshooting page.
chore: Add changelog for Livekit Docker loopback changes
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 6s
Checks / Prek / Check changed files (pull_request) Successful in 6s
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been skipped
Checks / Prek / Pre-commit & Formatting (pull_request) Failing after 1m6s
f416d61078
stratself force-pushed stratself/docs-calls-sweepfixes from f416d61078
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 6s
Checks / Prek / Check changed files (pull_request) Successful in 6s
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been skipped
Checks / Prek / Pre-commit & Formatting (pull_request) Failing after 1m6s
to e7b833556e
All checks were successful
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 7s
Checks / Prek / Check changed files (pull_request) Successful in 6s
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 1m12s
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been skipped
Update flake hashes / update-flake-hashes (pull_request) Successful in 1m24s
2026-08-11 08:10:06 +00:00
Compare
Author
Member

I'm now using "TURN-over-TLS (on 443)" as the generic convention. https://muc.muoi.me/calls/livekit.html applies

I'm now using "TURN-over-TLS (on 443)" as the generic convention. https://muc.muoi.me/calls/livekit.html applies
lveneris requested changes 2026-08-14 14:21:28 +00:00
Dismissed
lveneris left a comment

getting closer :)

getting closer :)
@ -149,2 +149,2 @@
- Put these containers on the same bridge network as caddy (by defining `networks: [ caddy ]` in each of the services), and
- Use appropriate container hostnames (`lk-jwt-service` and `livekit`) instead of `127.0.0.1` in the Caddyfile
</Tab>
<Tab label="Caddy (in container)">
Member

minor nit: i'd prefer "(containerised)" or "(in a container)" (same for "(on host)" -> "(on the host)")

minor nit: i'd prefer "(containerised)" or "(in a container)" (same for "(on host)" -> "(on the host)")
stratself marked this conversation as resolved
@ -151,2 +150,3 @@
<Tab label="Caddy (in container)">
</details>
Requires `livekit` and `lk-jwt-service` to be on the same docker bridge network as Caddy.
Member

"docker" -> "Docker"

"docker" -> "Docker"
stratself marked this conversation as resolved
@ -191,0 +173,4 @@
</Tab>
<Tab label="Traefik (via Docker labels)">
Requires `livekit` and `lk-jwt-service` to be on the same docker bridge network as Traefik.
Member

"docker" -> "Docker"

"docker" -> "Docker"
stratself marked this conversation as resolved
@ -191,0 +183,4 @@
```
</Tab>
<Tab label="Nginx">
Member

"Nginx" -> "nginx"

"Nginx" -> "nginx"
stratself marked this conversation as resolved
@ -277,1 +214,4 @@
}
```
Note that for websockets to work, you need to have this somewhere outside your server block:
Member

this is nondescript. what does it mean by "work" in this case? reformulate as "Include the following outside of the server block to [...]" and substitute in what this actually does for the setup

this is nondescript. what does it mean by "work" in this case? reformulate as "Include the following outside of the server block to [...]" and substitute in what this actually does for the setup
stratself marked this conversation as resolved
@ -366,3 +316,3 @@
### Docker loopback networking issues
Some distros do not allow Docker containers to connect to its host's public IP by default. This would cause `lk-jwt-service` to fail connecting to `livekit` or `continuwuity` on the same host. As a result, you would see connection refused/connection timeouts log entries in the JWT service, even when `LIVEKIT_URL` has been configured correctly.
Some distros do not allow Docker containers in bridge networks to connect to its host's public IP by default. This would cause `lk-jwt-service` to fail connecting to `livekit` or `continuwuity` on the same host. As a result, you would see connection refused/connection timeouts log entries in the JWT service, even when `LIVEKIT_URL` has been configured correctly.
Member
Some distros do not allow Docker containers in bridge networks to connect to their host's public IP by default. This makes `lk-jwt-service` fail connecting to `livekit` or `continuwuity` on the same host, causing refused and timed out connections to appear in the log entries of the JWT service, even when `LIVEKIT_URL` has been configured correctly.
``` Some distros do not allow Docker containers in bridge networks to connect to their host's public IP by default. This makes `lk-jwt-service` fail connecting to `livekit` or `continuwuity` on the same host, causing refused and timed out connections to appear in the log entries of the JWT service, even when `LIVEKIT_URL` has been configured correctly. ```
stratself marked this conversation as resolved
@ -375,3 +325,3 @@
```
To alleviate this, you can try one of the following workarounds:
To resolve this, we can configure an `extra_hosts` file mapping LiveKit's (and Continuwuity's) domain name to Docker's custom host loopback address (represented by `host-gateway`):
Member
To resolve this, configure an `extra_hosts` file mapping LiveKit's and Continuwuity's domain names to Docker's custom host loopback address, represented here by `host-gateway`:
``` To resolve this, configure an `extra_hosts` file mapping LiveKit's and Continuwuity's domain names to Docker's custom host loopback address, represented here by `host-gateway`: ```
stratself marked this conversation as resolved
@ -394,3 +338,4 @@
After implementing the changes and restarting your compose, `lk-jwt-service` should now connect to your other services. The sidecar container test above should now return an `OK` from LiveKit.
For more information about the `host-gateway` parameter, kindly refer to the `--add-host` documentation for [Docker][docker-add-host] and [Podman][podman-add-host]. Should you have further difficulties, feel free to inquire in the support rooms.
Member

"inquire" -> "enquire"

"inquire" -> "enquire"
stratself marked this conversation as resolved
@ -241,3 +241,3 @@
- Route `livekit.example.com` to the [LiveKit services](./livekit.mdx) with TLS termination by Caddy
Please note that all traffic from Coturn's perspective will be coming from caddy-l4's IP now.
Please note that all traffic from Coturn's perspective will be coming from Caddy-L4's IP now.
Member

i feel like i have mentioned this already but "Coturn" -> "coturn" and apply this to all other instances

i feel like i have mentioned this already but "Coturn" -> "coturn" and apply this to all other instances
stratself marked this conversation as resolved
stratself force-pushed stratself/docs-calls-sweepfixes from e7b833556e
All checks were successful
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 7s
Checks / Prek / Check changed files (pull_request) Successful in 6s
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 1m12s
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been skipped
Update flake hashes / update-flake-hashes (pull_request) Successful in 1m24s
to 961093dede
All checks were successful
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 8s
Checks / Prek / Check changed files (pull_request) Successful in 6s
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 1m12s
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been skipped
Update flake hashes / update-flake-hashes (pull_request) Successful in 1m21s
2026-08-14 19:30:47 +00:00
Compare
lveneris approved these changes 2026-08-14 19:41:32 +00:00
lveneris left a comment

i can't think of anything else that needs to be addressed in this PR. good work

i can't think of anything else that needs to be addressed in this PR. good work
Sign in to join this conversation.
No reviewers
No milestone
No project
No assignees
4 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!2118
No description provided.