mirror of
https://github.com/rustdesk/rustdesk.git
synced 2024-12-03 03:19:27 +08:00
277 lines
12 KiB
Markdown
277 lines
12 KiB
Markdown
<p align="center">
|
||
<img src="../res/logo-header.svg" alt="RustDesk - Your remote desktop"><br>
|
||
<a href="#免费的公共服务器">服务器</a> •
|
||
<a href="#基本构建步骤">编译</a> •
|
||
<a href="#使用-Docker-编译">Docker</a> •
|
||
<a href="#文件结构">结构</a> •
|
||
<a href="#截图">截图</a><br>
|
||
[<a href="../README.md">English</a>] | [<a href="README-UA.md">Українська</a>] | [<a href="README-CS.md">česky</a>] | [<a href="README-HU.md">Magyar</a>] | [<a href="README-ES.md">Español</a>] | [<a href="README-FA.md">فارسی</a>] | [<a href="README-FR.md">Français</a>] | [<a href="README-DE.md">Deutsch</a>] | [<a href="README-PL.md">Polski</a>] | [<a href="README-ID.md">Indonesian</a>] | [<a href="README-FI.md">Suomi</a>] | [<a href="README-ML.md">മലയാളം</a>] | [<a href="README-JP.md">日本語</a>] | [<a href="README-NL.md">Nederlands</a>] | [<a href="README-IT.md">Italiano</a>] | [<a href="README-RU.md">Русский</a>] | [<a href="README-PTBR.md">Português (Brasil)</a>] | [<a href="README-EO.md">Esperanto</a>] | [<a href="README-KR.md">한국어</a>] | [<a href="README-AR.md">العربي</a>] | [<a href="README-VN.md">Tiếng Việt</a>] | [<a href="README-GR.md">Ελληνικά</a>]<br>
|
||
</p>
|
||
|
||
Chat with us: [知乎](https://www.zhihu.com/people/rustdesk) | [Discord](https://discord.gg/nDceKgxnkV) | [Reddit](https://www.reddit.com/r/rustdesk)
|
||
|
||
[](https://ko-fi.com/I2I04VU09)
|
||
|
||
远程桌面软件，开箱即用，无需任何配置。您完全掌控数据，不用担心安全问题。您可以使用我们的注册/中继服务器，
|
||
或者[自己设置](https://rustdesk.com/server)，
|
||
亦或者[开发您的版本](https://github.com/rustdesk/rustdesk-server-demo)。
|
||
|
||
|
||
|
||
RustDesk 期待各位的贡献. 如何参与开发? 详情请看 [CONTRIBUTING.md](docs/CONTRIBUTING.md).
|
||
|
||
[**FAQ**](https://github.com/rustdesk/rustdesk/wiki/FAQ)
|
||
|
||
[**BINARY DOWNLOAD**](https://github.com/rustdesk/rustdesk/releases)
|
||
|
||
[**NIGHTLY BUILD**](https://github.com/rustdesk/rustdesk/releases/tag/nightly)
|
||
|
||
[<img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png"
|
||
alt="Get it on F-Droid"
|
||
height="80">](https://f-droid.org/en/packages/com.carriez.flutter_hbb)
|
||
|
||
## 免费的公共服务器
|
||
|
||
以下是您可以使用的、免费的、会随时更新的公共服务器列表，在国内也许网速会很慢或者无法访问。
|
||
|
||
| Location | Vendor | Specification |
|
||
| --------- | ------------- | ------------------ |
|
||
| Germany | [Hetzner](https://www.hetzner.com) | 2 vCPU / 4 GB RAM |
|
||
| Ukraine (Kyiv) | [dc.volia](https://dc.volia.com) | 2 vCPU / 4 GB RAM |
|
||
|
||
## Dev Container
|
||
|
||
[](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/rustdesk/rustdesk)
|
||
|
||
如果你已经安装了 VS Code 和 Docker, 你可以点击上面的徽章开始使用. 点击后, VS Code 将自动安装 Dev Containers 扩展（如果需要），将源代码克隆到容器卷中, 并启动一个 Dev 容器供使用.
|
||
|
||
Go through [DEVCONTAINER.md](docs/DEVCONTAINER.md) for more info.
|
||
|
||
## 依赖
|
||
|
||
桌面版本界面使用[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)
|
||
|
||
## 基本构建步骤
|
||
|
||
- 请准备好 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 aom:x64-windows-static
|
||
- Linux/macOS: vcpkg install libvpx libyuv opus aom
|
||
|
||
- 运行 `cargo run`
|
||
|
||
## [构建](https://rustdesk.com/docs/en/dev/build/)
|
||
|
||
## 在 Linux 上编译
|
||
|
||
### Ubuntu 18 (Debian 10)
|
||
|
||
```sh
|
||
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
|
||
|
||
```sh
|
||
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)
|
||
|
||
```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 2023.04.15
|
||
cd ..
|
||
vcpkg/bootstrap-vcpkg.sh
|
||
export VCPKG_ROOT=$HOME/vcpkg
|
||
vcpkg/vcpkg install libvpx libyuv opus aom
|
||
```
|
||
|
||
### 修复 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
|
||
VCPKG_ROOT=$HOME/vcpkg cargo run
|
||
```
|
||
|
||
### 把 Wayland 修改成 X11 (Xorg)
|
||
|
||
RustDesk 暂时不支持 Wayland，不过正在积极开发中。
|
||
> [点我](https://docs.fedoraproject.org/en-US/quick-docs/configuring-xorg-as-default-gnome-session/)
|
||
查看如何将 Xorg 设置成默认的 GNOME session.
|
||
|
||
## Wayland 支持
|
||
|
||
Wayland 似乎没有提供任何将按键发送到其他窗口的 API. 因此, RustDesk 使用较低级别的 API, 即 `/dev/uinput` devices (Linux kernal level).
|
||
|
||
当 Wayland 是受控方时，您必须以下列方式开始操作:
|
||
|
||
```bash
|
||
# Start uinput service
|
||
$ sudo rustdesk --service
|
||
$ rustdesk
|
||
```
|
||
|
||
**Notice**: Wayland 屏幕录制使用不同的接口. RustDesk 目前只支持 org.freedesktop.portal.ScreenCast.
|
||
|
||
```bash
|
||
$ dbus-send --session --print-reply \
|
||
--dest=org.freedesktop.portal.Desktop \
|
||
/org/freedesktop/portal/desktop \
|
||
org.freedesktop.DBus.Properties.Get \
|
||
string:org.freedesktop.portal.ScreenCast string:version
|
||
# Not support
|
||
Error org.freedesktop.DBus.Error.InvalidArgs: No such interface “org.freedesktop.portal.ScreenCast”
|
||
# Support
|
||
method return time=1662544486.931020 sender=:1.54 -> destination=:1.139 serial=257 reply_serial=2
|
||
variant uint32 4
|
||
```
|
||
|
||
## 使用 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 程序
|
||
|
||
然后, 每次需要构建应用程序时, 运行以下命令:
|
||
|
||
```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
|
||
```
|
||
|
||
请注意:
|
||
* 因为需要缓存依赖项，首次构建一般很慢（国内网络会经常出现拉取失败，可以多试几次）。
|
||
* 如果您需要添加不同的构建参数，可以在指令末尾的`<OPTIONAL-ARGS>` 位置进行修改。例如构建一个"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代码
|
||
|
||
## 截图
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|