ReferenceRéférence

SettingsRéglages

Every key of config.json with its type, default and range, read from the Settings struct of the sources.Toutes les clés de config.json avec leur type, valeur par défaut et plage, lues depuis la struct Settings des sources.

~/.config/xdesk/config.json (Windows: %LOCALAPPDATA%\xdesk), written by the settings page of the panels (version v1.0.0, generated from include/xdesk/core/Config.hpp). A value out of its range is brought back into it when the file is read.

~/.config/xdesk/config.json (Windows : %LOCALAPPDATA%\xdesk), écrit par la page des réglages des panneaux (version v1.0.0, généré depuis include/xdesk/core/Config.hpp, descriptions du programme, en anglais). Une valeur hors de sa plage y est ramenée à la lecture du fichier.

1. NetworkRéseau

Key	Type	Default	Range	Meaning
`port`	int	`47800`	-	https + wss port
`bind`	string	`0.0.0.0`	-	listening address ("::" for IPv6)
`exposure`	string	`lan`	-	how the host is reachable
`publicHost`	string	-	-	Manual: public address / domain shown to the clients
`discovery`	bool	`true`	-	udp broadcast on the LAN (xdesk scan)
`udp`	bool	`true`	-	video of the native viewers (and the android app) over encrypted udp on the same port (tcp when it does not get through)
`lanes`	bool	`true`	-	web viewers: extra websockets for the video while one connection holds it back (lossy far paths)

Clé	Type	Défaut	Plage	Sens
`port`	int	`47800`	-	https + wss port
`bind`	string	`0.0.0.0`	-	listening address ("::" for IPv6)
`exposure`	string	`lan`	-	how the host is reachable
`publicHost`	string	-	-	Manual: public address / domain shown to the clients
`discovery`	bool	`true`	-	udp broadcast on the LAN (xdesk scan)
`udp`	bool	`true`	-	video of the native viewers (and the android app) over encrypted udp on the same port (tcp when it does not get through)
`lanes`	bool	`true`	-	web viewers: extra websockets for the video while one connection holds it back (lossy far paths)

2. AccessAccès

Key	Type	Default	Range	Meaning
`codeLength`	int	`9`	`6 - 24`	characters of the pairing code (Crockford base32, 5 bits each)
`codeLifetime`	int	`300`	-	seconds before the code rotates (0 = only after use)
`approval`	string	`untrusted`	-	local confirmation of the connections
`maxSessions`	int	`8`	`1 - 64`	simultaneous sessions
`maxAuthFailures`	int	`5`	`1 - 100`	failed codes of one address before its ban
`idleTimeout`	int	`0`	-	seconds without input before a kick (0 = never)
`allowControl`	bool	`true`	-	keyboard / mouse of the clients
`allowTerminal`	bool	`true`	-	remote terminals
`allowWeb`	bool	`true`	-	browsers and the android app
`viewOnlyDefault`	bool	`false`	-	new sessions start in view only mode
`banOnTamper`	bool	`true`	-	automatic bans (a session caught touching xdesk, an unclean stop during a remote session, too many wrong codes); off = kicked / refused only
`focusRequest`	bool	`true`	-	a viewer paused by the focus of the host panel may ask its control back
`focusRequestDelay`	int	`60`	`5 - 3600`	seconds before that request is granted (time to refuse / unplug)
`shell`	string	-	-	shell of the remote terminals (empty = $SHELL / cmd.exe)

Clé	Type	Défaut	Plage	Sens
`codeLength`	int	`9`	`6 - 24`	characters of the pairing code (Crockford base32, 5 bits each)
`codeLifetime`	int	`300`	-	seconds before the code rotates (0 = only after use)
`approval`	string	`untrusted`	-	local confirmation of the connections
`maxSessions`	int	`8`	`1 - 64`	simultaneous sessions
`maxAuthFailures`	int	`5`	`1 - 100`	failed codes of one address before its ban
`idleTimeout`	int	`0`	-	seconds without input before a kick (0 = never)
`allowControl`	bool	`true`	-	keyboard / mouse of the clients
`allowTerminal`	bool	`true`	-	remote terminals
`allowWeb`	bool	`true`	-	browsers and the android app
`viewOnlyDefault`	bool	`false`	-	new sessions start in view only mode
`banOnTamper`	bool	`true`	-	automatic bans (a session caught touching xdesk, an unclean stop during a remote session, too many wrong codes); off = kicked / refused only
`focusRequest`	bool	`true`	-	a viewer paused by the focus of the host panel may ask its control back
`focusRequestDelay`	int	`60`	`5 - 3600`	seconds before that request is granted (time to refuse / unplug)
`shell`	string	-	-	shell of the remote terminals (empty = $SHELL / cmd.exe)

3. StreamFlux

Key	Type	Default	Range	Meaning
`fps`	int	`60`	`1 - 120`	frames per second cap
`quality`	int	`70`	`1 - 100`	jpeg quality (1 - 100)
`scale`	number	`1.0`	`0.25 - 1.0`	scale of the frames sent (0.25 - 1.0)
`maxHeight`	int	`0`	`0 - 4320`	frames at most this tall, the width follows (0 = the screen size): 1080, 720, 480...
`autoResolution`	bool	`true`	-	a viewer whose link cannot follow even at the lowest quality gets a lower resolution, raised again once the link is calm
`h264`	bool	`true`	-	the large moves go as H.264 video (openh264) to the viewers that decode it while their link is the bottleneck

Clé	Type	Défaut	Plage	Sens
`fps`	int	`60`	`1 - 120`	frames per second cap
`quality`	int	`70`	`1 - 100`	jpeg quality (1 - 100)
`scale`	number	`1.0`	`0.25 - 1.0`	scale of the frames sent (0.25 - 1.0)
`maxHeight`	int	`0`	`0 - 4320`	frames at most this tall, the width follows (0 = the screen size): 1080, 720, 480...
`autoResolution`	bool	`true`	-	a viewer whose link cannot follow even at the lowest quality gets a lower resolution, raised again once the link is calm
`h264`	bool	`true`	-	the large moves go as H.264 video (openh264) to the viewers that decode it while their link is the bottleneck

4. InterfaceInterface

Key	Type	Default	Range	Meaning
`theme`	string	`system`	-	system \| dark \| light
`language`	string	`en`	-	en \| fr
`startMinimized`	bool	`false`	-	tray only at start (gui)

Clé	Type	Défaut	Plage	Sens
`theme`	string	`system`	-	system \| dark \| light
`language`	string	`en`	-	en \| fr
`startMinimized`	bool	`false`	-	tray only at start (gui)