Add config option for livekit #1356

Merged
ginger merged 3 commits from magikid/continuwuity:cjones/push-sp into main 2026-02-13 19:52:40 +00:00
Contributor

This adds a new config option under global.well_known for livekit
server URLs. It also updates the well_known client API endpoint to
return this list.

Closes #1355

This pull request...

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:
This adds a new config option under `global.well_known` for livekit server URLs. It also updates the well_known client API endpoint to return this list. Closes #1355 <!-- 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... <!-- 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. - [x] 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
Add config option for livekit
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been cancelled
Checks / Prek / Pre-commit & Formatting (pull_request) Has been cancelled
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been cancelled
ad105b520b
This adds a new config option under `global.well_known` for livekit
server URLs.  It also updates the well_known client API endpoint to
return this list.

Closes #1355
magikid force-pushed cjones/push-sp from ad105b520b
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been cancelled
Checks / Prek / Pre-commit & Formatting (pull_request) Has been cancelled
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been cancelled
to f255f9f4dd
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been cancelled
Checks / Prek / Pre-commit & Formatting (pull_request) Has been cancelled
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been cancelled
2026-02-12 04:41:56 +00:00
Compare
Author
Contributor

I actually think this might be blocked by the version of ruma we're running.

I actually think this might be blocked by the version of ruma we're running.
magikid force-pushed cjones/push-sp from f255f9f4dd
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been cancelled
Checks / Prek / Pre-commit & Formatting (pull_request) Has been cancelled
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been cancelled
to bb570727e1
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been cancelled
Checks / Prek / Pre-commit & Formatting (pull_request) Has been cancelled
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been cancelled
2026-02-12 04:59:39 +00:00
Compare
magikid force-pushed cjones/push-sp from bb570727e1
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been cancelled
Checks / Prek / Pre-commit & Formatting (pull_request) Has been cancelled
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been cancelled
to cb81f691f7
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been cancelled
Checks / Prek / Pre-commit & Formatting (pull_request) Has been cancelled
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been cancelled
2026-02-12 05:03:47 +00:00
Compare
Owner

If necessary you can make a PR to continuation/ruwuma and change the commit hash used by the repo

If necessary you can make a PR to continuation/ruwuma and change the commit hash used by the repo
@ -2112,2 +2112,4 @@
/// listed.
pub support_mxid: Option<OwnedUserId>,
/// A list of URL to live kit servers which will be served as part of the
Owner

Nit: these are URLs to an authentication service rather than LiveKit itself (I say this because we might get the authentication service built in in future)

Nit: these are URLs to an authentication service rather than LiveKit itself (I say this because we might get the authentication service built in in future)
Author
Contributor

I was mainly keeping this in line with what I had seen elsewhere in documentation. Most of what I have seen says this is the livekit server URL. If I were going to change it, do you have a recommendation?

I was mainly keeping this in line with what I had seen elsewhere in documentation. Most of what I have seen says this is the livekit server URL. If I were going to change it, do you have a recommendation?
Owner

something like a list of URLs MatrixRTC Authorization Service bridges to LiveKit would be correct in this case. If you get the other config working it would be a list of MatrixRTC foci URLs though

something like `a list of URLs MatrixRTC Authorization Service bridges to LiveKit` would be correct in this case. If you get the other config working it would be `a list of MatrixRTC foci URLs` though
Author
Contributor

Done. I changed it to:

	/// A list of MatrixRTC foci URLs which will be served as part of the
	/// MSC4143 client endpoint at /.well-known/matrix/client.  If you're
Done. I changed it to: ``` /// A list of MatrixRTC foci URLs which will be served as part of the /// MSC4143 client endpoint at /.well-known/matrix/client. If you're ```
@ -2114,0 +2118,4 @@
///
/// Defaults to: []
#[serde(default = "default_livekit_urls")]
pub livekit_urls: Vec<Url>,
Owner

Can we make this so the user can select what kind of foci they use? In theory the spec allows multiple kinds, even though livekit is the only currently-extant one.

Can we make this so the user can select what kind of foci they use? In theory the spec allows multiple kinds, even though livekit is the only currently-extant one.
Author
Contributor

Not while still using the ‘Response’ object for the API:

(From Ruma)

#[non_exhaustive]pub struct Response {
    pub homeserver: HomeserverInfo,
    pub identity_server: Option<IdentityServerInfo>,
    pub tile_server: Option<TileServerInfo>,
    pub rtc_foci: Vec<RtcFocusInfo>,
}

And so far they only define a LiveKit(LiveKitRtcFocusInfo) livekit version

Not while still using the ‘Response’ object for the API: (From Ruma) ``` #[non_exhaustive]pub struct Response { pub homeserver: HomeserverInfo, pub identity_server: Option<IdentityServerInfo>, pub tile_server: Option<TileServerInfo>, pub rtc_foci: Vec<RtcFocusInfo>, } ``` And so far they only define a `LiveKit(LiveKitRtcFocusInfo)` livekit version
Owner

They specify _Custom(CustomRtcFocusInfo), and the type implements Deserialize - so if you use the RtcFocusInfo type in the config, it should allow specifying it in the same manner as the actual served JSON

They specify _Custom(CustomRtcFocusInfo), and the type implements Deserialize - so if you use the `RtcFocusInfo` type in the config, it *should* allow specifying it in the same manner as the actual served JSON
Owner

I'm not too fussed about this if you can't get it working

I'm not too fussed about this if you can't get it working
Author
Contributor

It was exactly as easy as it sounded. The config below now works.

[global.well_known]
rtc_focus_server_urls = [
    { type = "livekit", server_url = "https://livekit.example.com" },
]

API response

{"m.homeserver":{"base_url":"https://matrix.example.com/"},"org.matrix.msc3575.proxy":{"url":"https://matrix.example.com/"},"org.matrix.msc4143.rtc_foci":[{"type":"livekit","server_url":"https://livekit.example.com"}]}
It was exactly as easy as it sounded. The config below now works. ``` [global.well_known] rtc_focus_server_urls = [ { type = "livekit", server_url = "https://livekit.example.com" }, ] ``` API response ``` {"m.homeserver":{"base_url":"https://matrix.example.com/"},"org.matrix.msc3575.proxy":{"url":"https://matrix.example.com/"},"org.matrix.msc4143.rtc_foci":[{"type":"livekit","server_url":"https://livekit.example.com"}]} ```
Author
Contributor

I think this is all done now too.

I think this is all done now too.
Owner

If you have any questions font forget you can ask in #dev

If you have any questions font forget you can ask in [#dev](https://matrix.to/#/%23dev:continuwuity.org)
First-time contributor

Wouldn't a "type": "livekit" field be needed too?

Wouldn't a `"type": "livekit"` field be needed too?
Author
Contributor

Depends on continuwuation/ruwuma#47 being merged in

Depends on https://forgejo.ellis.link/continuwuation/ruwuma/pulls/47 being merged in
magikid force-pushed cjones/push-sp from cb81f691f7
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been cancelled
Checks / Prek / Pre-commit & Formatting (pull_request) Has been cancelled
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been cancelled
to dbd41ed1a2
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been cancelled
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) Has been cancelled
2026-02-12 15:33:04 +00:00
Compare
magikid changed title from WIP: Add config option for livekit to Add config option for livekit 2026-02-12 15:34:21 +00:00
magikid force-pushed cjones/push-sp from dbd41ed1a2
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been cancelled
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) Has been cancelled
to db10c30d1f
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been cancelled
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) Has been cancelled
2026-02-12 17:09:50 +00:00
Compare
magikid changed title from Add config option for livekit to WIP: Add config option for livekit 2026-02-12 17:47:16 +00:00
magikid force-pushed cjones/push-sp from db10c30d1f
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been cancelled
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) Has been cancelled
to bd504108b7
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been cancelled
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) Has been cancelled
2026-02-12 18:06:46 +00:00
Compare
Author
Contributor

Okay, finally able to test it and with the config:

[global]
server_name = "example.com"
db_path = "db"
[global.well_known]
client = "https://matrix.example.com"
server = "matrix.example.com:443"
livekit_server_urls = ["https://livekit.example.com"]

It produces:

{"m.homeserver":{"base_url":"https://matrix.example.com/"},"org.matrix.msc3575.proxy":{"url":"https://matrix.example.com/"},"org.matrix.msc4143.rtc_foci":[{"type":"livekit","livekit_service_url":"https://livekit.example.com/"}]}
Okay, finally able to test it and with the config: ``` [global] server_name = "example.com" db_path = "db" [global.well_known] client = "https://matrix.example.com" server = "matrix.example.com:443" livekit_server_urls = ["https://livekit.example.com"] ``` It produces: ``` {"m.homeserver":{"base_url":"https://matrix.example.com/"},"org.matrix.msc3575.proxy":{"url":"https://matrix.example.com/"},"org.matrix.msc4143.rtc_foci":[{"type":"livekit","livekit_service_url":"https://livekit.example.com/"}]} ```
magikid changed title from WIP: Add config option for livekit to Add config option for livekit 2026-02-12 18:09:12 +00:00
magikid force-pushed cjones/push-sp from bd504108b7
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been cancelled
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) Has been cancelled
to 3960dbf404
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been cancelled
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) Has been cancelled
2026-02-12 20:28:13 +00:00
Compare
magikid force-pushed cjones/push-sp from 3960dbf404
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been cancelled
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) Has been cancelled
to b24e03e694
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been cancelled
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) Has been cancelled
2026-02-12 20:45:10 +00:00
Compare
magikid force-pushed cjones/push-sp from b24e03e694
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been cancelled
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) Has been cancelled
to bd7d295f45
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been cancelled
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) Has been cancelled
2026-02-12 20:46:48 +00:00
Compare
Author
Contributor

@Jade This is ready for another review

@Jade This is ready for another review
nex added this to the 0.5.5 milestone 2026-02-12 21:56:52 +00:00
docs: Correct comment on rtc_focus_server_urls
All checks were successful
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Update flake hashes / update-flake-hashes (pull_request) Successful in 23s
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 2m16s
Checks / Prek / Clippy and Cargo Tests (pull_request) Successful in 38m45s
a30f1f1038
Jade requested review from Jade 2026-02-12 22:45:00 +00:00
Jade approved these changes 2026-02-12 22:45:05 +00:00
ginger merged commit 89ad809270 into main 2026-02-13 19:52:40 +00:00
Sign in to join this conversation.
No reviewers
No milestone
No project
No assignees
3 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!1356
No description provided.