README-ZH.md

服务器 • 编译 • Docker • 结构 • 截图
[English] | [Español] | [Français] | [Deutsch] | [Nederlands] | [Polski] | [日本語] | [Русский] | [Português]

Chat with us: 知乎 | Discord | Reddit

远程桌面软件，开箱即用，无需任何配置。您完全掌控数据，不用担心安全问题。您可以使用我们的注册/中继服务器， 或者自己设置， 亦或者开发您的版本。

欢迎大家贡献代码， 请看 CONTRIBUTING.md.

可执行程序下载

免费公共服务器

以下是您免费使用的服务器，它可能会随着时间的推移而变化。如果您不靠近其中之一，您的网络可能会很慢。

• 首尔, AWS lightsail, 1 VCPU/0.5G RAM
• 新加坡, Vultr, 1 VCPU/1G RAM
• 达拉斯, Vultr, 1 VCPU/1G RAM

依赖

桌面版本界面使用sciter, 请自行下载。

Windows | Linux | macOS

基本构建步骤

• 请准备好 Rust 开发环境和 C++编译环境

• 安装vcpkg, 正确设置VCPKG_ROOT环境变量

  • Windows: vcpkg install libvpx:x64-windows-static libyuv:x64-windows-static opus:x64-windows-static
  • Linux/Osx: vcpkg install libvpx libyuv opus

• 运行 cargo run

在 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

安装 vcpkg

git clone https://github.com/microsoft/vcpkg
cd vcpkg
git checkout 134505003bb46e20fbace51ccfb69243fbbc5f82
cd ..
vcpkg/bootstrap-vcpkg.sh
export VCPKG_ROOT=$HOME/vcpkg
vcpkg/vcpkg install libvpx libyuv opus

修复 libvpx (仅仅针对 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

构建

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
cargo run

把 Wayland 修改成 X11 (Xorg)

RustDesk 暂时不支持 Wayland，不过正在积极开发中. 请查看this配置 X11.

使用 Docker 编译

首先克隆存储库并构建 docker 容器：

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

针对国内网络访问问题，可以做以下几点优化：

1. Dockerfile 中修改系统的源到国内镜像

   在Dockerfile的RUN apt update之前插入两行：
   
   RUN sed -i "s/deb.debian.org/mirrors.163.com/g" /etc/apt/sources.list
   RUN sed -i "s/security.debian.org/mirrors.163.com/g" /etc/apt/sources.list
   

2. 修改容器系统中的 cargo 源，在RUN ./rustup.sh -y后插入下面代码：

   RUN echo '[source.crates-io]' > ~/.cargo/config \
    && echo 'registry = "https://github.com/rust-lang/crates.io-index"'  >> ~/.cargo/config \
    && echo '# 替换成你偏好的镜像源'  >> ~/.cargo/config \
    && echo "replace-with = 'sjtu'"  >> ~/.cargo/config \
    && echo '# 上海交通大学'   >> ~/.cargo/config \
    && echo '[source.sjtu]'   >> ~/.cargo/config \
    && echo 'registry = "https://mirrors.sjtug.sjtu.edu.cn/git/crates.io-index"'  >> ~/.cargo/config \
    && echo '' >> ~/.cargo/config
   

3. Dockerfile 中加入代理的 env

   在User root后插入两行
   
   ENV http_proxy=http://host:port
   ENV https_proxy=http://host:port
   

4. docker build 命令后面加上 proxy 参数

   docker build -t "rustdesk-builder" . --build-arg http_proxy=http://host:port --build-arg https_proxy=http://host:port
   

然后，每次需要构建应用程序时，运行以下命令：

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

运行若遇到无权限问题，出现以下提示：

usermod: user user is currently used by process 1
groupmod: Permission denied.
groupmod: cannot lock /etc/group; try again later.

可以尝试把-e PUID="$(id -u)" -e PGID="$(id -g)"参数去掉。（出现这一问题的原因是容器中的 entrypoint 脚本中判定 uid 和 gid 与给定的环境变量不一致时会修改 user 的 uid 和 gid 重新运行，但是重新运行时取不到环境变量中的 uid 和 gid 了，会再次进入 uid 与 gid 与给定值不一致的逻辑分支）

请注意，第一次构建可能需要比较长的时间，因为需要缓存依赖项（国内网络经常出现拉取失败，可多尝试几次），后续构建会更快。此外，如果您需要为构建命令指定不同的参数， 您可以在命令末尾的 <OPTIONAL-ARGS> 位置执行此操作。例如，如果你想构建一个优化的发布版本，你可以在命令后跟 ---release。 将在 target 下产生可执行程序，请通过以下方式运行调试版本：

target/debug/rustdesk

或者运行发布版本:

target/release/rustdesk

请确保您从 RustDesk 存储库的根目录运行这些命令，否则应用程序可能无法找到所需的资源。另请注意，此方法当前不支持其他Cargo子命令， 例如 install 或 run，因为运行在容器里，而不是宿主机上。

文件结构

• libs/hbb_common: 视频编解码, 配置, tcp/udp 封装, protobuf, 文件传输相关文件系统操作函数, 以及一些其他实用函数
• libs/scrap: 截屏
• libs/enigo: 平台相关的鼠标键盘输入
• src/ui: GUI
• src/server: 被控端服务，audio/clipboard/input/video 服务, 已经连接实现
• src/client.rs: 控制端
• src/rendezvous_mediator.rs: 与rustdesk-server保持 UDP 通讯, 等待远程连接（通过打洞直连或者中继）
• src/platform: 平台服务相关代码

截图