一共有 4 中类型的设置项:
这些设置的优先级是:覆盖 > 策略 > 用户 > 默认
。
设置传入连接的访问模式(权限)。
位置:
是否需要安装 | 可设值 | 默认值 | 示例 |
---|---|---|---|
N | custom, full, view | custom | access-mode=custom |
允许传入连接控制键盘/鼠标。
位置:
是否需要安装 | 可设值 | 默认值 | 示例 |
---|---|---|---|
N | Y, N | Y | enable-keyboard=Y |
允许使用粘贴板。
位置:
是否需要安装 | 可设值 | 默认值 | 示例 |
---|---|---|---|
N | Y, N | Y | enable-clipboard=Y |
允许文件复制和粘贴或文件传输(会话)。
位置:
是否需要安装 | 可设值 | 默认值 | 示例 |
---|---|---|---|
N | Y, N | Y | enable-file-transfer=Y |
允许音频录制并传输给控制端。
位置:
是否需要安装 | 可设值 | 默认值 | 示例 |
---|---|---|---|
N | Y, N | Y | enable-audio=Y |
允许建立 TCP 隧道。
位置:
是否需要安装 | 可设值 | 默认值 | 示例 |
---|---|---|---|
N | Y, N | Y | enable-tunnel=Y |
允许远程重启。
位置:
是否需要安装 | 可设值 | 默认值 | 示例 |
---|---|---|---|
N | Y, N | Y | enable-remote-restart=Y |
允许录制会话。
位置:
是否需要安装 | 可设值 | 默认值 | 示例 |
---|---|---|---|
N | Y, N | Y | enable-record-session=Y |
允许控制端阻止其他用户的输入。
位置:
是否需要安装 | 可设值 | 默认值 | 示例 |
---|---|---|---|
N | Y, N | Y | enable-block-input=Y |
允许控制方更改受控 RustDesk UI 中的设置。
位置:
是否需要安装 | 可设值 | 默认值 | 示例 |
---|---|---|---|
N | Y, N | Y | allow-remote-config-modification=Y |
允许局域网发现。
局域网法相后, 如果支持 WOL , 则可使用 WOL 。
位置:
是否需要安装 | 可设值 | 默认值 | 示例 |
---|---|---|---|
Y | Y, N | Y | enable-lan-discovery=Y |
允许 IP 直接访问。
位置:
是否需要安装 | 可设值 | 默认值 | 示例 |
---|---|---|---|
N | Y, N | N | direct-server=Y |
IP 直接访问的端口。
位置:
是否需要安装 | 可设值 | 默认值 | 示例 |
---|---|---|---|
N | 21118 | direct-access-port=21118 |
只允许白名单上的 IP 访问。
位置:
是否需要安装 | 可设值 | 默认值 | 示例 |
---|---|---|---|
N | , 或者 <ip1>,<ip2>,<ip3> | , 表示不过滤 | whitelist=, |
用户不活动一段时间后自动关闭会话。
位置:
设置项 | 是否需要安装 | 可设值 | 默认值 | 示例 |
---|---|---|---|---|
allow-auto-disconnect | N | Y, N | N | allow-auto-disconnect=Y |
auto-disconnect-timeout | N | 按分钟计的超时时间 | 10 | auto-disconnect-timeout=10 |
仅当 RustDesk 窗口打开时才允许连接。
位置:
是否需要安装 | 可设值 | 默认值 | 示例 |
---|---|---|---|
Y | Y, N | N | allow-only-conn-window-open=N |
通过密码或手动单击接受传入连接。
位置:
是否需要安装 | 可设值 | 默认值 | 示例 |
---|---|---|---|
N | password, click, password-click | password-click | approve-mode=password-click |
代理的 url 。
目前支持 http
和 socks5
。
位置:
示例:
proxy-url=http://192.168.0.2:12345
proxy-url=https://192.168.0.2:12345
proxy-url=socks5://192.168.0.2:1080
代理的 用户名 和 密码。
位置:
设置项 | 是否需要安装 | 可设值 | 默认值 | 示例 |
---|---|---|---|---|
proxy-username | N | proxy-username=user | ||
proxy-password | N | proxy-password=pass |
控制 RustDesk 客户端的 UI 主题。
位置:
是否需要安装 | 可设值 | 默认值 | 示例 |
---|---|---|---|
N | dark, light, system | system | theme=system |
控制 RustDesk 客户端的语言。
位置:
是否需要安装 | 可设值 | 默认值 | 示例 |
---|---|---|---|
N | default, ar, bg, … | default | lang=default |
当前可用的语言有:
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
您可以查看代码中的 LANGS 获取最新的语言列表。
自动录制来访会话。
位置:
是否需要安装 | 可设值 | 默认值 | 示例 |
---|---|---|---|
N | Y, N | N | allow-auto-record-incoming=N |
保存录制的视频的目录。
位置:
默认值:
Note: app_name 代表当前的 app 名。
控制在关闭所有远程选项卡之前是否显示确认对话框。
位置:
是否需要安装 | 可设值 | 默认值 | 示例 |
---|---|---|---|
N | Y, N | Y | enable-confirm-closing-tabs=Y |
启用自适应码率。
位置:
是否需要安装 | 可设值 | 默认值 | 示例 |
---|---|---|---|
N | Y, N | Y | enable-abr=Y |
接受会话时移除桌面壁纸。
位置:
是否需要安装 | 可设值 | 默认值 | 示例 |
---|---|---|---|
N | Y, N | N | allow-remove-wallpaper=N |
控制是否使用新选项卡或新窗口来打开新连接。
位置:
是否需要安装 | 可设值 | 默认值 | 示例 |
---|---|---|---|
N | Y, N | Y | enable-open-new-connections-in-tabs=Y |
始终使用软渲染。
位置:
是否需要安装 | 可设值 | 默认值 | 示例 |
---|---|---|---|
N | Y, N | N | allow-always-software-render=N |
在没有显示器的时候, 允许传入会话。
启用次选项, 需要桌面环境, xorg 服务 和 gdm, 参考 PR 3902.
位置:
是否需要安装 | 可设值 | 默认值 | 示例 |
---|---|---|---|
Y | Y, N | N | allow-linux-headless=N |
启用硬件编码, 使画面更加流畅。
位置:
是否需要安装 | 可设值 | 默认值 | 示例 |
---|---|---|---|
N | Y, N | Y | enable-hwcodec=Y |
控制 peer 卡片 的视图, 包括 “大磁贴”、“小磁贴” 和 “列表”。
Location:
是否需要安装 | 可设值 | 默认值 | 示例 |
---|---|---|---|
N | 0, 1, 2 | 0 | peer-card-ui-type=0 |
0 “大磁贴”
1 “小磁贴”
2 “列表”
控制 peer 卡片 的顺序。
Location:
是否需要安装 | 可设值 | 默认值 | 示例 |
---|---|---|---|
N | Remote ID, Remote Host, Username | Remote ID | peer-sorting=Remote ID |
控制是否将地址簿与最近的会话同步。
位置:
是否需要安装 | 可设值 | 默认值 | 示例 |
---|---|---|---|
N | Y, N | N | sync-ab-with-recent-sessions=N |
控制是否对通讯录标签进行排序。
位置:
是否需要安装 | 可设值 | 默认值 | 示例 |
---|---|---|---|
N | Y, N | N | sync-ab-tags=N |
按标签交集过滤地址簿。
预览: PR #5985
位置:
是否需要安装 | 可设值 | 默认值 | 示例 |
---|---|---|---|
N | Y, N | N | filter-ab-by-intersection=N |
这个选项会在第一次连接每个被控端的后, 设置关于该被控端的 “view-only”。
被控端设置中的 “view-only” 会控制连接是否为浏览模式。
位置:
是否需要安装 | 可设值 | 默认值 | 示例 |
---|---|---|---|
N | Y, N | N | view-only=Y |
控制是否在工具栏上显示监视器列表。
位置:
是否需要安装 | 可设值 | 默认值 | 示例 |
---|---|---|---|
N | Y, N | N | show-monitors-toolbar=Y |
控制连接建立后, 是否折叠工具栏。
位置:
是否需要安装 | 可设值 | 默认值 | 示例 |
---|---|---|---|
N | Y, N | N | collapse-toolbar=Y |
这个选项会在第一次连接每个被控端的后, 设置关于该被控端的 “show-remote-cursor”。
被控端设置中的 “show-remote-cursor” 会控制是否显示被控端的光标。
位置:
是否需要安装 | 可设值 | 默认值 | 示例 |
---|---|---|---|
N | Y, N | N | show-remote-cursor=N |
这个选项会在第一次连接每个被控端的后, 设置关于该被控端的 “follow-remote-cursor”。
被控端设置中的 “follow-remote-cursor” 控制画面是否跟随远程光标。
预览 PR 7717
位置:
是否需要安装 | 可设值 | 默认值 | 示例 |
---|---|---|---|
N | Y, N | N | follow-remote-cursor=Y |
这个选项会在第一次连接每个被控端的后, 设置关于该被控端的 “follow-remote-window”。
被控端设置中的 “follow-remote-window” 控制画面是否跟随远程窗口焦点。
预览 PR 7717
位置:
是否需要安装 | 可设值 | 默认值 | 示例 |
---|---|---|---|
N | Y, N | N | follow-remote-window=Y |
这个选项会在第一次连接每个被控端的后, 设置关于该被控端的 “zoom-cursor”。
被控端设置中的 “zoom-cursor” 控制画面中的光标按照画面的比例进行缩放。
位置:
是否需要安装 | 可设值 | 默认值 | 示例 |
---|---|---|---|
N | Y, N | N | zoom-cursor=Y |
这个选项会在第一次连接每个被控端的后, 设置关于该被控端的 “show-quality-monitor”。
被控端设置中的 “show-quality-monitor” 控制是否显示质量监测。
位置:
是否需要安装 | 可设值 | 默认值 | 示例 |
---|---|---|---|
N | Y, N | N | show-quality-monitor=Y |
这个选项会在第一次连接每个被控端的后, 设置关于该被控端的 “disable-audio”。
被控端设置中的 “disable-audio” 控制是否播放声音。
位置:
是否需要安装 | 可设值 | 默认值 | 示例 |
---|---|---|---|
N | Y, N | N | disable-audio=Y |
这个选项会在第一次连接每个被控端的后, 设置关于该被控端的 “enable-file-copy-paste”。
被控端设置中的 “enable-file-copy-paste” 控制连接中, 是否可以复制粘贴文件。
位置:
是否需要安装 | 可设值 | 默认值 | 示例 |
---|---|---|---|
N | Y, N | N | enable-file-copy-paste=Y |
这个选项会在第一次连接每个被控端的后, 设置关于该被控端的 “disable-clipboard”。
被控端设置中的 “disable-clipboard” 控制是否允许文本复制粘贴。
位置:
是否需要安装 | 可设值 | 默认值 | 示例 |
---|---|---|---|
N | Y, N | N | disable-clipboard=Y |
这个选项会在第一次连接每个被控端的后, 设置关于该被控端的 “lock-after-session-end”。
被控端设置中的 “lock-after-session-end” 控制是否在连接结束后, 锁定被控端电脑。
位置:
是否需要安装 | 可设值 | 默认值 | 示例 |
---|---|---|---|
N | Y, N | N | lock-after-session-end=Y |
这个选项会在第一次连接每个被控端的后, 设置关于该被控端的 “privacy-mode”。
被控端设置中的 “privacy-mode” 控制是否在连接后, 启用隐私模式。
位置:
是否需要安装 | 可设值 | 默认值 | 示例 |
---|---|---|---|
N | Y, N | N | privacy-mode=Y |
这个选项会在第一次连接每个被控端的后, 设置关于该被控端的 “touch-mode”。
被控端设置中的 “touch-mode” 控制是否在连接后, 使用触屏模式还是鼠标模式。
位置:
是否需要安装 | 可设值 | 默认值 | 示例 |
---|---|---|---|
N | Y, N | N | touch-mode=Y |
这个选项会在第一次连接每个被控端的后, 设置关于该被控端的 “i444”。
被控端设置中的 “i444” 控制是否使用真彩模式 (4:4:4)。
位置:
是否需要安装 | 可设值 | 默认值 | 示例 |
---|---|---|---|
N | Y, N | N | i444=Y |
这个选项会在第一次连接每个被控端的后, 设置关于该被控端的 “reverse-mouse-wheel”。
被控端设置中的 “reverse-mouse-wheel” 控制是否反转鼠标滚轮方向。
位置:
是否需要安装 | 可设值 | 默认值 | 示例 |
---|---|---|---|
N | Y, N | N | reverse-mouse-wheel=Y |
这个选项会在第一次连接每个被控端的后, 设置关于该被控端的 “swap-left-right-mouse”。
被控端设置中的 “swap-left-right-mouse” 控制是否交换鼠标左右键。
位置:
是否需要安装 | 可设值 | 默认值 | 示例 |
---|---|---|---|
N | Y, N | N | swap-left-right-mouse=Y |
这个选项会在第一次连接每个被控端的后, 设置关于该被控端的 “displays-as-individual-windows”。
被控端设置中的 “displays-as-individual-windows” 控制是否在在单个窗口打开显示器。
预览 PR 5945
位置:
是否需要安装 | 可设值 | 默认值 | 示例 |
---|---|---|---|
N | Y, N | N | displays-as-individual-windows=Y |
这个选项会在第一次连接每个被控端的后, 设置关于该被控端的 “use-all-my-displays-for-the-remote_session”。
被控端设置中的 “use-all-my-displays-for-the-remote_session” 控制是否在连接时, 尽量使用所有的本地显示器连接被控所有显示器。
预览 PR 6064
位置:
是否需要安装 | 可设值 | 默认值 | 示例 |
---|---|---|---|
N | Y, N | N | use-all-my-displays-for-the-remote_session=Y |
这个选项会在第一次连接每个被控端的后, 设置关于该被控端的 “view-style”。
被控端设置中的 “view-style” 控制是否显示方式。
位置:
是否需要安装 | 可设值 | 默认值 | 示例 |
---|---|---|---|
N | original, adaptive | original | view-style=original |
这个选项会在第一次连接每个被控端的后, 设置关于该被控端的 “scroll-style”。
被控端设置中的 “scroll-style” 控制是否滚动方式。
位置:
是否需要安装 | 可设值 | 默认值 | 示例 |
---|---|---|---|
N | scrollauto, scrollbar | scrollauto | scroll-style=scrollauto |
这个选项会在第一次连接每个被控端的后, 设置关于该被控端的 “image-quality”。
被控端设置中的 “image-quality” 控制图像质量。
位置:
是否需要安装 | 可设值 | 默认值 | 示例 |
---|---|---|---|
N | best, balanced, low, custom | balanced | image-quality=balanced |
这个选项会在第一次连接每个被控端的后, 设置关于该被控端的 “custom-image-quality”。
被控端设置中的 “custom-image-quality” 控制图像质量(当 “image-quality” 为 custom 的时候)。
位置:
是否需要安装 | 可设值 | 默认值 | 示例 |
---|---|---|---|
N | [10.0, 2000.0] | 50.0 | custom-image-quality=50 |
这个选项会在第一次连接每个被控端的后, 设置关于该被控端的 “custom-fps”。
被控端设置中的 “custom-fps” 控制 fps(当 “image-quality” 为 custom 的时候)。
位置:
是否需要安装 | 可设值 | 默认值 | 示例 |
---|---|---|---|
N | [5, 120] | 30 | custom-fps=30 |
这个选项会在第一次连接每个被控端的后, 设置关于该被控端的 “codec-preference”。
被控端设置中的 “codec-preference” 控制图像的编解码。
Location:
是否需要安装 | 可设值 | 默认值 | 示例 |
---|---|---|---|
N | auto, vp8, vp9, av1, h264, h265 | auto | codec-preference=auto |
注意: “vp8” 和 “vp9” 以外的选项可能不起作用。 这取决于您的机器支持什么。
预设地址簿名称和标签, https://github.com/rustdesk/rustdesk-server-pro/issues/257. 仅当您不想设置标签时,才可以设置预设地址簿名称。 请在 Web 控制台的地址簿页面上使用有效的地址簿名称和标签。
选项 | 是否需要安装 | 可设值 | 默认值 | 示例 |
---|---|---|---|---|
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> |
在 RustDesk 客户端上禁用组面板(地址簿面板旁边), https://github.com/rustdesk/rustdesk-server-pro/issues/250
是否需要安装 | 可设值 | 默认值 | 示例 |
---|---|---|---|
N | Y, N | N | disable-group-panel=Y |
Windows 非安装版运行时自动提升, https://github.com/rustdesk/rustdesk-server-pro/issues/252
是否需要安装 | 可设值 | 默认值 | 示例 |
---|---|---|---|
N | Y, N | N | pre-elevate-service=Y |
当Android服务启动时, 它会显示一个悬浮窗, 这有助于防止系统杀死RustDesk服务。
可设值 | 默认值 | 示例 |
---|---|---|
Y, N | N | disable-floating-window=Y |
当Android服务启动时, 它会显示一个浮动窗口, 这有助于防止系统杀死RustDesk服务。当尺寸小于120时, 浮动窗口将难以点击。设置成非常小的size时, 在有些设备上可能起不到保持后台服务的作用。
可设值 | 默认值 | 示例 |
---|---|---|
[32, 320] | 120 | floating-window-size=120 |
默认情况下, 点击浮动窗口会弹出菜单。但是将其设置为’不可触摸’状态后, 点击或滑动操作将穿透浮动窗口, 传递给下层窗口。当浮动窗口被设置为’不可触摸’状态后, 浮动窗口的位置不能再改变, 系统可能会自动将其设置为半透明。然而, 这个功能在少数应用程序中可能无法生效, 比如 GitHub 应用程序。
可设值 | 默认值 | 示例 |
---|---|---|
Y, N | N | floating-window-untouchable=Y |
Android 浮动窗口具有可调整的透明度。如果您想启用但隐藏浮动窗口, 可以将透明度设置为0, 此时浮动窗口将自动设置为’不可触摸’状态,以便能够通过点击事件进行交互操作。
可设值 | 默认值 | 示例 |
---|---|---|
[0, 10] | 10 | floating-window-transparency=5 |
如果没有为 Android 浮动窗口设置图标, 它将默认显示 RustDesk 图标。 设置时请将svg的文本内容写到一行里,并注意svg支持限制。
默认值 | 示例 |
---|---|
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> |
用于Android 被控的。请注意,保持屏幕打开依赖于浮动窗口。
可设值 | 默认值 | 示例 |
---|---|---|
never, during-controlled, service-on | during-controlled | keep-screen-on=never |
这个选项用于Windows做被控。如果没有遇到任何问题,建议使用默认设置,默认设置会优先使用DirectX进行截图,而不是直接使用GDI。
可设值 | 默认值 | 示例 |
---|---|---|
Y, N | Y | enable-directx-capture=N |
这个选项用于Android做被控。默认情况下,当分辨率大于1200时,硬件编码使用原始分辨率,而软件编码使用一半的分辨率,因为软件编码比较慢。这个选项用于设置软件编码是否应该缩放到一半分辨率。
可设值 | 默认值 | 示例 |
---|---|---|
Y, N | Y | enable-android-software-encoding-half-scale=N |
是否允许控制端点击连接管理窗口,以接受连接、更改权限等。
可设值 | 默认值 | 示例 |
---|---|---|
Y, N | N | allow-remote-cm-modification=Y |
当自定义客户端有预设密码时是否去除GUI上的安全警告。
https://github.com/rustdesk/rustdesk-server-pro/discussions/286
可设值 | 默认值 | 示例 |
---|---|---|
Y, N | Y | remove-preset-password-warning=Y |
是否隐藏某些设置,请确保Disable settings
已关闭,否则这些设置将不起作用。
https://github.com/rustdesk/rustdesk-server-pro/issues/263
https://github.com/rustdesk/rustdesk-server-pro/issues/276
可设值 | 默认值 | 示例 |
---|---|---|
Y, N | N | hide-security-settings=Y |
是否在设备列表中显示用户名,因为有时用户名太长,会隐藏其他信息。
https://github.com/rustdesk/rustdesk-server-pro/issues/284#issuecomment-2216521407
可设值 | 默认值 | 示例 |
---|---|---|
Y, N | N | hide-username-on-card=Y |
是否在 GUI 上显示 UAC/权限警告。
https://github.com/rustdesk/rustdesk/issues/8687
可设值 | 默认值 | 示例 |
---|---|---|
Y, N | N | hide-help-cards=Y |
更改连接到远程设备时将在弹出窗口中显示的显示名称。默认情况下,它显示您的操作系统用户名。
https://github.com/rustdesk/rustdesk-server-pro/issues/277
是否仅使用TCP,不再使用UDP 21116,而是使用TCP 21116。
可设值 | 默认值 | 示例 |
---|---|---|
Y, N | N | disable-udp=Y |
将用户/策略分配给设备,您也可以通过命令行执行此操作
https://github.com/rustdesk/rustdesk-server-pro/discussions/304
用于连接远程设备的默认密码,该密码的优先级低于通讯录密码和本地保存的密码。
e.g. default-connect-password=abcd1234
允许可信设备跳过2FA验证。
https://github.com/rustdesk/rustdesk/discussions/8513#discussioncomment-10234494
可设值 | 默认值 | 示例 |
---|---|---|
Y, N | Y | enable-trusted-devices=N |