915bf7269a
Symptom
-------
With a self-hosted (or public) hbbs/hbbr stack, an iOS RustDesk client
controlling a Windows host with multiple monitors hangs at "Connected,
Waiting for image" after auto-reconnecting from a network drop, but only
when the previous session was viewing a non-primary display. Reconnects
that started from the primary display always succeed.
Root cause
----------
On reconnect the iOS client re-establishes the peer connection but does
NOT re-issue its display selection (no `CaptureDisplays` or
`SwitchDisplay` is sent). The host correctly defaults `display_idx` to
PRIMARY_DISPLAY_IDX in `Connection::start()` and brings up only
`monitor0`'s capturer. The iOS UI is still in "display N" mode from the
previous session and silently drops or waits-on frames it considers
mismatched, producing the indefinite "Waiting for image" state.
Verified against real service logs: in the failure case the host emits
`new video service: monitor0` and the matching snapshot, but no
`monitor1` is ever created during the entire lifetime of the
auto-reconnected session.
Fix
---
Persist the most recent active display set per remote peer id in a new
`LAST_VIEW_BY_PEER` map (in-memory, same pattern as the adjacent
`LOGIN_FAILURES` / `SESSIONS` statics). Hook the persist on both code
paths that change the active capture set (`switch_display_to` for older
clients, `capture_displays` for >= 1.2.4 clients).
On `handle_login_request_without_validation`, look up the stored set for
this peer's `my_id`. If it differs from primary-only:
* Validate each stored index against the currently-present displays
(drops stale entries if a monitor was unplugged between sessions).
* Pre-set `self.display_idx` so the upcoming PeerInfo response carries
the restored display index, keeping the iOS UI's expected display in
sync with the frames the host is about to emit.
* Stash the validated set in `pending_display_set`.
After `try_sub_monitor_services()` finishes (both call sites updated),
`apply_pending_display_set()` runs `self.capture_displays(&[], &[],
&set)` to actually swap to the restored capturer. Both paths fully
release locks before any `.await`.
Also clears any prior pending state at the top of
`handle_login_request_without_validation` to avoid leaking pending state
across re-logins on the same `Connection` instance.
Behaviour for the common case (primary-only, fresh peer, anonymous peer
with empty `my_id`) is unchanged.
Verification
------------
Reproduced and verified on Windows 11 host (build under
`flutter,hwcodec,vram`) with a 2-monitor setup against an iOS RustDesk
client through a self-hosted hbbs 1.1.15.
Failing run logs (before patch):
monitor0 created on reconnect; no monitor1 ever created; iOS stalls.
Passing run logs (after patch):
L36 Connection #1381 opened
L84 Persisted view [1] for peer 1130614991
L111 Connection closed: Timeout <- airplane mode
L144 Connection #1382 opened <- auto-reconnect
L145 Will restore previously viewed displays [1] for peer 1130614991
L155 Restoring previously viewed display set [1] after services subscribed
L162 new video service: monitor1 <- without any iOS message
iOS resumes display 2 video, no stall.
|
||
|---|---|---|
| .cargo | ||
| .github | ||
| appimage | ||
| docs | ||
| examples | ||
| fastlane/metadata/android | ||
| flatpak | ||
| flutter | ||
| libs | ||
| res | ||
| src | ||
| .gitattributes | ||
| .gitignore | ||
| .gitmodules | ||
| AGENTS.md | ||
| build.py | ||
| build.rs | ||
| Cargo.lock | ||
| Cargo.toml | ||
| CLAUDE.md | ||
| Dockerfile | ||
| entrypoint.sh | ||
| GEMINI.md | ||
| LICENCE | ||
| README.md | ||
| vcpkg.json | ||
Build •
Docker •
Structure •
Snapshot
[Українська] | [česky] | [中文] | [Magyar] | [Español] | [فارسی] | [Français] | [Deutsch] | [Polski] | [Indonesian] | [Suomi] | [മലയാളം] | [日本語] | [Nederlands] | [Italiano] | [Русский] | [Português (Brasil)] | [Esperanto] | [한국어] | [العربي] | [Tiếng Việt] | [Dansk] | [Ελληνικά] | [Türkçe] | [Norsk] | [Română]
We need your help to translate this README, RustDesk UI and RustDesk Doc to your native language
Caution
Misuse Disclaimer:
The developers of RustDesk do not condone or support any unethical or illegal use of this software. Misuse, such as unauthorized access, control or invasion of privacy, is strictly against our guidelines. The authors are not responsible for any misuse of the application.
Chat with us: Discord | Twitter | Reddit | YouTube
Yet another remote desktop solution, written in Rust. Works out of the box with no configuration required. You have full control of your data, with no concerns about security. You can use our rendezvous/relay server, set up your own, or write your own rendezvous/relay server.
RustDesk welcomes contribution from everyone. See CONTRIBUTING.md for help getting started.
Dependencies
Desktop versions use Flutter or Sciter (deprecated) for GUI, this tutorial is for Sciter only, since it is easier and more friendly to start. Check out our CI for building Flutter version.
Please download Sciter dynamic library yourself.
Raw Steps to build
-
Prepare your Rust development env and C++ build env
-
Install vcpkg, and set
VCPKG_ROOTenv variable correctly- Windows: vcpkg install libvpx:x64-windows-static libyuv:x64-windows-static opus:x64-windows-static aom:x64-windows-static
- Linux/macOS: vcpkg install libvpx libyuv opus aom
-
run
cargo run
Build
How to Build on Linux
Ubuntu 18 (Debian 10)
sudo apt install -y zip g++ gcc git curl wget nasm yasm libgtk-3-dev clang libxcb-randr0-dev libxdo-dev \
libxfixes-dev libxcb-shape0-dev libxcb-xfixes0-dev libasound2-dev libpulse-dev cmake make \
libclang-dev ninja-build libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev libpam0g-dev
openSUSE Tumbleweed
sudo zypper install gcc-c++ git curl wget nasm yasm gcc gtk3-devel clang libxcb-devel libXfixes-devel cmake alsa-lib-devel gstreamer-devel gstreamer-plugins-base-devel xdotool-devel pam-devel
Fedora 28 (CentOS 8)
sudo yum -y install gcc-c++ git curl wget nasm yasm gcc gtk3-devel clang libxcb-devel libxdo-devel libXfixes-devel pulseaudio-libs-devel cmake alsa-lib-devel gstreamer1-devel gstreamer1-plugins-base-devel pam-devel
Arch (Manjaro)
sudo pacman -Syu --needed unzip git cmake gcc curl wget yasm nasm zip make pkg-config clang gtk3 xdotool libxcb libxfixes alsa-lib pipewire
Install vcpkg
git clone https://github.com/microsoft/vcpkg
cd vcpkg
git checkout 2023.04.15
cd ..
vcpkg/bootstrap-vcpkg.sh
export VCPKG_ROOT=$HOME/vcpkg
vcpkg/vcpkg install libvpx libyuv opus aom
Fix libvpx (For Fedora)
cd vcpkg/buildtrees/libvpx/src
cd *
./configure
sed -i 's/CFLAGS+=-I/CFLAGS+=-fPIC -I/g' Makefile
sed -i 's/CXXFLAGS+=-I/CXXFLAGS+=-fPIC -I/g' Makefile
make
cp libvpx.a $HOME/vcpkg/installed/x64-linux/lib/
cd
Build
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
source $HOME/.cargo/env
git clone --recurse-submodules https://github.com/rustdesk/rustdesk
cd rustdesk
mkdir -p target/debug
wget https://raw.githubusercontent.com/c-smile/sciter-sdk/master/bin.lnx/x64/libsciter-gtk.so
mv libsciter-gtk.so target/debug
VCPKG_ROOT=$HOME/vcpkg cargo run
How to build with Docker
Begin by cloning the repository and building the Docker container:
git clone https://github.com/rustdesk/rustdesk
cd rustdesk
git submodule update --init --recursive
docker build -t "rustdesk-builder" .
Then, each time you need to build the application, run the following command:
docker run --rm -it -v $PWD:/home/user/rustdesk -v rustdesk-git-cache:/home/user/.cargo/git -v rustdesk-registry-cache:/home/user/.cargo/registry -e PUID="$(id -u)" -e PGID="$(id -g)" rustdesk-builder
Note that the first build may take longer before dependencies are cached, subsequent builds will be faster. Additionally, if you need to specify different arguments to the build command, you may do so at the end of the command in the <OPTIONAL-ARGS> position. For instance, if you wanted to build an optimized release version, you would run the command above followed by --release. The resulting executable will be available in the target folder on your system, and can be run with:
target/debug/rustdesk
Or, if you're running a release executable:
target/release/rustdesk
Please ensure that you run these commands from the root of the RustDesk repository, or the application may not find the required resources. Also note that other cargo subcommands such as install or run are not currently supported via this method as they would install or run the program inside the container instead of the host.
File Structure
- libs/hbb_common: video codec, config, tcp/udp wrapper, protobuf, fs functions for file transfer, and some other utility functions
- libs/scrap: screen capture
- libs/enigo: platform specific keyboard/mouse control
- libs/clipboard: file copy and paste implementation for Windows, Linux, macOS.
- src/ui: obsolete Sciter UI (deprecated)
- src/server: audio/clipboard/input/video services, and network connections
- src/client.rs: start a peer connection
- src/rendezvous_mediator.rs: Communicate with rustdesk-server, wait for remote direct (TCP hole punching) or relayed connection
- src/platform: platform specific code
- flutter: Flutter code for desktop and mobile
- flutter/web/js: JavaScript for Flutter web client