2024-05-14 15:51:09 +02:00
---
title: Advanced Settings
weight: 49
---
2024-07-20 22:42:01 +02:00
All advanced settings in custom clients are covered here.
2024-07-08 13:53:35 +02:00
2024-05-19 12:54:37 +02:00
## Privilege Levels for Settings
2024-05-14 15:51:09 +02:00
2024-05-19 09:51:39 +02:00
There are four types of settings:
2024-05-14 15:51:09 +02:00
2024-05-21 21:44:33 +02:00
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"
2024-05-14 15:51:09 +02:00
2024-05-21 21:44:33 +02:00
The hierarchy of privilege for these settings is as follows: `Override > Strategy > User > Default` .
2024-05-14 15:51:09 +02:00
2024-05-19 12:54:37 +02:00
## Security Settings
2024-05-14 15:51:09 +02:00
2024-05-19 12:54:37 +02:00
### access-mode
2024-05-14 15:51:09 +02:00
2024-05-19 05:15:34 +02:00
Set the access mode (permissions) for incoming connections.
2024-05-14 15:51:09 +02:00
**Location**:
2024-05-21 21:44:33 +02:00
1. **Desktop** Settings → Security → Permissions
2. **Mobile**
2024-05-14 15:51:09 +02:00
| Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: |
2024-05-19 15:54:24 +02:00
| N | custom, full, view | custom | `access-mode=custom` |
2024-05-14 15:51:09 +02:00
2024-05-19 12:54:37 +02:00
### enable-keyboard
2024-05-14 15:51:09 +02:00
2024-05-19 05:15:34 +02:00
Enable keyboard/mouse input for incoming connections.
2024-05-14 15:51:09 +02:00
**Location**:
2024-05-21 21:44:33 +02:00
1. **Desktop** Settings → Security → Permissions → Enable keyboard
2. **Mobile**
2024-05-14 15:51:09 +02:00
| Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: |
2024-05-19 15:54:24 +02:00
| N | Y, N | Y | `enable-keyboard=Y` |
2024-05-14 15:51:09 +02:00
2024-05-19 12:54:37 +02:00
### enable-clipboard
2024-05-14 15:51:09 +02:00
2024-07-20 22:42:01 +02:00
Enable copy and paste for incoming connections.
2024-05-14 15:51:09 +02:00
**Location**:
2024-05-21 21:44:33 +02:00
1. **Desktop** Settings → Security → Permissions → Enable clipboard
2. **Mobile**
2024-05-14 15:51:09 +02:00
| Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: |
2024-05-19 15:54:24 +02:00
| N | Y, N | Y | `enable-clipboard=Y` |
2024-05-14 15:51:09 +02:00
2024-05-19 12:54:37 +02:00
### enable-file-transfer
2024-05-14 15:51:09 +02:00
2024-05-21 21:44:33 +02:00
Enable file copy and paste or file transfer (session) for incoming connections.
2024-05-14 15:51:09 +02:00
**Location**:
2024-05-21 21:44:33 +02:00
1. **Desktop** Settings → Security → Permissions → Enable file transfer
2. **Mobile**
2024-05-14 15:51:09 +02:00
| Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: |
2024-05-19 15:54:24 +02:00
| N | Y, N | Y | `enable-file-transfer=Y` |
2024-05-14 15:51:09 +02:00
2024-05-19 12:54:37 +02:00
### enable-audio
2024-05-14 15:51:09 +02:00
2024-05-19 05:15:34 +02:00
Enable audio record and transfer to peer.
2024-05-14 15:51:09 +02:00
**Location**:
2024-05-21 21:44:33 +02:00
1. **Desktop** Settings → Security → Permissions → Enable audio
2. **Mobile**
2024-05-14 15:51:09 +02:00
| Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: |
2024-05-19 15:54:24 +02:00
| N | Y, N | Y | `enable-audio=Y` |
2024-05-14 15:51:09 +02:00
2024-05-19 12:54:37 +02:00
### enable-tunnel
2024-05-14 15:51:09 +02:00
2024-05-19 05:15:34 +02:00
Enable TCP tunneling.
2024-05-14 15:51:09 +02:00
**Location**:
2024-05-21 21:44:33 +02:00
1. **Desktop** Settings → Security → Permissions → Enable TCP tunneling
2. **Mobile**
2024-05-14 15:51:09 +02:00
| Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: |
2024-05-19 15:54:24 +02:00
| N | Y, N | Y | `enable-tunnel=Y` |
2024-05-14 15:51:09 +02:00
2024-05-19 12:54:37 +02:00
### enable-remote-restart
2024-05-14 15:51:09 +02:00
2024-05-19 05:15:34 +02:00
Enable restarting by the control side.
2024-05-14 15:51:09 +02:00
**Location**:
2024-05-21 21:44:33 +02:00
1. **Desktop** Settings → Security → Permissions → Enable remote restart
2. **Mobile**
2024-05-14 15:51:09 +02:00
| Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: |
2024-05-19 15:54:24 +02:00
| N | Y, N | Y | `enable-remote-restart=Y` |
2024-05-14 15:51:09 +02:00
2024-05-19 12:54:37 +02:00
### enable-record-session
2024-05-14 15:51:09 +02:00
2024-05-19 05:15:34 +02:00
Enable sessions to be recorded.
2024-05-14 15:51:09 +02:00
**Location**:
2024-05-21 21:44:33 +02:00
1. **Desktop** Settings → Security → Permissions → Enable recording session
2. **Mobile** Settings → Share screen → Enable recording session
2024-05-14 15:51:09 +02:00
| Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: |
2024-05-19 15:54:24 +02:00
| N | Y, N | Y | `enable-record-session=Y` |
2024-05-14 15:51:09 +02:00
2024-05-19 12:54:37 +02:00
### enable-block-input
2024-05-14 15:51:09 +02:00
2024-05-19 05:15:34 +02:00
Enable the control side to block other users' input.
2024-05-14 15:51:09 +02:00
**Location**:
2024-05-21 21:44:33 +02:00
1. **Desktop** Settings → Security → Permissions → Enable blocking user input (Windows only)
2. **Mobile**
2024-05-14 15:51:09 +02:00
| Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: |
2024-05-19 15:54:24 +02:00
| N | Y, N | Y | `enable-block-input=Y` |
2024-05-18 15:27:18 +02:00
2024-05-19 12:54:37 +02:00
### allow-remote-config-modification
2024-05-18 15:27:18 +02:00
2024-05-21 21:44:33 +02:00
Allow the control side to change the settings in controlled RustDesk UI.
2024-05-18 15:27:18 +02:00
**Location**:
2024-05-21 21:44:33 +02:00
1. **Desktop** Settings → Security → Permissions → Enable remote configuration modification
2. **Mobile**
2024-05-18 15:27:18 +02:00
| Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: |
2024-05-19 15:54:24 +02:00
| N | Y, N | Y | `allow-remote-config-modification=Y` |
2024-05-18 15:27:18 +02:00
2024-05-19 12:54:37 +02:00
### enable-lan-discovery
2024-05-14 15:51:09 +02:00
2024-05-19 05:15:34 +02:00
Allows LAN peers to discover me.
2024-05-14 15:51:09 +02:00
2024-05-19 05:15:34 +02:00
After LAN discovery, [WOL ](https://en.wikipedia.org/wiki/Wake-on-LAN ) can work if supported locally.
2024-05-14 15:51:09 +02:00
**Location**:
2024-05-21 21:44:33 +02:00
1. **Desktop** Settings → Security → Security → Deny LAN discovery
2. **Mobile** Settings → Share screen → Deny LAN discovery
2024-05-14 15:51:09 +02:00
| Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: |
2024-05-19 15:54:24 +02:00
| Y | Y, N | Y | `enable-lan-discovery=Y` |
2024-05-14 15:51:09 +02:00
2024-05-19 12:54:37 +02:00
### direct-server
2024-05-14 15:51:09 +02:00
2024-05-19 05:15:34 +02:00
Enable direct IP access.
2024-05-14 15:51:09 +02:00
**Location**:
2024-05-21 21:44:33 +02:00
1. **Desktop** Settings → Security → Security → Enable direct IP access
2. **Mobile** Settings → Share screen → Direct IP access
2024-05-14 15:51:09 +02:00
| Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: |
2024-05-19 15:54:24 +02:00
| N | Y, N | N | `direct-server=Y` |
2024-05-14 15:51:09 +02:00
2024-05-19 12:54:37 +02:00
### direct-access-port
2024-05-14 15:51:09 +02:00
2024-05-19 05:15:34 +02:00
Direct IP access port.
2024-05-14 15:51:09 +02:00
**Location**:
2024-05-21 21:44:33 +02:00
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
2024-05-14 15:51:09 +02:00
| Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: |
2024-05-19 05:15:34 +02:00
| N | | 21118 | `direct-access-port=21118` |
2024-05-14 15:51:09 +02:00
2024-05-19 12:54:37 +02:00
### whitelist
2024-05-14 15:51:09 +02:00
2024-05-19 05:15:34 +02:00
Use IP Whitelisting.
2024-05-14 15:51:09 +02:00
**Location**:
2024-05-21 21:44:33 +02:00
1. **Desktop** Settings → Security → Security → Use IP Whitelisting
2. **Mobile** Settings → Share screen → Use IP Whitelisting
2024-05-14 15:51:09 +02:00
| Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: |
2024-05-19 15:58:10 +02:00
| N | `,` or `<ip1>,<ip2>,<ip3>` | `,` means no filter | `whitelist=,` |
2024-05-14 15:51:09 +02:00
2024-05-19 12:54:37 +02:00
### allow-auto-disconnect & auto-disconnect-timeout
2024-05-14 15:51:09 +02:00
2024-05-19 05:15:34 +02:00
Automatically close incoming sessions after a period of user inactivity.
2024-05-14 15:51:09 +02:00
2024-05-19 05:15:34 +02:00
**Location**:
2024-05-21 21:44:33 +02:00
1. **Desktop** Settings → Security → Security → Automatically close incoming sessions on user inactivity
2. **Mobile** Settings → Share screen → Automatically close incoming sessions on user inactivity
2024-05-19 05:15:34 +02:00
| Option | Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: | :------: |
2024-05-19 15:54:24 +02:00
| allow-auto-disconnect | N | Y, N | N | `allow-auto-disconnect=Y` |
2024-05-19 05:15:34 +02:00
| auto-disconnect-timeout | N | Timeout in minutes | 10 | `auto-disconnect-timeout=10` |
2024-05-19 12:54:37 +02:00
### allow-only-conn-window-open
2024-05-19 05:15:34 +02:00
Only allow connection if RustDesk window is open.
2024-05-14 15:51:09 +02:00
**Location**:
2024-05-21 21:44:33 +02:00
1. **Desktop** Settings → Security → Security → Only allow connection if RustDesk window is open
2. **Mobile**
2024-05-14 15:51:09 +02:00
| Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: |
2024-05-19 15:54:24 +02:00
| Y | Y, N | N | `allow-only-conn-window-open=N` |
2024-05-14 15:51:09 +02:00
2024-05-19 12:54:37 +02:00
### approve-mode
2024-05-14 15:51:09 +02:00
2024-05-19 05:15:34 +02:00
Accept incoming connections via password or manually click.
2024-05-14 15:51:09 +02:00
**Location**:
2024-05-21 21:44:33 +02:00
1. **Desktop** Settings → Security → Password → Dropdown box
2. **Mobile** Share screen → Dropdown menu on right-up corner
2024-05-14 15:51:09 +02:00
| Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: |
2024-05-19 15:54:24 +02:00
| N | password, click, password-click | password-click | `approve-mode=password-click` |
2024-05-14 15:51:09 +02:00
2024-05-19 12:54:37 +02:00
### proxy-url
2024-05-19 09:51:39 +02:00
2024-05-21 21:44:33 +02:00
The proxy URL.
2024-05-19 09:51:39 +02:00
Currently support `http` and `socks5` .
**Location**:
2024-05-21 21:44:33 +02:00
1. **Desktop** Settings → Network → Proxy → Socks5/Http(s) proxy
2. **Mobile**
2024-05-19 09:51:39 +02:00
Examples:
1. **http** `proxy-url=http://192.168.0.2:12345`
2024-05-21 21:44:33 +02:00
2. **https** `proxy-url=https://192.168.0.2:12345`
3. **socks5** `proxy-url=socks5://192.168.0.2:1080`
2024-05-19 09:51:39 +02:00
2024-05-19 12:54:37 +02:00
### proxy-username & proxy-password
2024-05-19 09:51:39 +02:00
Proxy username and password.
**Location**:
2024-05-21 21:44:33 +02:00
1. **Desktop** Settings → Network → Proxy → Socks5/Http(s) proxy
2. **Mobile**
2024-05-19 09:51:39 +02:00
2024-05-19 16:31:51 +02:00
| Option | Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: | :------: |
| proxy-username | N | | | `proxy-username=user` |
| proxy-password | N | | | `proxy-password=pass` |
2024-05-19 09:51:39 +02:00
2024-05-19 12:54:37 +02:00
## General Settings
2024-05-14 15:51:09 +02:00
2024-05-19 12:54:37 +02:00
### theme
2024-05-14 15:51:09 +02:00
2024-05-19 05:15:34 +02:00
Controls the UI theme of RustDesk client.
2024-05-14 15:51:09 +02:00
**Location**:
2024-05-21 21:44:33 +02:00
1. **Desktop** Settings → General → Theme
2. **Mobile** Settings → Settings → Theme
2024-05-14 15:51:09 +02:00
| Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: |
2024-05-19 15:54:24 +02:00
| N | dark, light, system | system | `theme=system` |
2024-05-14 15:51:09 +02:00
2024-05-19 12:54:37 +02:00
### lang
2024-05-14 15:51:09 +02:00
2024-05-19 05:15:34 +02:00
Controls the language of RustDesk client.
2024-05-14 15:51:09 +02:00
**Location**:
2024-05-21 21:44:33 +02:00
1. **Desktop** Settings → General → Language
2. **Mobile** Settings → Settings → Language
2024-05-14 15:51:09 +02:00
| Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: |
2024-05-19 15:54:24 +02:00
| N | default, ar, bg, ... | default | `lang=default` |
2024-05-14 15:51:09 +02:00
2024-05-19 05:15:34 +02:00
Currently available languages are:
2024-05-14 15:51:09 +02:00
2024-08-07 12:27:56 +02:00
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
2024-05-14 15:51:09 +02:00
2024-05-19 05:15:34 +02:00
You can check [LANGS ](https://github.com/rustdesk/rustdesk/blob/master/src/lang.rs#L45 ) in the code for the latest language list.
2024-05-14 15:51:09 +02:00
2024-05-19 12:54:37 +02:00
### allow-auto-record-incoming
2024-05-19 05:15:34 +02:00
Automatically record incoming sessions.
2024-05-14 15:51:09 +02:00
**Location**:
2024-05-21 21:44:33 +02:00
1. **Desktop** Settings → General → Recording → Automatically record incoming sessions
2. **Mobile** Settings → Recording → Automatically record incoming sessions
2024-05-14 15:51:09 +02:00
| Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: |
2024-05-19 15:54:24 +02:00
| N | Y, N | N | `allow-auto-record-incoming=N` |
2024-05-14 15:51:09 +02:00
2024-05-19 12:54:37 +02:00
### video-save-directory
2024-05-14 15:51:09 +02:00
2024-05-19 05:15:34 +02:00
The directory to save recorded videos.
2024-05-14 15:51:09 +02:00
**Location**:
2024-05-21 21:44:33 +02:00
1. **Desktop** Settings → General → Recording → Video save directory
2. **Mobile** Settings → Recording
2024-05-14 15:51:09 +02:00
2024-05-19 05:15:34 +02:00
Default values:
2024-05-14 15:51:09 +02:00
2024-07-20 22:42:01 +02:00
1. **macOS** ~/Movies/**app_name**
2024-05-21 21:44:33 +02:00
2. **Linux** ~/Videos/**app_name**
3. **Windows** %USERPROFILE%\Videos\\**app_name**
4. **Android** /Storage/emulated/0/**app_name**/ScreenRecord
2024-05-14 15:51:09 +02:00
2024-05-21 21:44:33 +02:00
**Note**: Replace **app_name** means current app name.
2024-05-14 15:51:09 +02:00
2024-05-19 12:54:37 +02:00
### enable-confirm-closing-tabs
2024-05-19 05:15:34 +02:00
Controls whether to show a confirm dialog before closing all remote tabs.
2024-05-14 15:51:09 +02:00
**Location**:
2024-05-21 21:44:33 +02:00
1. **Desktop** Settings → General → Other → Confirm before closing multiple tabs
2. **Mobile**
2024-05-14 15:51:09 +02:00
| Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: |
2024-05-19 15:54:24 +02:00
| N | Y, N | Y | `enable-confirm-closing-tabs=Y` |
2024-05-14 15:51:09 +02:00
2024-05-19 12:54:37 +02:00
### enable-abr
2024-05-14 15:51:09 +02:00
2024-05-19 05:15:34 +02:00
Enable adaptive bitrate.
2024-05-14 15:51:09 +02:00
**Location**:
2024-05-21 21:44:33 +02:00
1. **Desktop** Settings → General → Other → Adaptive bitrate
2. **Mobile** Settings → Share screen → Adaptive bitrate (beta)
2024-05-14 15:51:09 +02:00
| Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: |
2024-05-19 15:54:24 +02:00
| N | Y, N | Y | `enable-abr=Y` |
2024-05-14 15:51:09 +02:00
2024-05-19 12:54:37 +02:00
### allow-remove-wallpaper
2024-05-14 15:51:09 +02:00
2024-05-19 05:15:34 +02:00
Remove wallpaper during incoming sessions.
2024-05-14 15:51:09 +02:00
**Location**:
2024-05-21 21:44:33 +02:00
1. **Desktop** Settings → General → Other → Remove wallpaper during incoming sessions
2. **Mobile**
2024-05-14 15:51:09 +02:00
| Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: |
2024-05-19 15:54:24 +02:00
| N | Y, N | N | `allow-remove-wallpaper=N` |
2024-05-14 15:51:09 +02:00
2024-05-19 12:54:37 +02:00
### enable-open-new-connections-in-tabs
2024-05-14 15:51:09 +02:00
2024-05-19 05:15:34 +02:00
Controls whether to use a new tab or a new window to open a new connection.
2024-05-14 15:51:09 +02:00
**Location**:
2024-05-21 21:44:33 +02:00
1. **Desktop** Settings → General → Other → Open connection in new tab
2. **Mobile**
2024-05-14 15:51:09 +02:00
| Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: |
2024-05-19 15:54:24 +02:00
| N | Y, N | Y | `enable-open-new-connections-in-tabs=Y` |
2024-05-14 15:51:09 +02:00
2024-05-19 12:54:37 +02:00
### allow-always-software-render
2024-05-14 15:51:09 +02:00
2024-05-19 05:15:34 +02:00
Always use software rendering.
2024-05-14 15:51:09 +02:00
**Location**:
2024-05-21 21:44:33 +02:00
1. **Desktop** Settings → General → Other → Always use software rendering
2. **Mobile**
2024-05-14 15:51:09 +02:00
| Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: |
2024-05-19 15:54:24 +02:00
| N | Y, N | N | `allow-always-software-render=N` |
2024-05-14 15:51:09 +02:00
2024-05-19 12:54:37 +02:00
### allow-linux-headless
2024-05-14 15:51:09 +02:00
2024-05-19 05:15:34 +02:00
Allow incoming connection if there's no displays.
2024-05-21 21:44:33 +02:00
This option requires desktop environment, Xorg server and GDM, see [PR 3902 ](https://github.com/rustdesk/rustdesk/pull/3902 ).
2024-05-14 15:51:09 +02:00
**Location**:
2024-05-21 21:44:33 +02:00
1. **Desktop** Settings → General → Other → Allow Linux headless
2. **Mobile**
2024-05-14 15:51:09 +02:00
| Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: |
2024-05-19 15:54:24 +02:00
| Y | Y, N | N | `allow-linux-headless=N` |
2024-05-14 15:51:09 +02:00
2024-05-19 12:54:37 +02:00
### enable-hwcodec
2024-05-14 15:51:09 +02:00
2024-05-19 05:15:34 +02:00
Enable hardware encoding to make the picture smoother.
2024-05-14 15:51:09 +02:00
2024-05-19 05:15:34 +02:00
**Location**:
2024-05-14 15:51:09 +02:00
2024-05-19 05:15:34 +02:00
1. **Desktop**
2024-05-21 21:44:33 +02:00
2. **Mobile** Settings → Hardware codec
2024-05-14 15:51:09 +02:00
2024-05-19 05:15:34 +02:00
| Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: |
2024-05-19 15:54:24 +02:00
| N | Y, N | Y | `enable-hwcodec=Y` |
2024-05-19 05:15:34 +02:00
2024-05-19 12:54:37 +02:00
### peer-card-ui-type
2024-05-19 05:15:34 +02:00
Controls the view of peer cards, includes "Big tiles", "Small tiles" and "List".
2024-05-14 15:51:09 +02:00
**Location**:
2024-05-21 21:44:33 +02:00
1. **Desktop** Home → Peer panel → Right top grid icon
2. **Mobile**
2024-05-14 15:51:09 +02:00
| Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: |
2024-05-19 15:54:24 +02:00
| N | 0, 1, 2 | 0 | `peer-card-ui-type=0` |
2024-05-14 15:51:09 +02:00
2024-05-19 16:31:51 +02:00
**0** Big tiles
**1** Small tiles
2024-05-19 05:15:34 +02:00
**2** List
2024-05-14 15:51:09 +02:00
2024-05-19 12:54:37 +02:00
### peer-sorting
2024-05-19 05:15:34 +02:00
Controls the ordering of peer cards.
2024-05-14 15:51:09 +02:00
**Location**:
2024-05-21 21:44:33 +02:00
1. **Desktop** Home → Peer panel → Right top sort icon
2. **Mobile**
2024-05-14 15:51:09 +02:00
| Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: |
2024-05-19 15:54:24 +02:00
| N | Remote ID, Remote Host, Username | Remote ID | `peer-sorting=Remote ID` |
2024-05-14 15:51:09 +02:00
2024-05-19 12:54:37 +02:00
### sync-ab-with-recent-sessions
2024-05-14 15:51:09 +02:00
Controls whether to sync the address book with recent sessions.
**Location**:
2024-05-21 21:44:33 +02:00
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
2024-05-14 15:51:09 +02:00
| Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: |
2024-05-19 15:54:24 +02:00
| N | Y, N | N | `sync-ab-with-recent-sessions=N` |
2024-05-14 15:51:09 +02:00
2024-05-19 12:54:37 +02:00
### sync-ab-tags
2024-05-14 15:51:09 +02:00
Controls whether to sort the address book tags.
**Location**:
2024-05-21 21:44:33 +02:00
1. **Desktop** Home → Peer panel → Address book → Tags → Dropdown menu → Sort tags
2. **Mobile** Home → Peer panel → Address book → Tags → Dropdown menu → Sort tags
2024-05-14 15:51:09 +02:00
| Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: |
2024-05-19 15:54:24 +02:00
| N | Y, N | N | `sync-ab-tags=N` |
2024-05-14 15:51:09 +02:00
2024-05-19 12:54:37 +02:00
### filter-ab-by-intersection
2024-05-14 15:51:09 +02:00
Filter address book by tag intersection.
**Preview**: [PR #5985 ](https://github.com/rustdesk/rustdesk/pull/5985 )
**Location**:
2024-05-21 21:44:33 +02:00
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
2024-05-14 15:51:09 +02:00
| Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: |
2024-05-19 15:54:24 +02:00
| N | Y, N | N | `filter-ab-by-intersection=N` |
2024-05-14 15:51:09 +02:00
2024-05-19 12:54:37 +02:00
## Display Settings
2024-05-14 15:51:09 +02:00
2024-05-19 12:54:37 +02:00
### view-only
2024-05-19 05:15:34 +02:00
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.
2024-05-14 15:51:09 +02:00
**Location**:
2024-05-21 21:44:33 +02:00
1. **Desktop** Settings → Display → Other default options → View mode
2. **Mobile** Settings → Display settings → Other default options → View mode
2024-05-14 15:51:09 +02:00
| Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: |
2024-05-19 15:54:24 +02:00
| N | Y, N | N | `view-only=Y` |
2024-05-14 15:51:09 +02:00
2024-05-19 12:54:37 +02:00
### show-monitors-toolbar
2024-05-14 15:51:09 +02:00
2024-05-19 05:15:34 +02:00
Controls whether to show monitors in toolbar.
![show-monitors-toolbar ](/docs/en/self-host/client-configuration/advanced-settings/images/show-monitors-toolbar.png )
2024-05-14 15:51:09 +02:00
**Location**:
2024-05-21 21:44:33 +02:00
1. **Desktop** Settings → Display → Other default options → Show monitors toolbar
2. **Mobile**
2024-05-14 15:51:09 +02:00
| Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: |
2024-05-19 15:54:24 +02:00
| N | Y, N | N | `show-monitors-toolbar=Y` |
2024-05-14 15:51:09 +02:00
2024-05-19 12:54:37 +02:00
### collapse-toolbar
2024-05-14 15:51:09 +02:00
2024-05-19 05:15:34 +02:00
Controls whether the remote toolbar is collapsed after connecting.
2024-05-14 15:51:09 +02:00
**Location**:
2024-05-21 21:44:33 +02:00
1. **Desktop** Settings → Display → Other default options → Collapse toolbar
2. **Mobile**
2024-05-14 15:51:09 +02:00
| Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: |
2024-05-19 15:54:24 +02:00
| N | Y, N | N | `collapse-toolbar=Y` |
2024-05-14 15:51:09 +02:00
2024-05-19 12:54:37 +02:00
### show-remote-cursor
2024-05-14 15:51:09 +02:00
2024-05-19 05:15:34 +02:00
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.
2024-05-14 15:51:09 +02:00
**Location**:
2024-05-21 21:44:33 +02:00
1. **Desktop** Settings → Display → Other default options → Show remote cursor
2. **Mobile** Settings → Display settings → Other default options → Show remote cursor
2024-05-14 15:51:09 +02:00
| Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: |
2024-05-19 15:54:24 +02:00
| N | Y, N | N | `show-remote-cursor=N` |
2024-05-14 15:51:09 +02:00
2024-05-19 12:54:37 +02:00
### follow-remote-cursor
2024-05-14 15:51:09 +02:00
2024-05-19 05:15:34 +02:00
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.
2024-07-20 22:42:01 +02:00
**Preview**: [PR 7717 ](https://github.com/rustdesk/rustdesk/pull/7717 )
2024-05-14 15:51:09 +02:00
**Location**:
2024-05-21 21:44:33 +02:00
1. **Desktop** Settings → Display → Other default options → Follow remote cursor
2. **Mobile** Settings → Display settings → Other default options → Follow remote cursor
2024-05-14 15:51:09 +02:00
| Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: |
2024-05-19 15:54:24 +02:00
| N | Y, N | N | `follow-remote-cursor=Y` |
2024-05-14 15:51:09 +02:00
2024-05-19 12:54:37 +02:00
### follow-remote-window
2024-05-14 15:51:09 +02:00
2024-05-19 05:15:34 +02:00
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.
2024-07-20 22:42:01 +02:00
**Preview**: [PR 7717 ](https://github.com/rustdesk/rustdesk/pull/7717 )
2024-05-14 15:51:09 +02:00
**Location**:
2024-05-21 21:44:33 +02:00
1. **Desktop** Settings → Display → Other default options → Follow remote window focus
2. **Mobile** Settings → Display settings → Other default options → Follow remote window focus
2024-05-14 15:51:09 +02:00
| Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: |
2024-05-19 15:54:24 +02:00
| N | Y, N | N | `follow-remote-window=Y` |
2024-05-14 15:51:09 +02:00
2024-05-19 12:54:37 +02:00
### zoom-cursor
2024-05-14 15:51:09 +02:00
2024-05-19 05:15:34 +02:00
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.
2024-05-14 15:51:09 +02:00
**Location**:
2024-05-21 21:44:33 +02:00
1. **Desktop** Settings → Display → Other default options → Zoom cursor
2. **Mobile**
2024-05-14 15:51:09 +02:00
| Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: |
2024-05-19 15:54:24 +02:00
| N | Y, N | N | `zoom-cursor=Y` |
2024-05-14 15:51:09 +02:00
2024-05-19 12:54:37 +02:00
### show-quality-monitor
2024-05-14 15:51:09 +02:00
2024-05-19 05:15:34 +02:00
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.
2024-05-14 15:51:09 +02:00
**Location**:
2024-05-21 21:44:33 +02:00
1. **Desktop** Settings → Display → Other default options → Show quality monitor
2. **Mobile** Settings → Display settings → Other default options → Show quality monitor
2024-05-14 15:51:09 +02:00
| Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: |
2024-05-19 15:54:24 +02:00
| N | Y, N | N | `show-quality-monitor=Y` |
2024-05-14 15:51:09 +02:00
2024-05-19 12:54:37 +02:00
### disable-audio
2024-05-14 15:51:09 +02:00
2024-05-19 05:15:34 +02:00
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.
2024-05-14 15:51:09 +02:00
**Location**:
2024-05-21 21:44:33 +02:00
1. **Desktop** Settings → Display → Other default options → Mute
2. **Mobile** Settings → Display settings → Other default options → Mute
2024-05-14 15:51:09 +02:00
| Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: |
2024-05-19 15:54:24 +02:00
| N | Y, N | N | `disable-audio=Y` |
2024-05-14 15:51:09 +02:00
2024-05-19 12:54:37 +02:00
### enable-file-copy-paste
2024-05-14 15:51:09 +02:00
2024-05-19 05:15:34 +02:00
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.
2024-05-14 15:51:09 +02:00
**Location**:
2024-05-21 21:44:33 +02:00
1. **Desktop** Settings → Display → Other default options → Enable file copy and paste (Windows only)
2. **Mobile**
2024-05-14 15:51:09 +02:00
| Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: |
2024-05-19 15:54:24 +02:00
| N | Y, N | N | `enable-file-copy-paste=Y` |
2024-05-14 15:51:09 +02:00
2024-05-19 12:54:37 +02:00
### disable-clipboard
2024-05-14 15:51:09 +02:00
2024-05-19 05:15:34 +02:00
This option will set the "disable-clipboard" option for every peer after the first connection.
2024-05-14 15:51:09 +02:00
2024-05-19 05:15:34 +02:00
The "disable-clipboard" option in each peer's settings will then control whether to enable text copy and paste.
2024-05-14 15:51:09 +02:00
**Location**:
2024-05-21 21:44:33 +02:00
1. **Desktop** Settings → Display → Other default options → Disable clipboard
2. **Mobile** Settings → Display settings → Other default options → Disable clipboard
2024-05-14 15:51:09 +02:00
| Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: |
2024-05-19 15:54:24 +02:00
| N | Y, N | N | `disable-clipboard=Y` |
2024-05-14 15:51:09 +02:00
2024-05-19 12:54:37 +02:00
### lock-after-session-end
2024-05-14 15:51:09 +02:00
2024-05-19 05:15:34 +02:00
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.
2024-05-14 15:51:09 +02:00
**Location**:
2024-05-21 21:44:33 +02:00
1. **Desktop** Settings → Display → Other default options → Lock after session end
2. **Mobile** Settings → Display settings → Other default options → Lock after session end
2024-05-14 15:51:09 +02:00
| Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: |
2024-05-19 15:54:24 +02:00
| N | Y, N | N | `lock-after-session-end=Y` |
2024-05-14 15:51:09 +02:00
2024-05-19 12:54:37 +02:00
### privacy-mode
2024-05-14 15:51:09 +02:00
2024-05-19 05:15:34 +02:00
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.
2024-05-14 15:51:09 +02:00
**Location**:
2024-05-21 21:44:33 +02:00
1. **Desktop** Settings → Display → Other default options → Privacy mode
2. **Mobile** Settings → Display settings → Other default options → Privacy mode
2024-05-14 15:51:09 +02:00
| Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: |
2024-05-19 15:54:24 +02:00
| N | Y, N | N | `privacy-mode=Y` |
2024-05-14 15:51:09 +02:00
2024-05-19 12:54:37 +02:00
### touch-mode
2024-05-14 15:51:09 +02:00
2024-05-19 05:15:34 +02:00
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.
2024-05-14 15:51:09 +02:00
**Location**:
2024-05-19 05:15:34 +02:00
1. **Desktop**
2024-05-21 21:44:33 +02:00
2. **Mobile** Settings → Display settings → Other default options → Touch mode
2024-05-14 15:51:09 +02:00
| Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: |
2024-05-19 15:54:24 +02:00
| N | Y, N | N | `touch-mode=Y` |
2024-05-14 15:51:09 +02:00
2024-05-19 12:54:37 +02:00
### i444
2024-05-14 15:51:09 +02:00
2024-05-19 05:15:34 +02:00
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.
2024-05-14 15:51:09 +02:00
**Location**:
2024-05-21 21:44:33 +02:00
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)
2024-05-14 15:51:09 +02:00
2024-05-19 05:15:34 +02:00
| Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: |
2024-05-19 15:54:24 +02:00
| N | Y, N | N | `i444=Y` |
2024-05-14 15:51:09 +02:00
2024-05-19 12:54:37 +02:00
### reverse-mouse-wheel
2024-05-14 15:51:09 +02:00
2024-05-19 05:15:34 +02:00
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.
2024-05-14 15:51:09 +02:00
**Location**:
2024-05-21 21:44:33 +02:00
1. **Desktop** Settings → Display → Other default options → Reverse mouse wheel
2. **Mobile** Settings → Display settings → Other default options → Reverse mouse wheel
2024-05-14 15:51:09 +02:00
| Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: |
2024-05-19 15:54:24 +02:00
| N | Y, N | N | `reverse-mouse-wheel=Y` |
2024-05-14 15:51:09 +02:00
2024-05-19 12:54:37 +02:00
### swap-left-right-mouse
2024-05-14 15:51:09 +02:00
2024-05-19 05:15:34 +02:00
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.
2024-05-14 15:51:09 +02:00
**Location**:
2024-05-21 21:44:33 +02:00
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
2024-05-14 15:51:09 +02:00
| Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: |
2024-05-19 15:54:24 +02:00
| N | Y, N | N | `swap-left-right-mouse=Y` |
2024-05-14 15:51:09 +02:00
2024-05-19 12:54:37 +02:00
### displays-as-individual-windows
2024-05-14 15:51:09 +02:00
2024-05-19 05:15:34 +02:00
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.
2024-07-20 22:42:01 +02:00
**Preview**: [PR 5945 ](https://github.com/rustdesk/rustdesk/pull/5945 )
2024-05-14 15:51:09 +02:00
**Location**:
2024-05-21 21:44:33 +02:00
1. **Desktop** Settings → Display → Other default options → Show displays as individual windows
2. **Mobile**
2024-05-14 15:51:09 +02:00
2024-05-19 05:15:34 +02:00
| Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: |
2024-05-19 15:54:24 +02:00
| N | Y, N | N | `displays-as-individual-windows=Y` |
2024-05-14 15:51:09 +02:00
2024-05-19 12:54:37 +02:00
### use-all-my-displays-for-the-remote_session
2024-05-14 15:51:09 +02:00
2024-05-19 05:15:34 +02:00
This option will set the "use-all-my-displays-for-the-remote_session" option for every peer after the first connection.
2024-05-14 15:51:09 +02:00
2024-05-19 05:15:34 +02:00
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.
2024-05-14 15:51:09 +02:00
2024-07-20 22:42:01 +02:00
**Preview**: [PR 6064 ](https://github.com/rustdesk/rustdesk/pull/6064 )
2024-05-14 15:51:09 +02:00
**Location**:
2024-05-21 21:44:33 +02:00
1. **Desktop** Settings → Display → Other default options → Use all my displays for the remote session
2. **Mobile**
2024-05-14 15:51:09 +02:00
| Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: |
2024-05-19 15:54:24 +02:00
| N | Y, N | N | `use-all-my-displays-for-the-remote_session=Y` |
2024-05-14 15:51:09 +02:00
2024-05-19 12:54:37 +02:00
### view-style
2024-05-14 15:51:09 +02:00
2024-05-19 05:15:34 +02:00
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.
2024-05-14 15:51:09 +02:00
**Location**:
2024-05-21 21:44:33 +02:00
1. **Desktop** Settings → Display → Default view style
2. **Mobile** Settings → Display settings → Default view style
2024-05-14 15:51:09 +02:00
| Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: |
2024-05-19 15:54:24 +02:00
| N | original, adaptive | original | `view-style=original` |
2024-05-14 15:51:09 +02:00
2024-05-19 12:54:37 +02:00
### scroll-style
2024-05-14 15:51:09 +02:00
2024-05-19 05:15:34 +02:00
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.
2024-05-14 15:51:09 +02:00
**Location**:
2024-05-21 21:44:33 +02:00
1. **Desktop** Settings → Display → Default scroll style
2. **Mobile**
2024-05-14 15:51:09 +02:00
| Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: |
2024-05-19 15:54:24 +02:00
| N | scrollauto, scrollbar | scrollauto | `scroll-style=scrollauto` |
2024-05-14 15:51:09 +02:00
2024-05-19 12:54:37 +02:00
### image-quality
2024-05-14 15:51:09 +02:00
2024-05-19 05:15:34 +02:00
This option will set the "image-quality" option for every peer after the first connection.
2024-05-14 15:51:09 +02:00
2024-05-19 05:15:34 +02:00
The "image-quality" option in each peer's settings will then control the image quality.
2024-05-14 15:51:09 +02:00
**Location**:
2024-05-21 21:44:33 +02:00
1. **Desktop** Settings → Display → Default image quality
2. **Mobile** Settings → Display settings → Default image quality
2024-05-14 15:51:09 +02:00
| Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: |
2024-05-19 15:54:24 +02:00
| N | best, balanced, low, custom | balanced | `image-quality=balanced` |
2024-05-14 15:51:09 +02:00
2024-05-19 12:54:37 +02:00
### custom-image-quality
2024-05-14 15:51:09 +02:00
2024-05-19 05:15:34 +02:00
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.
2024-05-14 15:51:09 +02:00
**Location**:
2024-05-21 21:44:33 +02:00
1. **Desktop** Settings → Display → Default image quality → Custom
2. **Mobile** Settings → Display settings → Default image quality → Custom
2024-05-14 15:51:09 +02:00
| Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: |
2024-05-19 05:15:34 +02:00
| N | [10.0, 2000.0] | 50.0 | `custom-image-quality=50` |
2024-05-14 15:51:09 +02:00
2024-05-19 12:54:37 +02:00
### custom-fps
2024-05-14 15:51:09 +02:00
2024-05-19 05:15:34 +02:00
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.
2024-05-14 15:51:09 +02:00
**Location**:
2024-05-21 21:44:33 +02:00
1. **Desktop** Settings → Display → Default image quality → Custom
2. **Mobile** Settings → Display settings → Default image quality → Custom
2024-05-14 15:51:09 +02:00
| Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: |
2024-05-19 15:54:24 +02:00
| N | [5, 120] | 30 | `custom-fps=30` |
2024-05-19 05:15:34 +02:00
2024-05-19 12:54:37 +02:00
### codec-preference
2024-05-19 05:15:34 +02:00
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**:
2024-05-21 21:44:33 +02:00
1. **Desktop** Settings → Display → Default codec
2. **Mobile** Settings → Display settings → Default codec
2024-05-19 05:15:34 +02:00
| Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: |
2024-05-19 15:54:24 +02:00
| N | auto, vp8, vp9, av1, h264, h265 | auto | `codec-preference=auto` |
2024-05-19 05:15:34 +02:00
2024-07-20 22:42:01 +02:00
**Caution**: Options other than "vp8" and "vp9" may not work. This depends on what your machine supports.
2024-05-30 11:22:47 +02:00
### 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.
| Option | Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: | :------: |
2024-05-31 02:48:09 +02:00
| preset-address-book-name | N | | | `preset-address-book-name=<address book name>` |
| preset-address-book-tag | N | | | `preset-address-book-tag=<address book tag name>` |
2024-05-30 11:22:47 +02:00
### disable-group-panel
2024-07-20 22:42:01 +02:00
Disable group panel (next to address book panel) on RustDesk client, https://github.com/rustdesk/rustdesk-server-pro/issues/250.
2024-05-30 11:22:47 +02:00
| Option | Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: | :------: |
| disable-group-panel | N | Y, N | N | `disable-group-panel=Y` |
### pre-elevate-service
2024-07-20 22:42:01 +02:00
Automatic elevation on run for Windows portable, https://github.com/rustdesk/rustdesk-server-pro/issues/252.
2024-05-30 11:22:47 +02:00
| Option | Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: | :------: |
| pre-elevate-service | N | Y, N | N | `pre-elevate-service=Y` |
2024-06-05 06:56:46 +02:00
### disable-floating-window
When the Android service starts, it will display a floating window, which helps prevent the system from killing the RustDesk service.
| Values | Default | Example |
| :------: | :------: | :------: |
| Y, N | N | `disable-floating-window=Y` |
### 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.
| Values | Default | Example |
| :------: | :------: | :------: |
| [32, 320] | 120 | `floating-window-size=120` |
### 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.
| Values | Default | Example |
| :------: | :------: | :------: |
2024-06-07 05:13:03 +02:00
| Y, N | N | `floating-window-untouchable=Y` |
2024-06-05 06:56:46 +02:00
### 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.
| Values | Default | Example |
| :------: | :------: | :------: |
| [0, 10] | 10 | `floating-window-transparency=5` |
### floating-window-svg
If an icon is not set for the Android floating window, it will default to displaying the RustDesk icon.
2024-07-20 22:42:01 +02:00
When setting, please write the text content of SVG into one line, and pay attention to the [SVG support limitations ](https://bigbadaboom.github.io/androidsvg/index.html ).
2024-06-05 06:56:46 +02:00
| Default | Example |
| :------: | :------: |
2024-06-13 11:30:18 +02:00
| RustDesk icon | `floating-window-svg=<?xml version="1.0" standalone="no"?><!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd"><svg t="1717559129252" class="icon" viewBox="0 0 1024 1024" version="1.1" xmlns="http://www.w3.org/2000/svg" p-id="4248" xmlns:xlink="http://www.w3.org/1999/xlink" width="32" height="32"><path d="M950.857143 512c0 242.285714-196.571429 438.857143-438.857143 438.857143S73.142857 754.285714 73.142857 512 269.714286 73.142857 512 73.142857s438.857143 196.571429 438.857143 438.857143z" fill="#1296db" p-id="4249"></path></svg>` |
### keep-screen-on
This is for the Android controlled side. Note that keeping the screen on depends on the floating window.
| Values | Default | Example |
| :------: | :------: | :------: |
2024-06-21 10:59:18 +02:00
| never, during-controlled, service-on | during-controlled | `keep-screen-on=never` |
### 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.
| Values | Default | Example |
| :------: | :------: | :------: |
| Y, N | Y | `enable-directx-capture=N` |
2024-06-21 05:21:36 +02:00
### enable-android-software-encoding-half-scale
2024-06-21 10:59:18 +02:00
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.
| Values | Default | Example |
| :------: | :------: | :------: |
2024-06-21 05:21:36 +02:00
| Y, N | Y | `enable-android-software-encoding-half-scale=N` |
2024-07-09 09:01:06 +02:00
### allow-remote-cm-modification
2024-07-20 22:42:01 +02:00
Controls whether to allow the control side to click on the connection management window to accept connections, change permissions, etc.
2024-07-09 09:01:06 +02:00
2024-07-09 09:11:27 +02:00
https://github.com/rustdesk/rustdesk/issues/7425
2024-07-09 09:01:06 +02:00
| Values | Default | Example |
| :------: | :------: | :------: |
2024-07-09 09:11:27 +02:00
| Y, N | N | `allow-remote-cm-modification=Y` |
2024-07-18 12:13:07 +02:00
### remove-preset-password-warning
2024-07-20 22:42:01 +02:00
Controls whether to remove the security warning on GUI when there is preset password in custom client.
2024-07-18 12:13:07 +02:00
https://github.com/rustdesk/rustdesk-server-pro/discussions/286
2024-07-18 19:12:42 +02:00
https://github.com/rustdesk/rustdesk/discussions/7956
2024-07-18 12:13:07 +02:00
| Values | Default | Example |
| :------: | :------: | :------: |
| Y, N | Y | `remove-preset-password-warning=Y` |
### hide-security-settings / hide-network-settings / hide-server-settings / hide-proxy-settings
2024-07-20 22:42:01 +02:00
Controls whether to hide some settings. Please ensure `Disable settings` is turned off, otherwise these won't work.
2024-07-18 12:13:07 +02:00
https://github.com/rustdesk/rustdesk-server-pro/issues/263
https://github.com/rustdesk/rustdesk-server-pro/issues/276
| Values | Default | Example |
| :------: | :------: | :------: |
| Y, N | N | `hide-security-settings=Y` |
### hide-username-on-card
2024-07-20 22:42:01 +02:00
Controls whether to show username in the list of devices. Because sometimes, the username is too long, will hide the other info.
2024-07-18 12:13:07 +02:00
https://github.com/rustdesk/rustdesk-server-pro/issues/284#issuecomment-2216521407
| Values | Default | Example |
| :------: | :------: | :------: |
| Y, N | N | `hide-username-on-card=Y` |
### hide-help-cards
2024-07-20 22:42:01 +02:00
Controls whether to show UAC / permission warnings on GUI.
2024-07-18 12:13:07 +02:00
https://github.com/rustdesk/rustdesk/issues/8687
| Values | Default | Example |
| :------: | :------: | :------: |
| Y, N | N | `hide-help-cards=Y` |
### 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
2024-07-20 22:42:01 +02:00
Controls whether to use TCP only. It will not use UDP 21116 any more, TCP 21116 will be used instead.
2024-07-18 12:13:07 +02:00
| Values | Default | Example |
| :------: | :------: | :------: |
| Y, N | N | `disable-udp=Y` |
2024-07-18 16:32:30 +02:00
### preset-user-name / preset-strategy-name
2024-07-18 12:13:07 +02:00
2024-07-20 22:42:01 +02:00
Assign user / strategy to device. You can also do this via [command line ](https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/console/#assign-device-usersgroupsstrategies-to-devices ).
2024-07-18 12:14:04 +02:00
2024-07-18 12:13:07 +02:00
https://github.com/rustdesk/rustdesk-server-pro/discussions/304
2024-07-23 05:02:53 +02:00
### default-connect-password
Default password used to connect to remote devices, this password has lower priority than address book password and local saved password.
2024-07-23 13:44:29 +02:00
e.g. `default-connect-password=abcd1234`
2024-08-12 10:56:55 +02:00
### enable-trusted-devices
Allow trusted devices to skip 2FA verification.
https://github.com/rustdesk/rustdesk/discussions/8513#discussioncomment-10234494
| Values | Default | Example |
| :------: | :------: | :------: |
| Y, N | Y | `enable-trusted-devices=N` |