Repository files navigation

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]
We need your help to translate this README,RustDesk UI andRustDesk 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, orwrite your own rendezvous/relay server.

RustDesk welcomes contribution from everyone. SeeCONTRIBUTING.md for help getting started.

FAQ

BINARY DOWNLOAD

NIGHTLY BUILD

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 ourCI for building Flutter version.

Please download Sciter dynamic library yourself.

Windows |Linux |macOS

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

• Installvcpkg, and setVCPKG_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

• runcargo run

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

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

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

sudo pacman -Syu --needed unzip git cmake gcc curl wget yasm nasm zip make pkg-config clang gtk3 xdotool libxcb libxfixes alsa-lib pipewire

git clone https://github.com/microsoft/vcpkgcd vcpkggit checkout 2023.04.15cd ..vcpkg/bootstrap-vcpkg.shexport VCPKG_ROOT=$HOME/vcpkgvcpkg/vcpkg install libvpx libyuv opus aom

cd vcpkg/buildtrees/libvpx/srccd*./configuresed -i's/CFLAGS+=-I/CFLAGS+=-fPIC -I/g' Makefilesed -i's/CXXFLAGS+=-I/CXXFLAGS+=-fPIC -I/g' Makefilemakecp libvpx.a$HOME/vcpkg/installed/x64-linux/lib/cd

curl --proto'=https' --tlsv1.2 -sSf https://sh.rustup.rs| shsource$HOME/.cargo/envgit clone https://github.com/rustdesk/rustdeskcd rustdeskmkdir -p target/debugwget https://raw.githubusercontent.com/c-smile/sciter-sdk/master/bin.lnx/x64/libsciter-gtk.somv libsciter-gtk.so target/debugVCPKG_ROOT=$HOME/vcpkg cargo run

Begin by cloning the repository and building the Docker container:

git clone https://github.com/rustdesk/rustdeskcd rustdeskgit submodule update --init --recursivedocker 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 asinstall orrun are not currently supported via this method as they would install or run the program inside the container instead of the host.

• 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 withrustdesk-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