Created
December 10, 2023 12:13
-
-
Save niqzart/5adb9eb5bc47c96921ebd719dbaee7ab to your computer and use it in GitHub Desktop.
LiveKit help-verbose output
This file contains 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
| NAME: | |
| livekit-server - High performance WebRTC server | |
| USAGE: | |
| livekit-server [global options] command [command options] [arguments...] | |
| VERSION: | |
| 1.4.5 | |
| DESCRIPTION: | |
| run without subcommands to start the server | |
| COMMANDS: | |
| generate-keys generates an API key and secret pair | |
| ports print ports that server is configured to use | |
| list-nodes list all nodes | |
| help-verbose prints app help, including all generated configuration flags | |
| help, h Shows a list of commands or help for one command | |
| GLOBAL OPTIONS: | |
| --bind value [ --bind value ] IP address to listen on, use flag multiple times to specify multiple addresses | |
| --config value path to LiveKit config file | |
| --config-body value LiveKit config in YAML, typically passed in as an environment var in a container [$LIVEKIT_CONFIG] | |
| --key-file value path to file that contains API keys/secrets | |
| --keys value api keys (key: secret\n) [$LIVEKIT_KEYS] | |
| --region value region of the current node. Used by regionaware node selector [$LIVEKIT_REGION] | |
| --node-ip value IP address of the current node, used to advertise to clients. Automatically determined by default [$NODE_IP] | |
| --udp-port value Single UDP port to use for WebRTC traffic (default: 0) [$UDP_PORT] | |
| --redis-host value host (incl. port) to redis server [$REDIS_HOST] | |
| --redis-password value password to redis [$REDIS_PASSWORD] | |
| --turn-cert value tls cert file for TURN server [$LIVEKIT_TURN_CERT] | |
| --turn-key value tls key file for TURN server [$LIVEKIT_TURN_KEY] | |
| --memprofile file write memory profile to file | |
| --dev sets log-level to debug, console formatter, and /debug/pprof. insecure for production (default: false) | |
| --port value generated (default: 0) [$LIVEKIT_PORT] | |
| --redis.username value generated [$LIVEKIT_REDIS_USERNAME] | |
| --audio.active_red_encoding generated (default: false) | |
| --rtc.congestion_control.channel_observer_non_probe_config.estimate_downward_trend_max_wait value generated (default: 0) [$LIVEKIT_RTC_CONGESTION_CONTROL_CHANNEL_OBSERVER_NON_PROBE_CONFIG_ESTIMATE_DOWNWARD_TREND_MAX_WAIT] | |
| --limit.num_tracks value generated (default: 0) [$LIVEKIT_LIMIT_NUM_TRACKS] | |
| --rtc.pli_throttle.low_quality value generated (default: 0) [$LIVEKIT_RTC_PLI_THROTTLE_LOW_QUALITY] | |
| --rtc.congestion_control.channel_observer_probe_config.nack_ratio_threshold value generated (default: 0) [$LIVEKIT_RTC_CONGESTION_CONTROL_CHANNEL_OBSERVER_PROBE_CONFIG_NACK_RATIO_THRESHOLD] | |
| --rtc.congestion_control.channel_observer_non_probe_config.estimate_required_samples value generated (default: 0) [$LIVEKIT_RTC_CONGESTION_CONTROL_CHANNEL_OBSERVER_NON_PROBE_CONFIG_ESTIMATE_REQUIRED_SAMPLES] | |
| --logging.json generated (default: false) | |
| --prometheus_port value generated (default: 0) [$LIVEKIT_PROMETHEUS_PORT] | |
| --redis.use_tls generated (default: false) | |
| --redis.read_timeout value generated (default: 0) [$LIVEKIT_REDIS_READ_TIMEOUT] | |
| --turn.domain value generated [$LIVEKIT_TURN_DOMAIN] | |
| --turn.cert_file value generated [$LIVEKIT_TURN_CERT_FILE] | |
| --node_selector.sysload_limit value generated (default: 0) [$LIVEKIT_NODE_SELECTOR_SYSLOAD_LIMIT] | |
| --rtc.congestion_control.channel_observer_probe_config.estimate_required_samples_min value generated (default: 0) [$LIVEKIT_RTC_CONGESTION_CONTROL_CHANNEL_OBSERVER_PROBE_CONFIG_ESTIMATE_REQUIRED_SAMPLES_MIN] | |
| --rtc.congestion_control.channel_observer_probe_config.estimate_downward_trend_threshold value generated (default: 0) [$LIVEKIT_RTC_CONGESTION_CONTROL_CHANNEL_OBSERVER_PROBE_CONFIG_ESTIMATE_DOWNWARD_TREND_THRESHOLD] | |
| --turn.enabled generated (default: false) | |
| --signal_relay.stream_buffer_size value generated (default: 0) [$LIVEKIT_SIGNAL_RELAY_STREAM_BUFFER_SIZE] | |
| --rtc.congestion_control.probe_config.overage_pct value generated (default: 0) [$LIVEKIT_RTC_CONGESTION_CONTROL_PROBE_CONFIG_OVERAGE_PCT] | |
| --webhook.api_key value generated [$LIVEKIT_WEBHOOK_API_KEY] | |
| --rtc.congestion_control.min_channel_capacity value generated (default: 0) [$LIVEKIT_RTC_CONGESTION_CONTROL_MIN_CHANNEL_CAPACITY] | |
| --rtc.congestion_control.probe_config.trend_wait value generated (default: 0) [$LIVEKIT_RTC_CONGESTION_CONTROL_PROBE_CONFIG_TREND_WAIT] | |
| --rtc.congestion_control.channel_observer_non_probe_config.nack_window_min_duration value generated (default: 0) [$LIVEKIT_RTC_CONGESTION_CONTROL_CHANNEL_OBSERVER_NON_PROBE_CONFIG_NACK_WINDOW_MIN_DURATION] | |
| --video.stream_tracker.screenshare.stream_tracker_type value generated [$LIVEKIT_VIDEO_STREAM_TRACKER_SCREENSHARE_STREAM_TRACKER_TYPE] | |
| --turn.udp_port value generated (default: 0) [$LIVEKIT_TURN_UDP_PORT] | |
| --rtc.enable_loopback_candidate generated (default: false) | |
| --logging.level value generated [$LIVEKIT_LOGGING_LEVEL] | |
| --logging.item_sample_seconds value generated (default: 0) [$LIVEKIT_LOGGING_ITEM_SAMPLE_SECONDS] | |
| --rtc.congestion_control.channel_observer_non_probe_config.nack_ratio_threshold value generated (default: 0) [$LIVEKIT_RTC_CONGESTION_CONTROL_CHANNEL_OBSERVER_NON_PROBE_CONFIG_NACK_RATIO_THRESHOLD] | |
| --redis.write_timeout value generated (default: 0) [$LIVEKIT_REDIS_WRITE_TIMEOUT] | |
| --ingress.rtmp_base_url value generated [$LIVEKIT_INGRESS_RTMP_BASE_URL] | |
| --rtc.udp_port value generated (default: 0) [$LIVEKIT_RTC_UDP_PORT] | |
| --rtc.congestion_control.channel_observer_non_probe_config.nack_window_max_duration value generated (default: 0) [$LIVEKIT_RTC_CONGESTION_CONTROL_CHANNEL_OBSERVER_NON_PROBE_CONFIG_NACK_WINDOW_MAX_DURATION] | |
| --rtc.packet_buffer_size value generated (default: 0) [$LIVEKIT_RTC_PACKET_BUFFER_SIZE] | |
| --rtc.congestion_control.probe_config.duration_overflow_factor value generated (default: 0) [$LIVEKIT_RTC_CONGESTION_CONTROL_PROBE_CONFIG_DURATION_OVERFLOW_FACTOR] | |
| --rtc.congestion_control.channel_observer_probe_config.nack_window_min_duration value generated (default: 0) [$LIVEKIT_RTC_CONGESTION_CONTROL_CHANNEL_OBSERVER_PROBE_CONFIG_NACK_WINDOW_MIN_DURATION] | |
| --room.enable_remote_unmute generated (default: false) | |
| --room.max_metadata_size value generated (default: 0) [$LIVEKIT_ROOM_MAX_METADATA_SIZE] | |
| --turn.key_file value generated [$LIVEKIT_TURN_KEY_FILE] | |
| --turn.external_tls generated (default: false) | |
| --rtc.congestion_control.probe_config.settle_wait_max value generated (default: 0) [$LIVEKIT_RTC_CONGESTION_CONTROL_PROBE_CONFIG_SETTLE_WAIT_MAX] | |
| --rtc.reconnect_on_publication_error generated (default: false) | |
| --redis.max_redirects value generated (default: 0) [$LIVEKIT_REDIS_MAX_REDIRECTS] | |
| --signal_relay.min_retry_interval value generated (default: 0) [$LIVEKIT_SIGNAL_RELAY_MIN_RETRY_INTERVAL] | |
| --rtc.node_ip value generated [$LIVEKIT_RTC_NODE_IP] | |
| --rtc.congestion_control.probe_config.duration_increase_factor value generated (default: 0) [$LIVEKIT_RTC_CONGESTION_CONTROL_PROBE_CONFIG_DURATION_INCREASE_FACTOR] | |
| --key_file value generated [$LIVEKIT_KEY_FILE] | |
| --logging.pion_level value generated [$LIVEKIT_LOGGING_PION_LEVEL] | |
| --rtc.tcp_port value generated (default: 0) [$LIVEKIT_RTC_TCP_PORT] | |
| --rtc.pli_throttle.mid_quality value generated (default: 0) [$LIVEKIT_RTC_PLI_THROTTLE_MID_QUALITY] | |
| --room.playout_delay.min value generated (default: 0) [$LIVEKIT_ROOM_PLAYOUT_DELAY_MIN] | |
| --rtc.congestion_control.probe_config.backoff_factor value generated (default: 0) [$LIVEKIT_RTC_CONGESTION_CONTROL_PROBE_CONFIG_BACKOFF_FACTOR] | |
| --rtc.congestion_control.probe_config.min_duration value generated (default: 0) [$LIVEKIT_RTC_CONGESTION_CONTROL_PROBE_CONFIG_MIN_DURATION] | |
| --turn.tls_port value generated (default: 0) [$LIVEKIT_TURN_TLS_PORT] | |
| --limit.subscription_limit_audio value generated (default: 0) [$LIVEKIT_LIMIT_SUBSCRIPTION_LIMIT_AUDIO] | |
| --limit.bytes_per_sec value generated (default: 0) [$LIVEKIT_LIMIT_BYTES_PER_SEC] | |
| --rtc.congestion_control.probe_config.base_interval value generated (default: 0) [$LIVEKIT_RTC_CONGESTION_CONTROL_PROBE_CONFIG_BASE_INTERVAL] | |
| --ingress.whip_base_url value generated [$LIVEKIT_INGRESS_WHIP_BASE_URL] | |
| --logging.item_sample_initial value generated (default: 0) [$LIVEKIT_LOGGING_ITEM_SAMPLE_INITIAL] | |
| --rtc.congestion_control.channel_observer_probe_config.estimate_required_samples value generated (default: 0) [$LIVEKIT_RTC_CONGESTION_CONTROL_CHANNEL_OBSERVER_PROBE_CONFIG_ESTIMATE_REQUIRED_SAMPLES] | |
| --development generated (default: false) | |
| --redis.address value generated [$LIVEKIT_REDIS_ADDRESS] | |
| --node_selector.kind value generated [$LIVEKIT_NODE_SELECTOR_KIND] | |
| --node_selector.sort_by value generated [$LIVEKIT_NODE_SELECTOR_SORT_BY] | |
| --rtc.use_external_ip generated (default: false) | |
| --log_level value generated [$LIVEKIT_LOG_LEVEL] | |
| --turn.relay_range_end value generated (default: 0) [$LIVEKIT_TURN_RELAY_RANGE_END] | |
| --logging.item_sample_interval value generated (default: 0) [$LIVEKIT_LOGGING_ITEM_SAMPLE_INTERVAL] | |
| --redis.sentinel_master_name value generated [$LIVEKIT_REDIS_SENTINEL_MASTER_NAME] | |
| --room.max_participants value generated (default: 0) [$LIVEKIT_ROOM_MAX_PARTICIPANTS] | |
| --rtc.use_ice_lite generated (default: false) | |
| --rtc.congestion_control.allow_pause generated (default: false) | |
| --rtc.congestion_control.send_side_bandwidth_estimation generated (default: false) | |
| --rtc.congestion_control.channel_observer_probe_config.estimate_downward_trend_max_wait value generated (default: 0) [$LIVEKIT_RTC_CONGESTION_CONTROL_CHANNEL_OBSERVER_PROBE_CONFIG_ESTIMATE_DOWNWARD_TREND_MAX_WAIT] | |
| --rtc.strict_acks generated (default: false) | |
| --redis.dial_timeout value generated (default: 0) [$LIVEKIT_REDIS_DIAL_TIMEOUT] | |
| --room.empty_timeout value generated (default: 0) [$LIVEKIT_ROOM_EMPTY_TIMEOUT] | |
| --logging.sample_interval value generated (default: 0) [$LIVEKIT_LOGGING_SAMPLE_INTERVAL] | |
| --rtc.congestion_control.channel_observer_probe_config.estimate_collapse_threshold value generated (default: 0) [$LIVEKIT_RTC_CONGESTION_CONTROL_CHANNEL_OBSERVER_PROBE_CONFIG_ESTIMATE_COLLAPSE_THRESHOLD] | |
| --rtc.congestion_control.channel_observer_non_probe_config.estimate_downward_trend_threshold value generated (default: 0) [$LIVEKIT_RTC_CONGESTION_CONTROL_CHANNEL_OBSERVER_NON_PROBE_CONFIG_ESTIMATE_DOWNWARD_TREND_THRESHOLD] | |
| --signal_relay.retry_timeout value generated (default: 0) [$LIVEKIT_SIGNAL_RELAY_RETRY_TIMEOUT] | |
| --signal_relay.max_retry_interval value generated (default: 0) [$LIVEKIT_SIGNAL_RELAY_MAX_RETRY_INTERVAL] | |
| --rtc.congestion_control.probe_config.max_interval value generated (default: 0) [$LIVEKIT_RTC_CONGESTION_CONTROL_PROBE_CONFIG_MAX_INTERVAL] | |
| --rtc.congestion_control.channel_observer_probe_config.estimate_validity_window value generated (default: 0) [$LIVEKIT_RTC_CONGESTION_CONTROL_CHANNEL_OBSERVER_PROBE_CONFIG_ESTIMATE_VALIDITY_WINDOW] | |
| --audio.min_percentile value generated (default: 0) [$LIVEKIT_AUDIO_MIN_PERCENTILE] | |
| --rtc.congestion_control.expected_usage_threshold value generated (default: 0) [$LIVEKIT_RTC_CONGESTION_CONTROL_EXPECTED_USAGE_THRESHOLD] | |
| --rtc.congestion_control.padding_mode value generated [$LIVEKIT_RTC_CONGESTION_CONTROL_PADDING_MODE] | |
| --rtc.congestion_control.channel_observer_non_probe_config.estimate_collapse_threshold value generated (default: 0) [$LIVEKIT_RTC_CONGESTION_CONTROL_CHANNEL_OBSERVER_NON_PROBE_CONFIG_ESTIMATE_COLLAPSE_THRESHOLD] | |
| --signal_relay.enabled generated (default: false) | |
| --rtc.force_tcp generated (default: false) | |
| --rtc.congestion_control.enabled generated (default: false) | |
| --rtc.congestion_control.channel_observer_non_probe_config.estimate_validity_window value generated (default: 0) [$LIVEKIT_RTC_CONGESTION_CONTROL_CHANNEL_OBSERVER_NON_PROBE_CONFIG_ESTIMATE_VALIDITY_WINDOW] | |
| --rtc.allow_tcp_fallback generated (default: false) | |
| --rtc.congestion_control.channel_observer_non_probe_config.estimate_required_samples_min value generated (default: 0) [$LIVEKIT_RTC_CONGESTION_CONTROL_CHANNEL_OBSERVER_NON_PROBE_CONFIG_ESTIMATE_REQUIRED_SAMPLES_MIN] | |
| --rtc.external_ip_only generated (default: false) | |
| --rtc.congestion_control.probe_config.max_duration value generated (default: 0) [$LIVEKIT_RTC_CONGESTION_CONTROL_PROBE_CONFIG_MAX_DURATION] | |
| --video.stream_tracker.video.stream_tracker_type value generated [$LIVEKIT_VIDEO_STREAM_TRACKER_VIDEO_STREAM_TRACKER_TYPE] | |
| --environment value generated [$LIVEKIT_ENVIRONMENT] | |
| --audio.active_level value generated (default: 0) [$LIVEKIT_AUDIO_ACTIVE_LEVEL] | |
| --video.dynacast_pause_delay value generated (default: 0) [$LIVEKIT_VIDEO_DYNACAST_PAUSE_DELAY] | |
| --rtc.reconnect_on_subscription_error generated (default: false) | |
| --rtc.congestion_control.nack_ratio_attenuator value generated (default: 0) [$LIVEKIT_RTC_CONGESTION_CONTROL_NACK_RATIO_ATTENUATOR] | |
| --room.playout_delay.enabled generated (default: false) | |
| --rtc.congestion_control.probe_config.min_bps value generated (default: 0) [$LIVEKIT_RTC_CONGESTION_CONTROL_PROBE_CONFIG_MIN_BPS] | |
| --redis.password value generated [$LIVEKIT_REDIS_PASSWORD] | |
| --redis.sentinel_username value generated [$LIVEKIT_REDIS_SENTINEL_USERNAME] | |
| --audio.update_interval value generated (default: 0) [$LIVEKIT_AUDIO_UPDATE_INTERVAL] | |
| --audio.smooth_intervals value generated (default: 0) [$LIVEKIT_AUDIO_SMOOTH_INTERVALS] | |
| --rtc.port_range_start value generated (default: 0) [$LIVEKIT_RTC_PORT_RANGE_START] | |
| --rtc.pli_throttle.high_quality value generated (default: 0) [$LIVEKIT_RTC_PLI_THROTTLE_HIGH_QUALITY] | |
| --logging.sample generated (default: false) | |
| --node_selector.cpu_load_limit value generated (default: 0) [$LIVEKIT_NODE_SELECTOR_CPU_LOAD_LIMIT] | |
| --rtc.port_range_end value generated (default: 0) [$LIVEKIT_RTC_PORT_RANGE_END] | |
| --logging.sample_initial value generated (default: 0) [$LIVEKIT_LOGGING_SAMPLE_INITIAL] | |
| --turn.relay_range_start value generated (default: 0) [$LIVEKIT_TURN_RELAY_RANGE_START] | |
| --limit.subscription_limit_video value generated (default: 0) [$LIVEKIT_LIMIT_SUBSCRIPTION_LIMIT_VIDEO] | |
| --rtc.use_mdns generated (default: false) | |
| --rtc.congestion_control.probe_config.settle_wait value generated (default: 0) [$LIVEKIT_RTC_CONGESTION_CONTROL_PROBE_CONFIG_SETTLE_WAIT] | |
| --rtc.congestion_control.channel_observer_probe_config.nack_window_max_duration value generated (default: 0) [$LIVEKIT_RTC_CONGESTION_CONTROL_CHANNEL_OBSERVER_PROBE_CONFIG_NACK_WINDOW_MAX_DURATION] | |
| --redis.db value generated (default: 0) [$LIVEKIT_REDIS_DB] | |
| --redis.sentinel_password value generated [$LIVEKIT_REDIS_SENTINEL_PASSWORD] | |
| --room.auto_create generated (default: false) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment