Advanced Settings

All advanced settings in custom clients are covered here.

Privilege Levels for Settings

There are four types of settings:

1. Override settings, in Web Console → Custom Clients
2. Default settings, in Web Console → Custom Clients
3. User settings, in the RustDesk client
4. Strategy settings, in Web Console → Strategies

The hierarchy of privilege for these settings is as follows: Override > Strategy > User > Default.

Security Settings

access-mode

Set the access mode (permissions) for incoming connections.

Location:

1. Desktop Settings → Security → Permissions
2. Mobile

enable-keyboard

Enable keyboard/mouse input for incoming connections.

Location:

1. Desktop Settings → Security → Permissions → Enable keyboard
2. Mobile

enable-clipboard

Enable copy and paste for incoming connections.

Location:

1. Desktop Settings → Security → Permissions → Enable clipboard
2. Mobile

enable-file-transfer

Enable file copy and paste or file transfer (session) for incoming connections.

Location:

1. Desktop Settings → Security → Permissions → Enable file transfer
2. Mobile

enable-audio

Enable audio record and transfer to peer.

Location:

1. Desktop Settings → Security → Permissions → Enable audio
2. Mobile

enable-tunnel

Enable TCP tunneling.

Location:

1. Desktop Settings → Security → Permissions → Enable TCP tunneling
2. Mobile

enable-remote-restart

Enable restarting by the control side.

Location:

1. Desktop Settings → Security → Permissions → Enable remote restart
2. Mobile

enable-record-session

Enable sessions to be recorded.

Location:

1. Desktop Settings → Security → Permissions → Enable recording session
2. Mobile Settings → Share screen → Enable recording session

enable-block-input

Enable the control side to block other users’ input.

Location:

1. Desktop Settings → Security → Permissions → Enable blocking user input (Windows only)
2. Mobile

allow-remote-config-modification

Allow the control side to change the settings in controlled RustDesk UI.

Location:

1. Desktop Settings → Security → Permissions → Enable remote configuration modification
2. Mobile

enable-lan-discovery

Allows LAN peers to discover me.

After LAN discovery, WOL can work if supported locally.

Location:

1. Desktop Settings → Security → Security → Deny LAN discovery
2. Mobile Settings → Share screen → Deny LAN discovery

direct-server

Enable direct IP access.

Location:

1. Desktop Settings → Security → Security → Enable direct IP access
2. Mobile Settings → Share screen → Direct IP access

direct-access-port

Direct IP access port.

Location:

1. Desktop Settings → Security → Security → Direct IP access port (Show if “Enable direct IP access” is checked)
2. Mobile Settings → Share screen → Direct IP access

whitelist

Use IP Whitelisting.

Location:

1. Desktop Settings → Security → Security → Use IP Whitelisting
2. Mobile Settings → Share screen → Use IP Whitelisting

allow-auto-disconnect & auto-disconnect-timeout

Automatically close incoming sessions after a period of user inactivity.

Location:

1. Desktop Settings → Security → Security → Automatically close incoming sessions on user inactivity
2. Mobile Settings → Share screen → Automatically close incoming sessions on user inactivity

allow-only-conn-window-open

Only allow connection if RustDesk window is open.

Location:

1. Desktop Settings → Security → Security → Only allow connection if RustDesk window is open
2. Mobile

approve-mode

Accept incoming connections via password or manually click.

Location:

1. Desktop Settings → Security → Password → Dropdown box
2. Mobile Share screen → Dropdown menu on right-up corner

verification-method

What type of password can be used, temporary password refers to the one-time random password.

proxy-url

The proxy URL.

Currently support http and socks5.

Location:

1. Desktop Settings → Network → Proxy → Socks5/Http(s) proxy
2. Mobile

Examples:

1. http proxy-url=http://192.168.0.2:12345
2. https proxy-url=https://192.168.0.2:12345
3. socks5 proxy-url=socks5://192.168.0.2:1080

proxy-username & proxy-password

Proxy username and password.

Location:

1. Desktop Settings → Network → Proxy → Socks5/Http(s) proxy
2. Mobile

General Settings

theme

Controls the UI theme of RustDesk client.

Location:

1. Desktop Settings → General → Theme
2. Mobile Settings → Settings → Theme

lang

Controls the language of RustDesk client.

Location:

1. Desktop Settings → General → Language
2. Mobile Settings → Settings → Language

Currently available languages are:

ar, bg, ca, cs, da, de, el, en, eo, es, et, fa, fr, he, hr, hu, id, it, ja, ko, kz, lt, lv, nb, nl, pl, pt, ro, ru, sk, sl, sq, sr, sv, th, tr, uk, vn, zh-cn, zh-tw

You can check LANGS in the code for the latest language list.

allow-auto-record-incoming

Automatically record incoming sessions.

Location:

1. Desktop Settings → General → Recording → Automatically record incoming sessions
2. Mobile Settings → Recording → Automatically record incoming sessions

allow-auto-record-outgoing

Automatically record outgoing sessions.

Location:

1. Desktop Settings → General → Recording → Automatically record outgoing sessions
2. Mobile Settings → Recording → Automatically record outgoing sessions

video-save-directory

The directory to save recorded videos.

Location:

1. Desktop Settings → General → Recording → Video save directory
2. Mobile Settings → Recording

Default values:

1. macOS ~/Movies/app_name
2. Linux ~/Videos/app_name
3. Windows %USERPROFILE%\Videos\app_name
4. Android /Storage/emulated/0/app_name/ScreenRecord

Note: Replace app_name means current app name.

enable-confirm-closing-tabs

Controls whether to show a confirm dialog before closing all remote tabs.

Location:

1. Desktop Settings → General → Other → Confirm before closing multiple tabs
2. Mobile

enable-abr

Enable adaptive bitrate.

Location:

1. Desktop Settings → General → Other → Adaptive bitrate
2. Mobile Settings → Share screen → Adaptive bitrate (beta)

allow-remove-wallpaper

Remove wallpaper during incoming sessions.

Location:

1. Desktop Settings → General → Other → Remove wallpaper during incoming sessions
2. Mobile

enable-open-new-connections-in-tabs

Controls whether to use a new tab or a new window to open a new connection.

Location:

1. Desktop Settings → General → Other → Open connection in new tab
2. Mobile

allow-always-software-render

Always use software rendering.

Location:

1. Desktop Settings → General → Other → Always use software rendering
2. Mobile

allow-linux-headless

Allow incoming connection if there’s no displays.

This option requires desktop environment, Xorg server and GDM, see PR 3902.

Location:

1. Desktop Settings → General → Other → Allow Linux headless
2. Mobile

enable-hwcodec

Enable hardware encoding to make the picture smoother.

Location:

1. Desktop
2. Mobile Settings → Hardware codec

peer-card-ui-type

Controls the view of peer cards, includes “Big tiles”, “Small tiles” and “List”.

Location:

1. Desktop Home → Peer panel → Right top grid icon
2. Mobile

0 Big tiles
1 Small tiles
2 List

peer-sorting

Controls the ordering of peer cards.

Location:

1. Desktop Home → Peer panel → Right top sort icon
2. Mobile

sync-ab-with-recent-sessions

Controls whether to sync the address book with recent sessions.

Location:

1. Desktop Home → Peer panel → Address book → Tags → Dropdown menu → Sync with recent sessions
2. Mobile Home → Peer panel → Address book → Tags → Dropdown menu → Sync with recent sessions

sync-ab-tags

Controls whether to sort the address book tags.

Location:

1. Desktop Home → Peer panel → Address book → Tags → Dropdown menu → Sort tags
2. Mobile Home → Peer panel → Address book → Tags → Dropdown menu → Sort tags

filter-ab-by-intersection

Filter address book by tag intersection.

Preview: PR #5985

Location:

1. Desktop Home → Peer panel → Address book → Tags → Dropdown menu → Filter by intersection
2. Mobile Home → Peer panel → Address book → Tags → Dropdown menu → Filter by intersection

Display Settings

view-only

This option will set the “view-only” option for every peer after the first connection.

Then the “view-only” option in each peer’s settings will controls whether the connection is view-only.

Location:

1. Desktop Settings → Display → Other default options → View mode
2. Mobile Settings → Display settings → Other default options → View mode

show-monitors-toolbar

Controls whether to show monitors in toolbar.

Location:

1. Desktop Settings → Display → Other default options → Show monitors toolbar
2. Mobile

collapse-toolbar

Controls whether the remote toolbar is collapsed after connecting.

Location:

1. Desktop Settings → Display → Other default options → Collapse toolbar
2. Mobile

show-remote-cursor

This option will set the “show-remote-cursor” option for every peer after the first connection.

Then the “show-remote-cursor” option in each peer’s settings will controls whether the remote cursor is displayed in the remote control page.

Location:

1. Desktop Settings → Display → Other default options → Show remote cursor
2. Mobile Settings → Display settings → Other default options → Show remote cursor

follow-remote-cursor

This option will set the “follow-remote-cursor” option for every peer after the first connection.

Then the “follow-remote-cursor” option in each peer’s settings will controls whether to follow the remote cursor.

Preview: PR 7717

Location:

1. Desktop Settings → Display → Other default options → Follow remote cursor
2. Mobile Settings → Display settings → Other default options → Follow remote cursor

follow-remote-window

This option will set the “follow-remote-window” option for every peer after the first connection.

Then the “follow-remote-window” option in each peer’s settings will controls whether to follow the remote window.

Preview: PR 7717

Location:

1. Desktop Settings → Display → Other default options → Follow remote window focus
2. Mobile Settings → Display settings → Other default options → Follow remote window focus

zoom-cursor

This option will set the “zoom-cursor” option for every peer after the first connection.

The “zoom-cursor” option in each peer’s settings will then control whether the cursor is scaled based on the current image scale.

Location:

1. Desktop Settings → Display → Other default options → Zoom cursor
2. Mobile

show-quality-monitor

This option will set the “show-quality-monitor” option for every peer after the first connection.

The “show-quality-monitor” option in each peer’s settings will then control whether to show the quality monitor.

Location:

1. Desktop Settings → Display → Other default options → Show quality monitor
2. Mobile Settings → Display settings → Other default options → Show quality monitor

disable-audio

This option will set the “disable-audio” option for every peer after the first connection.

The “disable-audio” option in each peer’s settings will then control whether to play sound.

Location:

1. Desktop Settings → Display → Other default options → Mute
2. Mobile Settings → Display settings → Other default options → Mute

enable-file-copy-paste

This option will set the “enable-file-copy-paste” option for every peer after the first connection.

The “enable-file-copy-paste” option in each peer’s settings will then control enable file copy and paste in connection.

Location:

1. Desktop Settings → Display → Other default options → Enable file copy and paste (Windows only)
2. Mobile

disable-clipboard

This option will set the “disable-clipboard” option for every peer after the first connection.

The “disable-clipboard” option in each peer’s settings will then control whether to enable text copy and paste.

Location:

1. Desktop Settings → Display → Other default options → Disable clipboard
2. Mobile Settings → Display settings → Other default options → Disable clipboard

lock-after-session-end

This option will set the “lock-after-session-end” option for every peer after the first connection.

The “lock-after-session-end” option in each peer’s settings will then control whether to lock the peer machine after the session ends.

Location:

1. Desktop Settings → Display → Other default options → Lock after session end
2. Mobile Settings → Display settings → Other default options → Lock after session end

privacy-mode

This option will set the “privacy-mode” option for every peer after the first connection.

The “privacy-mode” option in each peer’s settings will then control whether to use privacy mode after connecting.

Location:

1. Desktop Settings → Display → Other default options → Privacy mode
2. Mobile Settings → Display settings → Other default options → Privacy mode

touch-mode

This option will set the “touch-mode” option for every peer after the first connection.

The “touch-mode” option in each peer’s settings will then control whether to use touch mode or mouse mode.

Location:

1. Desktop
2. Mobile Settings → Display settings → Other default options → Touch mode

i444

This option will set the “i444” option for every peer after the first connection.

The “i444” option in each peer’s settings will then control whether to use true color.

Location:

1. Desktop Settings → Display → Other default options → True color (4:4:4)
2. Mobile Settings → Display settings → Other default options → True color (4:4:4)

reverse-mouse-wheel

This option will set the “reverse-mouse-wheel” option for every peer after the first connection.

The “reverse-mouse-wheel” option in each peer’s settings will then control whether to reverse mouse wheel.

Location:

1. Desktop Settings → Display → Other default options → Reverse mouse wheel
2. Mobile Settings → Display settings → Other default options → Reverse mouse wheel

swap-left-right-mouse

This option will set the “swap-left-right-mouse” option for every peer after the first connection.

The “swap-left-right-mouse” option in each peer’s settings will then control whether to swap left-right mouse button.

Location:

1. Desktop Settings → Display → Other default options → Swap left-right mouse button
2. Mobile Settings → Display settings → Other default options → Swap left-right mouse button

displays-as-individual-windows

This option will set the “displays-as-individual-windows” option for every peer after the first connection.

The “displays-as-individual-windows” option in each peer’s settings will then control whether to show displays as individual windows.

Preview: PR 5945

Location:

1. Desktop Settings → Display → Other default options → Show displays as individual windows
2. Mobile

use-all-my-displays-for-the-remote_session

This option will set the “use-all-my-displays-for-the-remote_session” option for every peer after the first connection.

The “use-all-my-displays-for-the-remote_session” option in each peer’s settings will then control whether to use all my displays for the remote session.

Preview: PR 6064

Location:

1. Desktop Settings → Display → Other default options → Use all my displays for the remote session
2. Mobile

view-style

This option will set the “view-style” option for every peer after the first connection.

The “view-style” option in each peer’s settings will then control the view style.

Location:

1. Desktop Settings → Display → Default view style
2. Mobile Settings → Display settings → Default view style

scroll-style

This option will set the “scroll-style” option for every peer after the first connection.

The “scroll-style” option in each peer’s settings will then control the scroll style.

Location:

1. Desktop Settings → Display → Default scroll style
2. Mobile

image-quality

This option will set the “image-quality” option for every peer after the first connection.

The “image-quality” option in each peer’s settings will then control the image quality.

Location:

1. Desktop Settings → Display → Default image quality
2. Mobile Settings → Display settings → Default image quality

custom-image-quality

This option will set the “custom-image-quality” option for every peer after the first connection.

The “custom-image-quality” option in each peer’s settings will then control the image quality if “image-quality” is set to custom.

Location:

1. Desktop Settings → Display → Default image quality → Custom
2. Mobile Settings → Display settings → Default image quality → Custom

custom-fps

This option will set the “custom-fps” option for every peer after the first connection.

The “custom-fps” option in each peer’s settings will then control the fps if “image-quality” is set to custom.

Location:

1. Desktop Settings → Display → Default image quality → Custom
2. Mobile Settings → Display settings → Default image quality → Custom

codec-preference

This option will set the “codec-preference” option for every peer after the first connection.

The “codec-preference” option in each peer’s settings will then control codec for images.

Location:

1. Desktop Settings → Display → Default codec
2. Mobile Settings → Display settings → Default codec

Caution: Options other than “vp8” and “vp9” may not work. This depends on what your machine supports.

preset-address-book-name & preset-address-book-tag

Preset address book name and tag, https://github.com/rustdesk/rustdesk-server-pro/issues/257. You can set preset-address-book-name only if you do not want to set tag. Please use valid address book name and tag on your address book page of web console.

disable-group-panel

Disable group panel (next to address book panel) on RustDesk client, https://github.com/rustdesk/rustdesk-server-pro/issues/250.

pre-elevate-service

Automatic elevation on run for Windows portable, https://github.com/rustdesk/rustdesk-server-pro/issues/252.

disable-floating-window

When the Android service starts, it will display a floating window, which helps prevent the system from killing the RustDesk service.

floating-window-size

When the Android service starts, it will display a floating window, which helps prevent the system from killing the RustDesk service. When the size is less than 120, the floating window will be difficult to be clicked. A very small size may not be able to keep the background service on some devices.

floating-window-untouchable

By default, clicking on the floating window will pop up a menu. After setting it to ‘untouchable’, clicking or swiping will pass through the floating window and be transmitted to the underlying window. After being set to ‘untouchable’, the position of the floating window cannot be changed, and the system may automatically set the floating window to be semi-transparent. However, this feature may not work in a small number of applications, such as the GitHub app.

floating-window-transparency

Android floating windows have adjustable transparency. If you want to enable but hide the floating window, you can set the transparency to 0, the floating window will be automatically set to ‘untouchable’ in order to pass through click events.

floating-window-svg

If an icon is not set for the Android floating window, it will default to displaying the RustDesk icon. When setting, please write the text content of SVG into one line, and pay attention to the SVG support limitations.

keep-screen-on

This is for the Android controlled side. Note that keeping the screen on depends on the floating window.

enable-directx-capture

This is for the Windows controlled side. If you don’t encounter any problems, it is recommended to use the default settings, which prioritize using DirectX for screenshots instead of using GDI directly.

enable-android-software-encoding-half-scale

This is for the Android controlled side. By default, when the resolution is greater than 1200, hardware encoding uses the original resolution, while software encoding uses half the resolution, as software encoding is slower. This option is used to set whether software encoding should be scaled to half the resolution.

allow-remote-cm-modification

Controls whether to allow the control side to click on the connection management window to accept connections, change permissions, etc.

https://github.com/rustdesk/rustdesk/issues/7425

remove-preset-password-warning

Controls whether to remove the security warning on GUI when there is preset password in custom client.

https://github.com/rustdesk/rustdesk-server-pro/discussions/286

https://github.com/rustdesk/rustdesk/discussions/7956

hide-security-settings / hide-network-settings / hide-server-settings / hide-proxy-settings

Controls whether to hide some settings. Please ensure Disable settings is turned off, otherwise these won’t work.

https://github.com/rustdesk/rustdesk-server-pro/issues/263

https://github.com/rustdesk/rustdesk-server-pro/issues/276

hide-username-on-card

Controls whether to show username in the list of devices. Because sometimes, the username is too long, will hide the other info.

https://github.com/rustdesk/rustdesk-server-pro/issues/284#issuecomment-2216521407

hide-help-cards

Controls whether to show UAC / permission warnings on GUI.

https://github.com/rustdesk/rustdesk/issues/8687

display-name

Change your display name which will be shown on the popup when you connect to remote device. By default it displays your OS username.

https://github.com/rustdesk/rustdesk-server-pro/issues/277

disable-udp

Controls whether to use TCP only. It will not use UDP 21116 any more, TCP 21116 will be used instead.

preset-user-name / preset-strategy-name

Assign user / strategy to device. You can also do this via command line.

https://github.com/rustdesk/rustdesk-server-pro/discussions/304

default-connect-password

Default password used to connect to remote devices, this password has lower priority than address book password and local saved password.

e.g. default-connect-password=abcd1234

enable-trusted-devices

Allow trusted devices to skip 2FA verification.

https://github.com/rustdesk/rustdesk/discussions/8513#discussioncomment-10234494

hide-tray

Disable the tray icon in the systray.

https://github.com/rustdesk/rustdesk-server-pro/issues/332

one-way-clipboard-redirection

Disable clipboard sync from controlled side to controlling side, available in RustDesk client >=1.3.1 (controlled side)

https://github.com/rustdesk/rustdesk/discussions/7837

one-way-file-transfer

Disable file transfer from controlled side to controlling side, available in RustDesk client >=1.3.1 (controlled side)

https://github.com/rustdesk/rustdesk/discussions/7837

sync-init-clipboard

If sync initial clipboard when establishing connection (only from controlling side to controlled side), available in RustDesk client >=1.3.1 (controlling side)

https://github.com/rustdesk/rustdesk/discussions/9010

allow-logon-screen-password

If allow password input on logon screen when click-only approve mode is used, available in RustDesk client >=1.3.1 (controlled side)

https://github.com/rustdesk/rustdesk/discussions/9269