rustdesk/README.md

RustDesk | Your Remote Desktop Software

Servers • Build • Structure • Snapshot
[中文] [Deutsche]

Chat with us: Discord | Reddit

Yet another remote desktop software, written in Rust. Works out of the box, no configuration required. Great alternative to TeamViewer and AnyDesk! 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.

BINARY DOWNLOAD

Free Public Servers

Below are the servers you are using for free, it may change along the time. If you are not close to one of these, your network may be slow.

• Seoul, AWS lightsail, 1 VCPU/0.5G RAM
• Singapore, Vultr, 1 VCPU/1G RAM
• Virginia, AWS EC2, 4 VCPUs/32G RAM, donated by tensorsurgical.com

Dependencies

Desktop versions use sciter for GUI, 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
  • Linux/Osx: vcpkg install libvpx libyuv opus

• run cargo run

How to build on Linux

Ubuntu 18 (Debian 10)

sudo apt install -y 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

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 pulseaudio

Install vcpkg

git clone https://github.com/microsoft/vcpkg --branch 2020.11-1
vcpkg/bootstrap-vcpkg.sh
export VCPKG_ROOT=$HOME/vcpkg
vcpkg/vcpkg install libvpx libyuv opus

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://github.com/c-smile/sciter-sdk/raw/dc65744b66389cd5a0ff6bdb7c63a8b7b05a708b/bin.lnx/x64/libsciter-gtk.so
mv libsciter-gtk.so target/debug
cargo run

Change Wayland to X11 (Xorg)

RustDesk does not support Wayland. Check this to configuring Xorg as the default GNOME session.

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
• src/ui: GUI
• 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

Snapshot