Pin sidebar
Connection
Authentication
Method
Basic
Json Web Token
OIDC
Username
Password
Token
You will be prompted to log in with your identity provider.
Login in popup
Actions
Overlay configuration
Toggle shortcut
Information
Connection status:
Total Latency:
N/A
Server:
N/A
Network:
N/A
Client:
N/A
Display the metrics graph
Documentation
URL Parameters
host
: Where to connect. Default:
127.0.0.1
port
: The port to use for connect. Default:
8080
oidc_popup
: Open OIDC login in a popup window (boolean). Default:
true
auth_method
: The authentication method used. Default:
basic
. Possible values:
basic
jwt
oidc
protocol
: The protocol to use. Default:
kymux
. Possible values:
websocket
kymux
kymux_video
: The kymux video protocol to use. Default:
reliable
. Possible values:
reliable
gopstream
unreliable
unreliable_fec
kymux_audio
: The kymux audio protocol to use. Default:
reliable
. Possible values:
reliable
unreliable
unreliable_fec
bitrate
: Connection bitrate. Default:
20000000
video_codec
: The video codec to use. Default:
h264
. Possible values:
h264
hevc
display_index
: The index of the display to grab. Default:
0
yuv444
: Enable 4:4:4 chroma. Default:
false
software_decode
: Force software decoding. Default:
false
audio
: Enable audio. Default:
true
audio_buffer
: Set audio buffer size. Default:
50
inputs
: Forward inputs. Default:
true
intra_refresh
: Enable intra refresh (boolean). Default:
true
gamepad_force_xbox360
: Force to plug gamepads as Xbox 360 controllers (boolean). Default:
false
clipboard
: Enable Clipboard support (boolean). Default:
true
Click anywhere to unmute