rustdesk/rustdesk

An open-source remote desktop, and alternative to TeamViewer.

Servers • 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]
We need your help to translate this README, RustDesk UI and RustDesk Doc to your native language

Chat with us: Discord | Twitter | Reddit

Yet another remote desktop software, written in Rust. Works out of the box, 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.

FAQ

BINARY DOWNLOAD

NIGHTLY BUILD

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.

Windows | Linux | macOS

Raw steps to build

• Prepare your Rust development env and C++ build env

• Install vcpkg, and set VCPKG_ROOT env 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

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

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

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 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
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 are running these commands from the root of the RustDesk repository, otherwise the application might not be able to 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

Screenshots

rustdesk's Issues

Appimage version?

I would like to see the AppImage version for your product.

cannot find function `get_msgbox` in module `inline` --> src/ui.rs:34:20 | 34 | return inline::get_msgbox(); | ^^^^^^^^^^ not found in `inline`

cannot find function get_msgbox in module inline
--> src/ui.rs:34:20
|
34 | return inline::get_msgbox();
| ^^^^^^^^^^ not found in inline

Request: standalone binaries in .tar.gz format for releases

I'm trying to build rustdesk on Gentoo. My rust-fu is weak, so I don't really understand the message that is coming back or how to resolve it (well, I kinda understand it, but I don't know how to resolve it):

warning: build failed, waiting for other jobs to finish...
error[E0277]: the trait bound `std::vec::Vec<u8>: std::convert::From<[u8; 32]>` is not satisfied
   --> libs/hbb_common/src/config.rs:485:52

(this is from the 1.1.5 tag, after cloning the repo locally)

However, for now, I'd just like to try out rustdesk between my windows and linux machines; you provide great packages for a few distros, and I'd like to ask if it would be possible to provide a vanilla .tar.gz of the binaries that I could unpack on my system to give rustdesk a go?

Ideally, I'd like to build from source, but before I chase this much further, I'd like to see if rustdesk gives me what I'm looking for: a viable alternative to anydesk

Thanks for your time.

Thank you for contributing such a beautiful software

Thank you for contributing such a beautiful software. Can I add a server version that supports raspberry pie? Raspberry pie seems to be more suitable for building low-cost servers.

Failed to build on Manjaro 21.0.1

A library maintained by the author failed to build with:

error: failed to run custom build command for `magnum-opus v0.3.4 (/xxx/rustdesk/libs/magnum-opus)`

Caused by:
  process didn't exit successfully: `/xxx/rustdesk/target/debug/build/magnum-opus-5d2f2df5f87fcc5d/build-script-build` (exit code: 101)
  --- stderr
  thread 'main' panicked at 'called `Result::unwrap()` on an `Err` value: NotPresent', libs/magnum-opus/build.rs:7:50
  note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
warning: build failed, waiting for other jobs to finish...
error: build failed

I'm new to Rust and is looking for a word of inspiration; you don't need to tell me everything, just a place to start is enough for me. I guess this is easy, so don't feel upset for this newbie question.

how to build windows exe?

I run ,cargo build --release ,and run the grenerated rustdesk.exe ,only get the blank screen with console.

Does it plan to support socks5 proxy in future ?

Does it plan to support socks5 proxy in future ?

[Feature Request] Is it possible to add support for ARMv7 processors for Android version?

I failed to install RustDesk for Android on an old device. After some research I found that RustDesk‘s native-code is arm64-v8a but my old device is with an ARMv7 processor.
我无法在一台旧设备上安装 RustDesk 安卓版。经过调查发现 RustDesk 的 native-code 编译为 arm64-v8a，而那台旧设备的处理器为 ARMv7 处理器。

PS > aapt.exe dump badging rustdesk-1.1.1.apk
...
native-code: 'arm64-v8a'

Could you consider adding support for ARMv7?
请问能否考虑增加对 ARMv7 的支持？

Can not show windows UAC modal

when you uninstall an application which was install in C:\Program Files , the windows will open a modal to notify you for the administrator permission, but rustdesk can not show that modal.

Source code?

client+server

Can I input local IP only to control a machine in the same intranet.

Suppose there is no internet

Give movement priority to host rather than client + multiple connections mouse move priority issue

Right now the client has priority over the host for controlling the mouse. Teamviewer/anydesk use the opposite. Any movement the host does with the mouse will always override any movement the client connected makes.

I think rustdesk should follow the same logic.

Unable to unlock

If the remote computer is locked, cannot enter the password via keyboard and cannot be unlocked, both computers are win10

Window does move to active monitor if current monitor no longer exists

OS: Windows
Version: 20H1

Connect multiple monitors, move RustDesk to a secondary monitor. Disconnect external monitor, window will now be stuck on the new monitor, instead of seeing that the monitor no longer exists on moving to the primary monitor.

”no Display“ for win10 connecting to win7

1.1.1和1.1.0版本都试过。

Spelling on website

quanlity --> quality

Sry not a very good issue 😅

Unable to connect to Clients without monitor attached (headless linux)

OS: Linux Mint 20.1 x64
Kernel: 5.4.0-58

Unable to connect to Linux machines with no monitor attached.
Remote Error:
No Display

Please enable High DPI awareness...

The images are blurry on very high resolution screens and with screen scaling higher than 100%.

Windows 8.1
3840 x 2160 ( Scaling 250% )

Security concerns have been taken to Github

I am writing because it seems that security related questions have been intentionally deleted time and time again by the anonymous rustdesk author.

Also I've heard that the security concerns have been taken to Github to look into this behaviour because it was suggested that parts of Rustdesk might be intentionally malicious.

So I would hereby like to ask the author, please state why you would do this. Apps as powerful as rustdesk must hold up to these kind of scrutiny.

Therefore I want to know in the name the community what's going on here.

RustDesk.exe not found under C:\Program Files

I used Win10 LTSC 1809 to install. No error was reported during the install process. After that, RustDesk.exe was not generated in C:\Program Files, only the shortcut to the start menu. I really like this software and hope to fix it. ,thank!

Open the website homepage https://rustdesk.com/, the CPU will be ↑↑↑↑

Wayland support

I wanted to try out this application, as it seems very promising, however as I understand it doesn't currently support wayland. What would be needed for wayland support? Screen capture support, GUI, or something else?

Keep the random password after setting the password

Could rustdesk provide directly connect in lan without relay server?

Source Code Build

Is it difficult to configure the environment for this source code build? After reading half a day did not understand how to build this build environment, and asked for a slightly more detailed tutorial steps.

Background requests each hour even when service disabled

I've installed the .deb package few days ago and was going through DNS logs today when I noticed a lot of requests from rustdesk app even though I've not opened that and have rebooted system few times. It's like a few requests every hour. Can you tell if it's necessary?

Really bad english wording about security

In the website[1] and on the readme you use the phrase "no concern of security". In this context it means you have not considered or cared about security in creating this software. I think what you meant to write is "no concerns about security" which suggests you don't need to worry about security using this product.

1. https://rustdesk.com/

GLIBC_2.29 not found

rustdesk: /lib/x86_64-linux-gnu/libm.so.6: version `GLIBC_2.29' not found
os: debian 10

建议打包不要采用glibc包过新！

Suddenly crashed when trying to type on remote screen on macOS Big Sur 11.2.3

I(Using Linux) can control on remote screen(macOS 11.2.3) but once I try to type letters on remote screen, RustDesktop suddenly crashed on macOS side, I've tried several times, it occurs the same issue.

macOS version: macOS Big Sur 11.2.3
RustDesktop version: 1.1.5

Support for renaming connections

Would love to see support for renaming a recent connection.

Merge the display toggle with the display "icons"

Why not just merge the toggle buttons with the "icons" to avoid confusion for the end user?

[feature request] launch on startup

launch rustdesk on startup and only keep a tray icon.

32-bit version

Hi

Any plan to support 32-bit systems?

Thanks

What advantages does the free version have over Sunflower and tv?

Keyboard layouts and shortcuts

Please add the keyboard layout sync, so the remote pc layout matches the host.
(Currently if remote keyboard layout doesn't match you'll end up typing in both layouts at the same time like ttyyppiinngg)

Also please add the ability to use the keyboard shortcuts between host and remote pc (win/super shortcuts also don't work).

Can not control remote side sometimes

对方电脑是windows 10 ，当对方的电脑弹出对话框的时候，不知道这是因为哪里的问题
(remote side is windows 10)

error: failed to run custom build command for scrap v0.5.0

error: failed to run custom build command for scrap v0.5.0

For some reason, the network latency is still very high~

Takes a long time for the screen to respond after connecting. Is there a way to optimize this?

Android support

This app in android will be enough for many to shift from anydesk.

The "Download Android App" link on the Chinese website (locale: zh) incorrectly points to a .deb file instead of an .apk file

<!-- Code snippet from https://rustdesk.com/zh/ -->
<a href="//github.com/rustdesk/rustdesk/releases/download/1.1.1/rustdesk-1.1.1.deb"  <!-- Should be a .apk suffix here -->
    target="_blank" id="a-android">
    <img src="/images/android.svg?v=2" />
</a>

connect to ubuntu 20.04 from mac os 11.4(m1 chip) pops x11 err dialog

host machine:mac mini(m1 chip)
target machine:ubuntu 20.04.02
ubuntu use x11 as windowing system

Fonts on Rustdesk website aren't loading properly

First of all, congratulations of the project.

On rustdesk.com, the fonts seem strange:

Can't Generate ID With `Please Check Your Connection` Message

I'm trying to run RustDesk for my PC on campus. Zoho and AnyDesk got no problem setup connection, but RustDesk seems can't make connection.

The message are:

Not ready. Please check your connection

For your information:
My campus block certain port, thus for GitHub adn GitLab we use Port 443 to bypass the blocked port.

Selecting text on android

I is difficult to work with text without selecting it .
Here is how it works on AnyDesk VS current version of RustDesk.

IMG_20210512_230412_693.mp4

Feature request : Centos RPM support

Hi,

first of all thank you for your great job, finally a great simple product to kill teamviewer and respect privacy :).

I'm really not goot with compilation, and does not know rust :(.

Do you plan to compile RPM For Centos 7/8 ?

thank you

Ubuntu installation failed

rustdesk: /lib/x86_64-linux-gnu/libm.so.6: version `GLIBC_2.27' not found (required by rustdesk)
rustdesk: /lib/x86_64-linux-gnu/libc.so.6: version `GLIBC_2.25' not found (required by rustdesk)

The compiled executable file cannot load resources

I would like to ask why index.html cannot be loaded after compilation, thank you

Mac failed to connect to Win7...

can't get rustdesk-server-demo work

1. first run serverdemo
   IP=192.168.2.231 cargo run

2.set ID/Relay address on client
connect to another pc

the server log output

register_peer 192.168.2.3:53374
punch_hole_request 192.168.2.3:49650
relay_response 192.168.2.231:46299
block here

client throw exception Connection Error , Failed to connect to relay server

feat: add remote shell (ssh/cmd)

Sometimes we only need a remote shell, can this function be added?