Skip to content
View rustdesk's full-sized avatar

Sponsors

@roukmoute
@muety
@iMi-digital
@staticcharges
Private Sponsor
@bobapplemac
Private Sponsor
Private Sponsor
@Vogelbusch
@tpokorra
@lazynooblet
Block or Report

Block or report rustdesk

Block user

Prevent this user from interacting with your repositories and sending you notifications. Learn more about blocking users.

You must be logged in to block users.

Add an optional note:
Please don't include any personal information such as legal names or email addresses. Maximum 100 characters, markdown supported. This note will be visible to only you.
Report abuse

Contact GitHub support about this user’s behavior. Learn more about reporting abuse.

Report abuse
rustdesk/README.md

RustDesk - Your remote desktop
ServersBuildDockerStructureSnapshot
[Українська] | [č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

ko-fi

Open Bounties

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.

image

RustDesk welcomes contribution from everyone. See CONTRIBUTING.md for help getting started.

FAQ

BINARY DOWNLOAD

NIGHTLY BUILD

Get it on F-Droid

Free Public Servers

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

Location Vendor Specification
Germany Hetzner 2 vCPU / 4 GB RAM
Ukraine (Kyiv) dc.volia 2 vCPU / 4 GB RAM

Dev Container

Open in Dev Containers

If you already have VS Code and Docker installed, you can click the badge above to get started. Clicking will cause VS Code to automatically install the Dev Containers extension if needed, clone the source code into a container volume, and spin up a dev container for use.

Go through DEVCONTAINER.md for more info.

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

Snapshots

image

image

image

image

Pinned

  1. rustdesk rustdesk Public

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

    Rust 57.6k 6.2k

  2. rustdesk-server rustdesk-server Public

    RustDesk Server Program

    Rust 5.2k 1.1k

2,606 contributions in the last year

4 contributions on January 22nd.6 contributions on January 29th.9 contributions on February 5th.5 contributions on February 12th.4 contributions on February 19th.7 contributions on February 26th.4 contributions on March 5th.9 contributions on March 12th.4 contributions on March 19th.6 contributions on March 26th.2 contributions on April 2nd.6 contributions on April 9th.4 contributions on April 16th.2 contributions on April 23rd.3 contributions on April 30th.1 contribution on May 7th.6 contributions on May 14th.8 contributions on May 21st.1 contribution on May 28th.9 contributions on June 4th.7 contributions on June 11th.3 contributions on June 18th.6 contributions on June 25th.7 contributions on July 2nd.6 contributions on July 9th.16 contributions on July 16th.5 contributions on July 23rd.6 contributions on July 30th.13 contributions on August 6th.5 contributions on August 13th.4 contributions on August 20th.7 contributions on August 27th.10 contributions on September 3rd.11 contributions on September 10th.9 contributions on September 17th.5 contributions on September 24th.7 contributions on October 1st.2 contributions on October 8th.6 contributions on October 15th.12 contributions on October 22nd.5 contributions on October 29th.No contributions on November 5th.4 contributions on November 12th.5 contributions on November 19th.3 contributions on November 26th.7 contributions on December 3rd.No contributions on December 10th.No contributions on December 17th.No contributions on December 24th.No contributions on December 31st.5 contributions on January 7th.No contributions on January 14th.2 contributions on January 21st.4 contributions on January 23rd.11 contributions on January 30th.4 contributions on February 6th.13 contributions on February 13th.11 contributions on February 20th.14 contributions on February 27th.13 contributions on March 6th.11 contributions on March 13th.8 contributions on March 20th.7 contributions on March 27th.11 contributions on April 3rd.10 contributions on April 10th.7 contributions on April 17th.3 contributions on April 24th.4 contributions on May 1st.2 contributions on May 8th.1 contribution on May 15th.2 contributions on May 22nd.2 contributions on May 29th.21 contributions on June 5th.9 contributions on June 12th.1 contribution on June 19th.4 contributions on June 26th.16 contributions on July 3rd.23 contributions on July 10th.13 contributions on July 17th.6 contributions on July 24th.11 contributions on July 31st.6 contributions on August 7th.11 contributions on August 14th.10 contributions on August 21st.4 contributions on August 28th.7 contributions on September 4th.11 contributions on September 11th.8 contributions on September 18th.11 contributions on September 25th.4 contributions on October 2nd.3 contributions on October 9th.14 contributions on October 16th.2 contributions on October 23rd.9 contributions on October 30th.8 contributions on November 6th.7 contributions on November 13th.5 contributions on November 20th.3 contributions on November 27th.6 contributions on December 4th.8 contributions on December 11th.2 contributions on December 18th.1 contribution on December 25th.3 contributions on January 1st.2 contributions on January 8th.2 contributions on January 15th.No contributions on January 22nd.7 contributions on January 24th.4 contributions on January 31st.16 contributions on February 7th.11 contributions on February 14th.10 contributions on February 21st.19 contributions on February 28th.8 contributions on March 7th.12 contributions on March 14th.7 contributions on March 21st.4 contributions on March 28th.8 contributions on April 4th.4 contributions on April 11th.3 contributions on April 18th.10 contributions on April 25th.5 contributions on May 2nd.6 contributions on May 9th.9 contributions on May 16th.4 contributions on May 23rd.2 contributions on May 30th.9 contributions on June 6th.8 contributions on June 13th.12 contributions on June 20th.7 contributions on June 27th.19 contributions on July 4th.9 contributions on July 11th.9 contributions on July 18th.28 contributions on July 25th.10 contributions on August 1st.19 contributions on August 8th.7 contributions on August 15th.14 contributions on August 22nd.7 contributions on August 29th.6 contributions on September 5th.No contributions on September 12th.8 contributions on September 19th.11 contributions on September 26th.8 contributions on October 3rd.3 contributions on October 10th.5 contributions on October 17th.5 contributions on October 24th.8 contributions on October 31st.18 contributions on November 7th.5 contributions on November 14th.10 contributions on November 21st.3 contributions on November 28th.3 contributions on December 5th.No contributions on December 12th.No contributions on December 19th.6 contributions on December 26th.2 contributions on January 2nd.3 contributions on January 9th.No contributions on January 16th.1 contribution on January 23rd.1 contribution on January 25th.13 contributions on February 1st.17 contributions on February 8th.12 contributions on February 15th.8 contributions on February 22nd.16 contributions on March 1st.19 contributions on March 8th.15 contributions on March 15th.4 contributions on March 22nd.12 contributions on March 29th.3 contributions on April 5th.2 contributions on April 12th.5 contributions on April 19th.3 contributions on April 26th.1 contribution on May 3rd.1 contribution on May 10th.3 contributions on May 17th.7 contributions on May 24th.2 contributions on May 31st.15 contributions on June 7th.4 contributions on June 14th.13 contributions on June 21st.5 contributions on June 28th.17 contributions on July 5th.7 contributions on July 12th.9 contributions on July 19th.9 contributions on July 26th.4 contributions on August 2nd.10 contributions on August 9th.11 contributions on August 16th.21 contributions on August 23rd.12 contributions on August 30th.2 contributions on September 6th.13 contributions on September 13th.4 contributions on September 20th.5 contributions on September 27th.6 contributions on October 4th.6 contributions on October 11th.5 contributions on October 18th.6 contributions on October 25th.16 contributions on November 1st.No contributions on November 8th.4 contributions on November 15th.5 contributions on November 22nd.17 contributions on November 29th.7 contributions on December 6th.No contributions on December 13th.No contributions on December 20th.2 contributions on December 27th.3 contributions on January 3rd.9 contributions on January 10th.1 contribution on January 17th.No contributions on January 24th.3 contributions on January 26th.6 contributions on February 2nd.10 contributions on February 9th.16 contributions on February 16th.8 contributions on February 23rd.9 contributions on March 2nd.8 contributions on March 9th.11 contributions on March 16th.11 contributions on March 23rd.14 contributions on March 30th.9 contributions on April 6th.10 contributions on April 13th.12 contributions on April 20th.3 contributions on April 27th.7 contributions on May 4th.8 contributions on May 11th.6 contributions on May 18th.10 contributions on May 25th.2 contributions on June 1st.18 contributions on June 8th.1 contribution on June 15th.12 contributions on June 22nd.13 contributions on June 29th.7 contributions on July 6th.13 contributions on July 13th.6 contributions on July 20th.11 contributions on July 27th.5 contributions on August 3rd.12 contributions on August 10th.10 contributions on August 17th.6 contributions on August 24th.4 contributions on August 31st.7 contributions on September 7th.10 contributions on September 14th.9 contributions on September 21st.7 contributions on September 28th.5 contributions on October 5th.6 contributions on October 12th.7 contributions on October 19th.12 contributions on October 26th.6 contributions on November 2nd.21 contributions on November 9th.6 contributions on November 16th.9 contributions on November 23rd.12 contributions on November 30th.5 contributions on December 7th.1 contribution on December 14th.1 contribution on December 21st.No contributions on December 28th.1 contribution on January 4th.1 contribution on January 11th.No contributions on January 18th.3 contributions on January 25th.11 contributions on January 27th.8 contributions on February 3rd.21 contributions on February 10th.14 contributions on February 17th.8 contributions on February 24th.22 contributions on March 3rd.27 contributions on March 10th.7 contributions on March 17th.7 contributions on March 24th.10 contributions on March 31st.5 contributions on April 7th.3 contributions on April 14th.14 contributions on April 21st.7 contributions on April 28th.3 contributions on May 5th.20 contributions on May 12th.12 contributions on May 19th.No contributions on May 26th.1 contribution on June 2nd.17 contributions on June 9th.14 contributions on June 16th.15 contributions on June 23rd.7 contributions on June 30th.11 contributions on July 7th.6 contributions on July 14th.5 contributions on July 21st.6 contributions on July 28th.13 contributions on August 4th.15 contributions on August 11th.12 contributions on August 18th.14 contributions on August 25th.3 contributions on September 1st.5 contributions on September 8th.11 contributions on September 15th.No contributions on September 22nd.1 contribution on September 29th.16 contributions on October 6th.4 contributions on October 13th.21 contributions on October 20th.4 contributions on October 27th.8 contributions on November 3rd.No contributions on November 10th.2 contributions on November 17th.3 contributions on November 24th.7 contributions on December 1st.2 contributions on December 8th.No contributions on December 15th.1 contribution on December 22nd.1 contribution on December 29th.3 contributions on January 5th.No contributions on January 12th.4 contributions on January 19th.10 contributions on January 28th.3 contributions on February 4th.3 contributions on February 11th.7 contributions on February 18th.8 contributions on February 25th.13 contributions on March 4th.11 contributions on March 11th.5 contributions on March 18th.7 contributions on March 25th.14 contributions on April 1st.5 contributions on April 8th.3 contributions on April 15th.4 contributions on April 22nd.6 contributions on April 29th.9 contributions on May 6th.11 contributions on May 13th.4 contributions on May 20th.2 contributions on May 27th.2 contributions on June 3rd.9 contributions on June 10th.8 contributions on June 17th.10 contributions on June 24th.13 contributions on July 1st.6 contributions on July 8th.12 contributions on July 15th.6 contributions on July 22nd.5 contributions on July 29th.No contributions on August 5th.5 contributions on August 12th.10 contributions on August 19th.4 contributions on August 26th.4 contributions on September 2nd.1 contribution on September 9th.6 contributions on September 16th.4 contributions on September 23rd.5 contributions on September 30th.3 contributions on October 7th.14 contributions on October 14th.10 contributions on October 21st.8 contributions on October 28th.4 contributions on November 4th.6 contributions on November 11th.4 contributions on November 18th.1 contribution on November 25th.3 contributions on December 2nd.3 contributions on December 9th.No contributions on December 16th.No contributions on December 23rd.No contributions on December 30th.No contributions on January 6th.No contributions on January 13th.3 contributions on January 20th.
Contribution Graph
Day of Week January February March April May June July August September October November December January
Sunday
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday
Less
No contributions.
Low contributions.
Medium-low contributions.
Medium-high contributions.
High contributions.
More

Contribution activity

January 2024

Opened 1 pull request in 1 repository
rustdesk/rustdesk 1 merged
Reviewed 2 pull requests in 1 repository
rustdesk/rustdesk 2 pull requests

Created an issue in aws/s2n-quic that received 3 comments

Socks5 support

Is it possible to add Socks5 proxy support?

3 comments
Opened 4 other issues in 1 repository
rustdesk/uptime 1 open 3 closed
Answered 3 discussions in 1 repository
rustdesk/rustdesk

Seeing something unexpected? Take a look at the GitHub profile guide.