# 本应用相关 # **注意事项** - 运行完容器后需要获取当前数据目录"./data/hbbs"下的key，方便客户端使用。 ``` # 面板的话在文件管理里查看即可 # 终端的话输入以下获得 cat ./data/hbbs/id_ed25519.pub ``` - 如果要更改key，请删除"./data/hbbs"和"./data/hbbr"文件夹下的"id_ed25519"和"id_ed25519.pub"文件并重新启动 hbbs/hbbr，hbbs将会产生新的密钥对。 # 原项目说明

RustDesk - Your remote desktop
服务器 • 编译 • Docker • 结构 • 截图
[English] | [Українська] | [česky] | [Magyar] | [Español] | [فارسی] | [Français] | [Deutsch] | [Polski] | [Indonesian] | [Suomi] | [മലയാളം] | [日本語] | [Nederlands] | [Italiano] | [Русский] | [Português (Brasil)] | [Esperanto] | [한국어] | [العربي] | [Tiếng Việt] | [Ελληνικά]

Chat with us: [知乎](https://www.zhihu.com/people/rustdesk) | [Discord](https://discord.gg/nDceKgxnkV) | [Reddit](https://www.reddit.com/r/rustdesk) [![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/I2I04VU09) 远程桌面软件，开箱即用，无需任何配置。您完全掌控数据，不用担心安全问题。您可以使用我们的注册/中继服务器， 或者[自己设置](https://rustdesk.com/server)， 亦或者[开发您的版本](https://github.com/rustdesk/rustdesk-server-demo)。 欢迎大家贡献代码， 请看 [`docs/CONTRIBUTING.md`](CONTRIBUTING.md). [**可执行程序下载**](https://github.com/rustdesk/rustdesk/releases) ## 免费的公共服务器 以下是您可以使用的、免费的、会随时更新的公共服务器列表，在国内也许网速会很慢或者无法访问。 | Location | Vendor | Specification | | --------- | ------------- | ------------------ | | Seoul | AWS lightsail | 1 vCPU / 0.5GB RAM | | Germany | Hetzner | 2 vCPU / 4GB RAM | | Germany | Codext | 4 vCPU / 8GB RAM | | Finland (Helsinki) | 0x101 Cyber Security | 4 vCPU / 8GB RAM | | USA (Ashburn) | 0x101 Cyber Security | 4 vCPU / 8GB RAM | ## 依赖 桌面版本界面使用[sciter](https://sciter.com/), 请自行下载。 [Windows](https://raw.githubusercontent.com/c-smile/sciter-sdk/master/bin.win/x64/sciter.dll) | [Linux](https://raw.githubusercontent.com/c-smile/sciter-sdk/master/bin.lnx/x64/libsciter-gtk.so) | [macOS](https://raw.githubusercontent.com/c-smile/sciter-sdk/master/bin.osx/libsciter.dylib) 移动版本使用Flutter，未来会将桌面版本从Sciter迁移到Flutter。 ## 基本构建步骤 - 请准备好 Rust 开发环境和 C++编译环境 - 安装[vcpkg](https://github.com/microsoft/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` ## [构建](https://rustdesk.com/docs/en/dev/build/) ## 在 Linux 上编译 ### Ubuntu 18 (Debian 10) ```sh 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) ```sh 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) ```sh sudo pacman -Syu --needed unzip git cmake gcc curl wget yasm nasm zip make pkg-config clang gtk3 xdotool libxcb libxfixes alsa-lib pipewire ``` ### 安装 vcpkg ```sh git clone https://github.com/microsoft/vcpkg cd vcpkg git checkout 2021.12.01 cd .. vcpkg/bootstrap-vcpkg.sh export VCPKG_ROOT=$HOME/vcpkg vcpkg/vcpkg install libvpx libyuv opus ``` ### 修复 libvpx (仅仅针对 Fedora) ```sh 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 ``` ### 构建 ```sh 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，不过正在积极开发中。 > [点我](https://docs.fedoraproject.org/en-US/quick-docs/configuring-xorg-as-default-gnome-session/) 查看 如何将Xorg设置成默认的GNOME session ## 使用 Docker 编译 ### 构建Docker容器 ```sh git clone https://github.com/rustdesk/rustdesk # 克隆Github存储库 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 ``` ### 构建RustDesk程序 容器构建完成后，运行下列指令以完成对RustDesk应用程序的构建： ```sh 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 ``` 请注意: * 因为需要缓存依赖项，首次构建一般很慢（国内网络会经常出现拉取失败，可以多试几次）。 * 如果您需要添加不同的构建参数，可以在指令末尾的`` 位置进行修改。例如构建一个"Release"版本，在指令后面加上` --release`即可。 * 如果出现以下的提示，则是无权限问题，可以尝试把`-e PUID="$(id -u)" -e PGID="$(id -g)"`参数去掉。 ``` usermod: user user is currently used by process 1 groupmod: Permission denied. groupmod: cannot lock /etc/group; try again later. ``` > **原因：** 容器的entrypoint脚本会检测UID和GID，在度判和给定的环境变量的不一致时，会强行修改user的UID和GID并重新运行。但在重启后读不到环境中的UID和GID，然后再次进入判错重启环节 ### 运行RustDesk程序 生成的可执行程序在target目录下，可直接通过指令运行调试(Debug)版本的RustDesk: ```sh target/debug/rustdesk ``` 或者您想运行发行(Release)版本: ```sh target/release/rustdesk ``` 请注意： * 请保证您运行的目录是在RustDesk库的根目录内，否则软件会读不到文件。 * `install`、`run`等Cargo的子指令在容器内不可用，宿主机才行。 ## 文件结构 - **[libs/hbb_common](https://github.com/rustdesk/rustdesk/tree/master/libs/hbb_common)**: 视频编解码, 配置, tcp/udp 封装, protobuf, 文件传输相关文件系统操作函数, 以及一些其他实用函数 - **[libs/scrap](https://github.com/rustdesk/rustdesk/tree/master/libs/scrap)**: 屏幕截取 - **[libs/enigo](https://github.com/rustdesk/rustdesk/tree/master/libs/enigo)**: 平台相关的鼠标键盘输入 - **[src/ui](https://github.com/rustdesk/rustdesk/tree/master/src/ui)**: GUI - **[src/server](https://github.com/rustdesk/rustdesk/tree/master/src/server)**: 被控端服务音频、剪切板、输入、视频服务、网络连接的实现 - **[src/client.rs](https://github.com/rustdesk/rustdesk/tree/master/src/client.rs)**: 控制端 - **[src/rendezvous_mediator.rs](https://github.com/rustdesk/rustdesk/tree/master/src/rendezvous_mediator.rs)**: 与[rustdesk-server](https://github.com/rustdesk/rustdesk-server)保持UDP通讯, 等待远程连接（通过打洞直连或者中继） - **[src/platform](https://github.com/rustdesk/rustdesk/tree/master/src/platform)**: 平台服务相关代码 - **[flutter](https://github.com/rustdesk/rustdesk/tree/master/flutter)**: 移动版本的Flutter代码 - **[flutter/web/js](https://github.com/rustdesk/rustdesk/tree/master/flutter/web/js)**: Flutter Web版本中的Javascript代码 ## 截图 ![image](https://user-images.githubusercontent.com/71636191/113112362-ae4deb80-923b-11eb-957d-ff88daad4f06.png) ![image](https://user-images.githubusercontent.com/71636191/113112619-f705a480-923b-11eb-911d-97e984ef52b6.png) ![image](https://user-images.githubusercontent.com/71636191/113112857-3fbd5d80-923c-11eb-9836-768325faf906.png) ![image](https://user-images.githubusercontent.com/71636191/135385039-38fdbd72-379a-422d-b97f-33df71fb1cec.png)