docs(calls): Various sweepfixes #2118
No reviewers
Labels
No labels
Abandoned
Blocked
Bug
Changelog
Added
Changelog
Missing
Changelog
None
Cherry-picking
Database
Dependencies
Dependencies/Renovate
Difficulty
Easy
Difficulty
Hard
Difficulty
Medium
Documentation
Enhancement
Good first issue
Help wanted
Inherited
Matrix/Administration
Matrix/Appservices
Matrix/Auth
Matrix/Client
Matrix/Core
Matrix/E2EE
Matrix/Federation
Matrix/Hydra
Matrix/MSC
Matrix/Media
Matrix/T&S
Merge
Merge/Manual
Merge/Squash
Meta
Meta/CI
Meta/Packaging
Priority
Blocking
Priority
High
Priority
Low
Security
Status
Confirmed
Status
Duplicate
Status
Invalid
Status
Needs Investigation
Support
bob the builder
No milestone
No project
No assignees
4 participants
Notifications
Due date
No due date set.
Dependencies
No dependencies set.
Reference
continuwuation/continuwuity!2118
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "stratself/continuwuity:stratself/docs-calls-sweepfixes"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Continuwuation of #1740 and its unaddressed comments
Pull request checklist:
mainbranch, and the branch is named something other thanmain.myself, if applicable. This includes ensuring code compiles.
cc @lveneris for review
@ -441,3 +443,2 @@- [MSC4143 - MatrixRTC proposal][MSC4143]- [MSC4195 - LiveKit proposal][MSC4195]- [MSC4143 - MatrixRTC – Real-time communication over Matrix][MSC4143]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"
@ -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.Prefer "this example uses" or "this example will use"
@ -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,Once again, consistency is important. You must choose one of TURN-over-TLS, TURNS-TLS, TURNS-over-TLS, etc, and stick to it.
@ -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"back from port 443 to the port being configured here"
@ -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.According to their documentation, its name is Caddy-L4.
@ -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.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.
@ -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.@ -226,3 +226,3 @@### TURNS-over-443Normally, 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.Drop the (a.k.a. TURNS) as part of whatever term you standardise around. Rephrase the first sentence of this paragraph.
@ -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**.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".
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.
@ -466,3 +468,3 @@### Additional TURNS-over-443 configurationMost 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.Same here.
@ -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,Same here.
@ -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.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.
@ -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.Same here.
@ -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:Same here.
@ -226,3 +226,3 @@### TURNS-over-443Normally, 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.Same here. Also, if both this and the point made in
livekit.mdxapply to the same conditions (restrictive networks), there should be a unified section for the necessary solutions.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).
f416d61078e7b833556eI'm now using "TURN-over-TLS (on 443)" as the generic convention. https://muc.muoi.me/calls/livekit.html applies
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)">minor nit: i'd prefer "(containerised)" or "(in a container)" (same for "(on host)" -> "(on the host)")
@ -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."docker" -> "Docker"
@ -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."docker" -> "Docker"
@ -191,0 +183,4 @@```</Tab><Tab label="Nginx">"Nginx" -> "nginx"
@ -277,1 +214,4 @@}```Note that for websockets to work, you need to have this somewhere outside your server block: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
@ -366,3 +316,3 @@### Docker loopback networking issuesSome 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.@ -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`):@ -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."inquire" -> "enquire"
@ -241,3 +241,3 @@- Route `livekit.example.com` to the [LiveKit services](./livekit.mdx) with TLS termination by CaddyPlease 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.i feel like i have mentioned this already but "Coturn" -> "coturn" and apply this to all other instances
e7b833556e961093dedei can't think of anything else that needs to be addressed in this PR. good work