rustdesk
An open-source remote desktop application designed for self-hosting, as an alternative to TeamViewer.
Top Related Projects
Quick Overview
RustDesk is an open-source remote desktop software written in Rust. It allows users to remotely access and control computers over a network, providing a secure and efficient alternative to commercial remote desktop solutions. RustDesk supports cross-platform functionality, enabling connections between various operating systems.
Pros
- Cross-platform compatibility (Windows, macOS, Linux, iOS, Android)
- Open-source and free to use
- Built with Rust, offering enhanced security and performance
- Self-hosted option available for increased privacy and control
Cons
- Relatively new project, may have fewer features compared to established solutions
- Documentation could be more comprehensive
- Limited third-party integrations
- May require more technical knowledge for self-hosting and advanced configurations
Getting Started
To get started with RustDesk:
- Download the appropriate installer for your operating system from the RustDesk releases page.
- Install the application on both the host (computer to be controlled) and client (computer controlling) machines.
- Launch RustDesk on both machines.
- On the host machine, note the ID displayed in the main window.
- On the client machine, enter the host's ID in the "ID" field and click "Connect".
- Accept the connection request on the host machine to establish the remote desktop session.
For self-hosting:
- Set up a RustDesk server using the provided server code.
- Configure the client and host machines to use your custom server address.
Note: RustDesk is not a code library, so code examples are not applicable in this case.
Competitor Comparisons
FreeRDP is a free remote desktop protocol library and clients
Pros of FreeRDP
- Mature project with extensive documentation and wide platform support
- Implements the Remote Desktop Protocol (RDP) standard, ensuring compatibility with Windows systems
- Offers a rich set of features including audio redirection, printer redirection, and multi-monitor support
Cons of FreeRDP
- More complex setup and configuration compared to RustDesk
- Primarily focused on RDP, limiting its use with non-Windows systems
- Steeper learning curve for new users due to its comprehensive feature set
Code Comparison
RustDesk (Rust):
let server = Server::new();
server.run("0.0.0.0:21118").await?;
FreeRDP (C):
freerdp_context* context = freerdp_client_context_new(instance);
freerdp_client_start(context);
Summary
RustDesk is a newer, cross-platform remote desktop solution written in Rust, focusing on ease of use and quick setup. It's suitable for personal and small business use, with built-in NAT traversal.
FreeRDP is a more established project, implementing the RDP protocol and offering advanced features. It's better suited for enterprise environments and integration with Windows systems, but requires more technical knowledge to set up and use effectively.
Both projects are open-source and actively maintained, with RustDesk gaining popularity for its simplicity and FreeRDP remaining a go-to choice for RDP implementations.
High performance, multi-platform VNC client and server
Pros of TigerVNC
- Mature and well-established project with a long history
- Supports a wide range of platforms and architectures
- Highly optimized for performance and low-latency connections
Cons of TigerVNC
- Requires more setup and configuration compared to RustDesk
- Less user-friendly interface for non-technical users
- Limited built-in security features, often requiring additional measures
Code Comparison
TigerVNC (C++):
rfb::ConnParams cp;
cp.setName("TigerVNC");
cp.supportsDesktopResize = true;
cp.supportsExtendedDesktopSize = true;
cp.supportsDesktopRename = true;
RustDesk (Rust):
let config = Config {
name: "RustDesk".to_string(),
enable_file_transfer: true,
enable_clipboard: true,
enable_audio: true,
};
TigerVNC focuses on core VNC functionality with traditional C++ implementation, while RustDesk leverages Rust's modern features and includes additional capabilities like file transfer and audio support out of the box. RustDesk aims for a more user-friendly experience with easier setup, but TigerVNC offers finer control and optimization for advanced users. Both projects have their strengths, with TigerVNC excelling in performance and compatibility, and RustDesk providing a more accessible and feature-rich solution for general users.
VNC client web application
Pros of noVNC
- Browser-based VNC client, requiring no installation on the client-side
- Supports a wide range of VNC servers and protocols
- Highly customizable and embeddable in web applications
Cons of noVNC
- Limited to VNC protocol, which may have performance limitations
- Requires a VNC server to be set up and running on the host machine
- May have higher latency compared to native remote desktop solutions
Code Comparison
noVNC (JavaScript):
var rfb = new RFB(document.getElementById('screen'), 'ws://example.com:5900');
rfb.scaleViewport = true;
rfb.resizeSession = true;
RustDesk (Rust):
let config = Config::load().unwrap_or_default();
let server = Server::new(config);
server.run().await?;
Key Differences
- RustDesk is a standalone remote desktop application, while noVNC is a VNC client implementation
- RustDesk uses its own protocol, potentially offering better performance and security
- noVNC focuses on browser-based access, while RustDesk provides native applications for various platforms
- RustDesk offers additional features like file transfer and remote sound, which are not typically available in VNC
Convert
designs to code with AI
Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.
Try Visual CopilotREADME
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 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_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 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
Screenshots
Top Related Projects
Convert
designs to code with AI
Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.
Try Visual Copilot