rustdesk/README.md

108 lines
5.0 KiB
Markdown
Raw Normal View History

2021-03-31 17:51:55 +03:00
# RustDesk | Your Remote Desktop Software
2020-09-28 18:36:10 +03:00
2021-06-02 04:55:38 +03:00
Chat with us: [Discord](https://discord.gg/nDceKgxnkV)
2021-06-07 07:44:19 +03:00
[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/I2I04VU09)
2021-06-17 06:41:21 +03:00
Yet another remote desktop software, written in Rust. Works out of the box, no configuration required. Great alternative to TeamViewer and AnyDesk! You have full control of your data, with no concerns about security. You can use our rendezvous/relay server, [set up your own](https://rustdesk.com/blog/id-relay-set/), or [write your own rendezvous/relay server](https://github.com/rustdesk/rustdesk-server-demo).
2020-09-28 18:36:10 +03:00
2021-06-07 08:44:21 +03:00
RustDesk welcomes contribution from everyone. See [`CONTRIBUTING.md`](CONTRIBUTING.md) for help getting started.
2021-03-29 10:59:14 +03:00
[**BINARY DOWNLOAD**](https://github.com/rustdesk/rustdesk/releases)
2021-06-17 07:55:11 +03:00
## Free Public Servers
Below are the servers you are using for free, it may change along the time. If you are not close to one of these, your network may be slow.
- Seoul, AWS lightsail, 1 VCPU/0.5G RAM
- Singapore, Vultr, 1 VCPU/1G RAM
- Virginia, AWS EC2, 4 VCPUs/32G RAM, donated by [tensorsurgical.com](tensorsurgical.com)
2021-05-09 17:29:25 +03:00
## Dependencies
2021-03-29 10:59:14 +03:00
Desktop versions use [sciter](https://sciter.com/) for GUI, please download sciter dynamic library yourself.
2021-06-10 15:41:00 +03:00
[Windows](https://github.com/c-smile/sciter-sdk/blob/dc65744b66389cd5a0ff6bdb7c63a8b7b05a708b/bin.win/x64/sciter.dll) |
[Linux](https://github.com/c-smile/sciter-sdk/raw/dc65744b66389cd5a0ff6bdb7c63a8b7b05a708b/bin.lnx/x64/libsciter-gtk.so) |
[macOS](https://github.com/c-smile/sciter-sdk/raw/dc65744b66389cd5a0ff6bdb7c63a8b7b05a708b/bin.osx/sciter-osx-64.dylib)
2021-03-29 10:59:14 +03:00
2021-05-01 10:57:58 +03:00
## Raw steps to build
2021-03-29 10:59:14 +03:00
* Prepare your Rust development env and C++ build env
2021-04-15 05:25:51 +03:00
* Install [vcpkg](https://github.com/microsoft/vcpkg), and set `VCPKG_ROOT` env variable correctly
2021-03-29 10:59:14 +03:00
- Windows: vcpkg install libvpx:x64-windows-static libyuv:x64-windows-static opus:x64-windows-static
- Linux/Osx: vcpkg install libvpx libyuv opus
2021-04-15 05:25:51 +03:00
* run `cargo run`
2021-04-29 19:33:37 +03:00
## How to build on Linux
2021-05-09 17:29:25 +03:00
### Ubuntu 18 (Debian 10)
2021-04-29 19:33:37 +03:00
```
2021-04-30 18:47:44 +03:00
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
2021-04-29 19:33:37 +03:00
```
2021-05-01 19:37:32 +03:00
### Fedora 28 (CentOS 8)
2021-04-29 19:33:37 +03:00
```
2021-05-01 10:57:58 +03:00
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
2021-04-29 19:33:37 +03:00
```
2021-05-01 10:57:58 +03:00
### 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
2021-05-01 10:57:58 +03:00
```
### Install vcpkg
2021-04-29 06:49:30 +03:00
```
2021-04-29 19:33:37 +03:00
git clone https://github.com/microsoft/vcpkg --branch 2020.11-1
2021-04-29 06:49:30 +03:00
vcpkg/bootstrap-vcpkg.sh
export VCPKG_ROOT=$HOME/vcpkg
vcpkg/vcpkg install libvpx libyuv opus
2021-04-29 19:33:37 +03:00
```
### 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
```
2021-04-29 06:49:30 +03:00
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://github.com/c-smile/sciter-sdk/raw/dc65744b66389cd5a0ff6bdb7c63a8b7b05a708b/bin.lnx/x64/libsciter-gtk.so
mv libsciter-gtk.so target/debug
cargo run
```
2021-03-29 10:59:14 +03:00
2021-04-29 19:41:20 +03:00
### Change Wayland to X11 (Xorg)
RustDesk does not support Wayland. Check [this](https://docs.fedoraproject.org/en-US/quick-docs/configuring-xorg-as-default-gnome-session/) to configuring Xorg as the default GNOME session.
2021-03-29 10:59:14 +03:00
## File Structure
- **[libs/hbb_common](https://github.com/rustdesk/rustdesk/tree/master/libs/hbb_common)**: video codec, config, tcp/udp wrapper, protobuf, fs functions for file transfer, and some other utility functions
- **[libs/scrap](https://github.com/rustdesk/rustdesk/tree/master/libs/scrap)**: screen capture
- **[libs/enigo](https://github.com/rustdesk/rustdesk/tree/master/libs/enigo)**: platform specific keyboard/mouse control
- **[src/ui](https://github.com/rustdesk/rustdesk/tree/master/src/ui)**: GUI
- **[src/server](https://github.com/rustdesk/rustdesk/tree/master/src/server)**: audio/clipboard/input/video services, and network connections
- **[src/client.rs](https://github.com/rustdesk/rustdesk/tree/master/src/client.rs)**: start a peer connection
- **[src/rendezvous_mediator.rs](https://github.com/rustdesk/rustdesk/tree/master/src/rendezvous_mediator.rs)**: Communicate with [rustdesk-server](https://github.com/rustdesk/rustdesk-server), wait for remote direct (TCP hole punching) or relayed connection
- **[src/platform](https://github.com/rustdesk/rustdesk/tree/master/src/platform)**: platform specific code
2021-03-31 11:07:34 +03:00
## Snapshot
2021-03-31 11:16:30 +03:00
![image](https://user-images.githubusercontent.com/71636191/113112362-ae4deb80-923b-11eb-957d-ff88daad4f06.png)
2021-03-31 11:07:34 +03:00
2021-03-31 11:16:30 +03:00
![image](https://user-images.githubusercontent.com/71636191/113112619-f705a480-923b-11eb-911d-97e984ef52b6.png)
2021-03-31 11:07:34 +03:00
2021-03-31 11:16:30 +03:00
![image](https://user-images.githubusercontent.com/71636191/113112857-3fbd5d80-923c-11eb-9836-768325faf906.png)
![image](https://user-images.githubusercontent.com/71636191/113112990-65e2fd80-923c-11eb-840e-349b4d6e340d.png)