RustDesk 构建实战:从 vcpkg 依赖、Linux 原生编译到 Docker 构建的完整指南

RustDesk 构建实战:从 vcpkg 依赖、Linux 原生编译到 Docker 构建的完整指南

【免费下载链接】rustdeskAn open-source remote desktop application designed for self-hosting, as an alternative to TeamViewer.项目地址: https://gitcode.com/GitHub_Trending/ru/rustdesk

本篇指南围绕 RustDesk 仓库中的 韩国语 README 展开,系统讲解如何从源码构建这款用 Rust 编写的自托管远程桌面应用:包括 vcpkg 原生库准备、各 Linux 发行版的系统依赖安装、Docker 容器化构建的完整流程,以及仓库各源码模块的职责划分。读完后,你能够独立完成一次从干净环境到可运行二进制的完整构建,并理解每个构建步骤背后的源码依据。

项目定位与构建入口

RustDesk 是一个开源远程桌面方案,定位为 TeamViewer 的自托管替代品:数据完全掌握在自己手中,可以直接使用官方 rendezvous/relay 服务器,也可以自行部署服务器或编写自己的服务器。它支持无配置直接连接,也支持完整的私有化部署。

当前仓库版本的构建入口由 Cargo.toml 定义,几个关键事实如下:

• 包名rustdesk,版本1.4.9,default-run = "rustdesk",因此直接cargo run/cargo build就会构建主程序;
• rust-version = "1.75",即 Rust 工具链的最低要求为 1.75;
• 工作区成员(Cargo.toml 的[workspace]段)包含libs/scrap、libs/hbb_common、libs/enigo、libs/clipboard、libs/virtual_display(及其dylib子 crate)、libs/portable、libs/remote_printer等;
• 库目标同时产出cdylib、staticlib、rlib,供 Flutter 前端等不同宿主链接使用;
• 额外还编译两个辅助二进制:naming(对应 src/naming.rs)和service(对应 src/service.rs)。

桌面端 GUI 使用 Flutter 或 Sciter。官方文档标注 Sciter 已被弃用,但当前构建流程仍会准备libsciter-gtk.so动态库(Dockerfile 与 Docker 构建入口脚本都会拷贝它),构建产物在运行 Sciter UI 路径时仍可能依赖该库。

构建前置条件:Rust、C++ 与 vcpkg

构建 RustDesk 需要准备三类环境:Rust 开发环境、C/C++ 构建环境、vcpkg 原生依赖。

Rust 与 C++ 环境

• Rust 工具链:rustup安装,要求版本不低于 1.75;
• C/C++ 工具链:gcc/g++ 或 clang。vcpkg 默认优先使用 clang 构建 C 代码(可通过VCPKG_FORCE_SYSTEM_BINARIES控制,见下文 Docker 部分)。

vcpkg 原生依赖

vcpkg 负责提供视频/音频编解码相关的原生库。先安装 vcpkg 并正确设置VCPKG_ROOT环境变量,然后按平台执行:

# 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

仓库根目录的 vcpkg.json 是完整依赖清单,它声明的核心依赖与文档中手动安装的四件套(libvpx、libyuv、opus、aom)一致,此外还包含:

• libjpeg-turbo、libsodium(仅 Windows ARM64)、mfx-dispatch(Intel 硬件编解码分发);
• ffmpeg,并按平台启用amf(AMD)、nvcodec(NVIDIA)、qsv(Intel,仅 Windows)等特性;
• 通过overlay-ports指向 res/vcpkg 目录的定制端口(包括 aom、ffmpeg、libvpx、libyuv 等打过补丁的版本),通过overlay-triplets指向 res/vcpkg-triplets 的 Android 交叉编译 triplet。

准备好环境后,最简单的本地构建命令就是:

cargo run

按发行版安装系统依赖(Linux)

不同发行版需要的开发包名称不同,官方 README 给出了四套命令,均保持完整可复制:

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 gstreamer1-devel gstreamer1-plugins-base-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

从依赖集合可以看出编译期需要的能力:nasm/yasm用于汇编(编解码器),libxcb-*/libxfixes/libxdo对应 X11 屏幕抓取与输入模拟(对应 libs/scrap 与 libs/enigo 的 Linux 实现),libasound2-dev/libpulse-dev对应音频采集,gstreamer与gtk3则支撑 Linux 平台的多媒体与窗口集成。Cargo.toml 的 Linux 目标依赖也印证了这一点,例如libxdo-sys、pulse(libpulse-simple-binding)、dbus、gtk = "0.18"等。值得注意的是,[patch.crates-io]将libxdo-sys打补丁到本地 libs/libxdo-sys-stub,使项目可以在未安装 libxdo 的系统(如纯 Wayland 环境)上编译。

vcpkg 安装与 Fedora 的 libvpx 修补

Linux 下安装 vcpkg 的官方步骤(固定在2023.04.15版本,与 Dockerfile 中的版本一致):

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

Fedora 上 libvpx 构建产物缺省不带-fPIC,需要手动修补后重新编译:

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

这一步的原因:共享库和会被链入动态库的静态库必须带位置无关代码(PIC)属性,Fedora 的 GCC 默认行为与 Debian 不同,导致 libvpx 静态库链接失败。

原生完整构建流程

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

几个容易踩坑的细节:

• --recurse-submodules不可省略:核心 cratelibs/hbb_common(视频编解码封装、配置、tcp/udp wrapper、protobuf、文件传输的 fs 函数等)是 git 子模块,若未初始化则工作区成员目录为空,构建直接失败;
• Sciter 动态库需要放在目标输出目录(这里放在target/debug),否则运行期加载 Sciter UI 会失败;
• VCPKG_ROOT必须指向 vcpkg 安装目录,cargo 构建脚本据此找到原生库。

Docker 构建方式

Docker 路径适合不想在宿主机安装整套工具链的场景。仓库根目录提供了 Dockerfile,基础镜像为debian:bullseye-slim,容器内一次性装好:gcc/g++、git、curl、nasm、yasm、libgtk-3-dev、clang、各 libxcb/libxfixes/libxdo 开发包、libasound2/libpulse、gstreamer、ninja-build,并从源码编译 CMake 3.30.6,再安装 vcpkg2023.04.15及libvpx libyuv opus aom,同时预下载libsciter-gtk.so、安装 rustup 工具链。构建步骤:

git clone https://github.com/rustdesk/rustdesk cd rustdesk git submodule update --init --recursive docker build -t "rustdesk-builder" .

之后每次构建执行:

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

参数含义:

• -v $PWD:/home/user/rustdesk:把宿主机仓库挂载到容器工作目录,构建结果直接写回宿主机;
• 两个 cargo 命名卷缓存:git 依赖与 registry 缓存跨构建复用,首次构建需编译全部依赖,速度较慢,之后显著加快;
• PUID/PGID:让容器内user的 UID/GID 与宿主一致,避免产物文件属主问题。

传入docker run的额外参数由仓库根目录的 entrypoint.sh 处理,其逻辑从源码看非常清晰:

• --release:设置 release 模式,并把libsciter-gtk.so拷贝到target/release/;
• --target <triple>:调用rustup target add支持交叉编译;
• 其余参数原样透传给最终命令:

VCPKG_ROOT=/vcpkg cargo build --locked $argv

即最终执行的是cargo build --locked,保证依赖版本锁定。构建产物在宿主机仓库目录中:

target/debug/rustdesk # 默认(debug)构建 target/release/rustdesk # 追加 --release 参数

两个注意事项(来自文档与源码行为):

• 命令必须在仓库根目录执行,否则应用可能找不到所需资源;
• cargo install、cargo run这类子命令不受支持,因为容器入口固定执行cargo build,而安装/运行发生在容器内而非宿主机上。

另外 Cargo.toml 的[profile.release]启用了lto = true、codegen-units = 1、panic = 'abort'、strip = true,release 构建会做链接期优化并裁剪符号,产物体积更小,但编译耗时也更长。

可选编译特性

除--release外,cargo 的 feature 开关决定了构建出的二进制包含哪些能力(Cargo.toml[features]段):

例如只构建 DRM 抓取路径而不包含显示唤醒代码,可使用--features drm;包含唤醒逻辑则用--features drm-wake。

仓库文件结构与核心模块

文档给出的文件结构是理解 RustDesk 代码组织的地图,以下各条目均与仓库实际目录对应,并结合源码做了补充:

• libs/hbb_common:视频编解码封装、配置、tcp/udp wrapper、protobuf、文件传输的 fs 函数及通用工具。该目录是 git 子模块(见 .gitmodules),克隆后需执行git submodule update --init --recursive初始化;
• libs/scrap:屏幕抓取,按平台拆分为 x11、wayland、quartz(macOS)、dxgi/watermark 等抓取源,并提供 vpx、aom、mediacodec、drm 等编解码/采集后端;
• libs/enigo:跨平台键盘/鼠标控制,含 linux(nix/xdo)、macos、win 三套实现与 DSL 封装;
• libs/clipboard:Windows、Linux、macOS 的文件与文本剪贴板实现;
• src/ui:已弃用的 Sciter UI(tis/html/css 与 cm.rs、remote.rs 等);
• src/server:音频/剪贴板/输入/视频服务与网络连接,包括 video_service.rs、audio_service.rs、input_service.rs、display_service.rs、clipboard_service.rs 等;
• src/client.rs:客户端连接发起入口,其中的pub async fn start(...)(src/client.rs#L181)负责建立与被控端的会话;
• src/rendezvous_mediator.rs:与 rendezvous/relay 服务器通信,等待直连(TCP 打洞成功)或中继连接建立——该文件是 NAT 穿透逻辑的核心;
• src/platform:平台相关代码,含 windows(ACL、MSI 注册表、服务交互)、macos、linux、特权安装脚本等;
• flutter:桌面与移动端 Flutter 前端,lib/下按desktop、mobile、models、utils等模块组织,通过flutter_rust_bridge与 Rust 核心通信。

从源码结构看,一次远程会话的路径大致是:Flutter UI 经 FFI 调用src/client.rs::start发起连接,由rendezvous_mediator.rs向服务器发起 rendezvous 握手并完成打洞/中继协商,成功后客户端与 src/server 中各服务模块(视频、音频、输入、剪贴板)建立对应通道。

小结与验证要点

按本文流程构建时,可逐项自检:

1. VCPKG_ROOT已导出且 vcpkg 中四个核心库安装成功(libvpx、libyuv、opus、aom);
2. 子模块已初始化,libs/hbb_common目录非空;
3. Sciter 动态库已放入target/debug(或target/release);
4. 产物target/debug/rustdesk或target/release/rustdesk可执行,且执行位置为仓库根目录。

整套构建链(原生 + Docker)都以当前仓库的 Dockerfile、entrypoint.sh、vcpkg.json 与 Cargo.toml 为准;若仓库更新导致依赖版本变化,请以这些文件中的实际声明为准。

【免费下载链接】rustdeskAn open-source remote desktop application designed for self-hosting, as an alternative to TeamViewer.项目地址: https://gitcode.com/GitHub_Trending/ru/rustdesk