feat: Add dynamic client configuration support#3901
Open
ByeongUkChoi wants to merge 1 commit intolivekit:masterfrom
Open
feat: Add dynamic client configuration support#3901ByeongUkChoi wants to merge 1 commit intolivekit:masterfrom
ByeongUkChoi wants to merge 1 commit intolivekit:masterfrom
Conversation
- Add DynamicClientConfigurationManager for server-side client config - Support YAML-based configuration with JavaScript-like match rules - Enable runtime configuration updates without server restart - Maintain full backward compatibility with static configurations - Add comprehensive tests and examples This allows server administrators to configure client behavior based on browser, OS, device model, and other client characteristics without requiring client-side code changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds support for server-side dynamic client configuration in LiveKit Server, enabling administrators to configure client behavior based on client characteristics (browser, OS, device model, etc.) without requiring client-side code changes.
Background
Previously, LiveKit Server only supported static client configurations that were hardcoded in the
StaticConfigurationsvariable. This made it difficult to:Changes
New Features
config.yamlFiles Added
pkg/clientconfiguration/dynamicconfiguration.go- Dynamic configuration managerpkg/clientconfiguration/dynamicconfiguration_test.go- Unit testspkg/service/clientconfigurationservice.go- API service for future useexamples/dynamic_config_example.go- Example usageFiles Modified
pkg/config/config.go- AddedClientConfigurationConfigandClientConfigurationItemstructspkg/service/roommanager.go- Integration withDynamicClientConfigurationManagerconfig-sample.yaml- Added configuration examplesConfiguration Example
Match Rule Expressions
Support JavaScript-like expressions with client fields:
c.browser- Browser name (safari, chrome, firefox)c.browser_version- Browser version stringc.os- Operating system (android, ios, windows, etc.)c.device_model- Device model stringc.sdk- SDK namec.protocol- Protocol versionImplementation Details
Architecture
ClientConfigurationManagerinterfaceBackward Compatibility