RustDesk

https://rustdesk.com/docs/en
Admin
Open source remote control software for self-hosting with full data control and minimal...
Tokens:49,749
Snippets:724
Trust Score:10
Update:4 months ago
Show doc for...
Tokens:
Raw
### Install RustDesk Server with Docker

Source: https://rustdesk.com/docs/en/self-host/rustdesk-server-oss/install

Installs Docker, downloads the RustDesk Server OSS configuration, and starts the server using Docker Compose.

```bash
bash <(wget -qO- https://get.docker.com)
wget rustdesk.com/oss.yml -O compose.yml
sudo docker compose up -d
```

--------------------------------

### Install RustDesk with Batch Script (Windows CMD)

Source: https://rustdesk.com/docs/en/self-host/client-deployment

This batch script automates the download, silent installation, and service setup for RustDesk on Windows. It generates a random password and allows configuration via a provided string. Ensure `curl` is available in your PATH.

```batch
@echo off

REM Assign the value random password to the password variable
setlocal ENABLEEXTENSIONS ENABLEDELAYEDEXPANSION
set alfanum=ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789
set rustdesk_pw=
for /L %%b in (1, 1, 12) do (
    set /A rnd_num=!RANDOM! %% 62
    for %%c in (!rnd_num!) do (
        set rustdesk_pw=!rustdesk_pw!!alfanum:~%%c,1!
    )
)

REM Get your config string from your Web portal and Fill Below
set rustdesk_cfg="configstring"

REM ############################### Please Do Not Edit Below This Line #########################################

if not exist C:\Temp\ md C:\Temp\
cd C:\Temp\

curl -L "https://github.com/rustdesk/rustdesk/releases/download/1.2.6/rustdesk-1.2.6-x86_64.exe" -o rustdesk.exe

rustdesk.exe --silent-install
timeout /t 20

cd "C:\Program Files\RustDesk\"
rustdesk.exe --install-service
timeout /t 20

for /f "delims=" %%i in ('rustdesk.exe --get-id ^| more') do set rustdesk_id=%%i

rustdesk.exe --config %rustdesk_cfg%

rustdesk.exe --password %rustdesk_pw%

echo ...............................................
REM Show the value of the ID Variable
echo RustDesk ID: %rustdesk_id%

REM Show the value of the Password Variable
echo Password: %rustdesk_pw%
echo ...............................................
```

--------------------------------

### Install Docker and RustDesk Server Pro

Source: https://rustdesk.com/docs/en/self-host/rustdesk-server-pro

Installs Docker and then deploys RustDesk Server Pro using a provided compose file. Ensure Docker is installed before running.

```bash
bash <(wget -qO- https://get.docker.com)
wget rustdesk.com/pro.yml -O compose.yml
sudo docker compose up -d
```

--------------------------------

### Install vcpkg dependencies

Source: https://rustdesk.com/docs/en/dev/build/windows

Clone vcpkg, bootstrap it, and install necessary static libraries for Windows x64. Ensure Git is installed and run these commands in Git Bash.

```bash
git clone https://github.com/microsoft/vcpkg
vcpkg/bootstrap-vcpkg.bat
export VCPKG_ROOT=$PWD/vcpkg
vcpkg/vcpkg install libvpx:x64-windows-static libyuv:x64-windows-static opus:x64-windows-static aom:x64-windows-static
```

--------------------------------

### Apply Configuration via Command Line

Source: https://rustdesk.com/docs/en/self-host/client-configuration

Use the `--config` command-line argument to apply a configuration string non-interactively during scripted setup. This is useful for managed installs and automation.

```bash
rustdesk.exe --config <config-string>
```

--------------------------------

### Install RustDesk Server Pro using install.sh

Source: https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/installscript

Installs RustDesk Server Pro using the provided installation script. This method is for Linux administrators who prefer native systemd services.

```bash
bash <(wget -qO- https://raw.githubusercontent.com/rustdesk/rustdesk-server-pro/main/install.sh)
```

--------------------------------

### Silent MSI Installation with Parameters

Source: https://rustdesk.com/docs/en/client/windows/msi

Use this command for a silent installation, specifying the installation path, and controlling shortcut and printer creation. The /l*v flag logs the installation process.

```bash
msiexec /i RustDesk-1.msi /qn INSTALLFOLDER="D:\Program Files\RustDesk" CREATESTARTMENUSHORTCUTS="Y" CREATEDESKTOPSHORTCUTS="N" INSTALLPRINTER="N" /l*v install.log
```

--------------------------------

### Install Nginx on openSUSE

Source: https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/faq

Command to install Nginx on openSUSE systems.

```bash
sudo zypper install nginx
```

--------------------------------

### Download and Install RustDesk on macOS

Source: https://rustdesk.com/docs/en/self-host/client-deployment

This script downloads the correct RustDesk DMG for your macOS architecture (ARM64 or x86_64), mounts it, copies the application to /Applications, and then unmounts the DMG. It also handles running RustDesk with specific commands for getting the ID and setting a password.

```bash
echo "Downloading RustDesk Now"

if [[ $(arch) == 'arm64' ]]; then
    rd_link=$(curl -sL https://github.com/rustdesk/rustdesk/releases/latest | grep -Eo "(http|https)://[a-zA-Z0-9./?=_-]*/\d{1}.\d{1,2}.\d{1,2}/rustdesk.\d{1}.\d{1,2}.\d{1,2}.aarch64.dmg")
    dmg_file=$(echo $rd_link | grep -Eo "rustdesk.\d{1}.\d{1,2}.\d{1,2}.aarch64.dmg")
    curl -L "$rd_link" --output "$dmg_file"
else
    rd_link=$(curl -sL https://github.com/rustdesk/rustdesk/releases/latest | grep -Eo "(http|https)://[a-zA-Z0-9./?=_-]*/\d{1}.\d{1,2}.\d{1,2}/rustdesk.\d{1}.\d{1,2}.\d{1,2}.x86_64.dmg")
    dmg_file=$(echo $rd_link | grep -Eo "rustdesk.\d{1}.\d{1,2}.\d{1,2}.x86_64.dmg")
    curl -L "$rd_link" --output "$dmg_file"
fi

# Mount the DMG file to the specified mount point
hdiutil attach "$dmg_file" -mountpoint "$mount_point" &> /dev/null

# Check if the mounting was successful
if [ $? -eq 0 ]; then
    # Move the contents of the mounted DMG to the /Applications folder
    cp -R "$mount_point/RustDesk.app" "/Applications/" &> /dev/null

    # Unmount the DMG file
    hdiutil detach "$mount_point" &> /dev/null
else
    echo "Failed to mount the RustDesk DMG. Installation aborted."
    exit 1
fi

# Run the rustdesk command with --get-id and store the output in the rustdesk_id variable
cd /Applications/RustDesk.app/Contents/MacOS/
rustdesk_id=$(./RustDesk --get-id)

# Apply new password to RustDesk
./RustDesk --server & 
/Applications/RustDesk.app/Contents/MacOS/RustDesk --password $rustdesk_pw &> /dev/null

/Applications/RustDesk.app/Contents/MacOS/RustDesk --config $rustdesk_cfg

# Kill all processes named RustDesk
rdpid=$(pgrep RustDesk)
kill $rdpid &> /dev/null

echo "...............................................".
# Check if the rustdesk_id is not empty
if [ -n "$rustdesk_id" ]; then
    echo "RustDesk ID: $rustdesk_id"
else
    echo "Failed to get RustDesk ID."
fi

# Echo the value of the password variable
echo "Password: $rustdesk_pw"
echo "...............................................".

echo "Please complete install on GUI, launching RustDesk now."
open -n /Applications/RustDesk.app
```

--------------------------------

### Start RustDesk Services with NSSM

Source: https://rustdesk.com/docs/en/self-host/rustdesk-server-oss/windows

Commands to start the installed hbbs and hbbr services after they have been registered with NSSM.

```bash
nssm start <Desired hbbs servicename>
nssm start <Desired hbbr servicename>
```

--------------------------------

### Install RustDesk Server with Install Script

Source: https://rustdesk.com/docs/en/self-host/rustdesk-server-oss/install

Downloads, makes executable, and runs a script to set up RustDesk Relay and Signal Servers as systemd services.

```bash
wget https://raw.githubusercontent.com/techahold/rustdeskinstall/master/install.sh
chmod +x install.sh
./install.sh
```

--------------------------------

### Install RustDesk in Nix User Profile

Source: https://rustdesk.com/docs/en/client

Installs RustDesk into the current user's profile on Nix/NixOS. This provides a persistent installation for the user.

```bash
nix profile install nixpkgs#rustdesk
```

--------------------------------

### Install RustDesk Server Pro

Source: https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/installscript/script

Use this command to perform a simple Linux-based installation of RustDesk Server Pro. It installs dependencies, sets up firewall rules, creates directories, downloads binaries, and configures systemd services. It can also set up Nginx and Certbot for HTTPS if a domain is provided.

```bash
wget -qO- https://raw.githubusercontent.com/rustdesk/rustdesk-server-pro/main/install.sh | bash
```

--------------------------------

### Install Nginx on Gentoo

Source: https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/faq

Command to install Nginx on Gentoo systems.

```bash
sudo emerge -av nginx
```

--------------------------------

### Install RustDesk on Debian/Ubuntu

Source: https://rustdesk.com/docs/en/self-host/client-deployment

This script installs RustDesk on Debian-based systems (including Ubuntu) by downloading the .deb package and installing it using apt-get. It requires root privileges to run.

```bash
#!/bin/bash

# Assign a random value to the password variable
rustdesk_pw=$(cat /dev/urandom | tr -dc 'a-zA-Z0-9' | fold -w 8 | head -n 1)

# Get your config string from your Web portal and Fill Below
rustdesk_cfg="configstring"

################################## Please Do Not Edit Below This Line #########################################

# Check if the script is being run as root
if [[ $EUID -ne 0 ]]; then
    echo "This script must be run as root."
    exit 1
fi

# Identify OS
if [ -f /etc/os-release ]; then
    # freedesktop.org and systemd
    . /etc/os-release
    OS=$NAME
    VER=$VERSION_ID

    UPSTREAM_ID=${ID_LIKE,,}

    # Fallback to ID_LIKE if ID was not 'ubuntu' or 'debian'
    if [ "${UPSTREAM_ID}" != "debian" ] && [ "${UPSTREAM_ID}" != "ubuntu" ]; then
        UPSTREAM_ID="$(echo ${ID_LIKE,,} | sed s/"//g | cut -d' ' -f1)"
    fi

elif type lsb_release >/dev/null 2>&1; then
    # linuxbase.org
    OS=$(lsb_release -si)
    VER=$(lsb_release -sr)
elif [ -f /etc/lsb-release ]; then
    # For some versions of Debian/Ubuntu without lsb_release command
    . /etc/lsb-release
    OS=$DISTRIB_ID
    VER=$DISTRIB_RELEASE
elif [ -f /etc/debian_version ]; then
    # Older Debian, Ubuntu, etc.
    OS=Debian
    VER=$(cat /etc/debian_version)
elif [ -f /etc/SuSE-release ]; then
    # Older SuSE etc.
    OS=SuSE
    VER=$(cat /etc/SuSE-release)
elif [ -f /etc/redhat-release ]; then
    # Older Red Hat, CentOS, etc.
    OS=RedHat
    VER=$(cat /etc/redhat-release)
else
    # Fall back to uname, e.g. "Linux <version>", also works for BSD, etc.
    OS=$(uname -s)
    VER=$(uname -r)
fi

# Install RustDesk

echo "Installing RustDesk"
if [ "${ID}" = "debian" ] || [ "$OS" = "Ubuntu" ] || [ "$OS" = "Debian" ] || [ "${UPSTREAM_ID}" = "ubuntu" ] || [ "${UPSTREAM_ID}" = "debian" ]; then
    wget https://github.com/rustdesk/rustdesk/releases/download/1.2.6/rustdesk-1.2.6-x86_64.deb
    apt-get install -fy ./rustdesk-1.2.6-x86_64.deb > null
elif [ "$OS" = "CentOS" ] || [ "$OS" = "RedHat" ] || [ "$OS" = "Fedora Linux" ] || [ "${UPSTREAM_ID}" = "rhel" ] || [ "$OS" = "Almalinux" ] || [ "$OS" = "Rocky*" ] ; then
    wget https://github.com/rustdesk/rustdesk/releases/download/1.2.6/rustdesk-1.2.6-0.x86_64.rpm
    yum localinstall ./rustdesk-1.2.6-0.x86_64.rpm -y > null
else
    echo "Unsupported OS"
    # here you could ask the user for permission to try and install anyway
    # if they say yes, then do the install
    # if they say no, exit the script
    exit 1
fi

# Run the rustdesk command with --get-id and store the output in the rustdesk_id variable
rustdesk_id=$(rustdesk --get-id)

# Apply new password to RustDesk
rustdesk --password $rustdesk_pw &> /dev/null

rustdesk --config $rustdesk_cfg

systemctl restart rustdesk

echo "...............................................".
```

--------------------------------

### Example Hosts File Entry

Source: https://rustdesk.com/docs/en/self-host/nat-loopback-issues

An example of how to format an entry in the hosts file, mapping an IP address to a domain name.

```text
192.168.11.20   rustdesk.example.com
```

--------------------------------

### Install RustDesk Services using NSSM

Source: https://rustdesk.com/docs/en/self-host/rustdesk-server-oss/windows

Use NSSM to install hbbs and hbbr as Windows services. Ensure the paths to the binaries are correct for your installation.

```bash
nssm install "RustDesk hbbs service" "C:\Program Files\RustDesk Server\hbbs.exe"
nssm install "RustDesk hbbr service" "C:\Program Files\RustDesk Server\hbbr.exe"
```

--------------------------------

### Install and Bootstrap vcpkg

Source: https://rustdesk.com/docs/en/dev/build/linux

Clones the vcpkg repository, checks out a specific version, bootstraps it, and sets the VCPKG_ROOT environment variable.

```bash
git clone --recurse-submodules https://github.com/microsoft/vcpkg
cd vcpkg
git checkout 2023.10.19
cd ..
vcpkg/bootstrap-vcpkg.sh
export VCPKG_ROOT=$PWD/vcpkg
vcpkg/vcpkg install --x-install-root="$VCPKG_ROOT/installed"
```

--------------------------------

### Add Flathub repository and install RustDesk Flatpak

Source: https://rustdesk.com/docs/en/client/linux

These commands add the Flathub repository and install RustDesk as a Flatpak package for sandboxed desktop usage. The --user flag installs it for the current user only.

```bash
flatpak --user remote-add --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo
flatpak --user install ./rustdesk-<version>.flatpak
```

--------------------------------

### Install PM2 and PM2 Windows Startup

Source: https://rustdesk.com/docs/en/self-host/rustdesk-server-oss/windows

Install PM2 globally and the PM2 Windows startup module using npm. This sets up PM2 for managing Node.js processes and enables startup integration.

```bash
npm install -g pm2
npm install pm2-windows-startup -g
pm2-startup install
```

--------------------------------

### Example Connection Audit Query

Source: https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/console

An example of how to view connection audits for a specific remote peer within the last 7 days.

```bash
./audits.py --url https://example.com --token <token> view-conn --remote 123456789 --days-ago 7
```

--------------------------------

### Start RustDesk Server Components with PM2

Source: https://rustdesk.com/docs/en/self-host/rustdesk-server-oss/windows

Navigate to the RustDesk server directory and start the hbbs and hbbr services using PM2. Save the current PM2 process list.

```bash
cd C:\rustdesk-server-windows-x64
pm2 start hbbs.exe
pm2 start hbbr.exe
pm2 save
```

--------------------------------

### Install Docker with a Single Command

Source: https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/installscript/docker

This command installs the latest version of Docker on your system. Ensure you have the necessary permissions to run this script.

```bash
bash <(wget -qO- https://get.docker.com)
```

--------------------------------

### Install RustDesk on Debian Derivatives

Source: https://rustdesk.com/docs/en/client

Installs RustDesk on Debian-based Linux distributions. Use this command to install the .deb package.

```bash
sudo apt install -fy ./rustdesk-<version>.deb
```

--------------------------------

### Install Nginx on Fedora/CentOS

Source: https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/faq

Command to install Nginx on Fedora or CentOS systems.

```bash
sudo dnf install nginx
```

--------------------------------

### Install libfuse2 for AppImage on Ubuntu

Source: https://rustdesk.com/docs/en/client/linux

This command installs the libfuse2 library, which is a dependency for running the RustDesk AppImage on Ubuntu.

```bash
sudo yum install libfuse2
```

--------------------------------

### Install RustDesk on openSUSE

Source: https://rustdesk.com/docs/en/client/linux

Use this command to install the RustDesk SUSE-specific .rpm package on openSUSE systems. The --allow-unsigned-rpm flag may be necessary.

```bash
sudo zypper install --allow-unsigned-rpm ./rustdesk-<version>-suse.rpm
```

--------------------------------

### Build RustDesk

Source: https://rustdesk.com/docs/en/dev/build/linux

Installs Rust via rustup, sets up the cargo environment, clones the RustDesk repository, downloads the Sciter library, and initiates the build process.

```bash
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
# Note: VCPKG_ROOT still set
cargo run
```

--------------------------------

### Install macOS Build Tools with Homebrew

Source: https://rustdesk.com/docs/en/dev/build/osx

Installs essential development tools like Python, CMake, GCC, and Rustup using Homebrew. Ensure target directories exist and have correct permissions if installations fail.

```bash
brew install python3 create-dmg nasm cmake gcc wget ninja pkg-config wget rustup
```

--------------------------------

### Install Nginx on Debian/Ubuntu

Source: https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/faq

Command to install Nginx on Debian or Ubuntu systems.

```bash
sudo apt-get install nginx
```

--------------------------------

### Create Directory for Homebrew Installation

Source: https://rustdesk.com/docs/en/dev/build/osx

Creates a missing directory, sets ownership, and configures permissions for Homebrew installations when required.

```bash
sudo mkdir /usr/local/include
sudo chown <username>:admin /usr/local/include
sudo chmod 775 /usr/local/include
```

--------------------------------

### Install and Configure vcpkg for C/C++ Dependencies

Source: https://rustdesk.com/docs/en/dev/build/osx

Clones the vcpkg repository, checks out a specific version, disables metrics, installs core C/C++ dependencies, and sets the VCPKG_ROOT environment variable.

```bash
git clone https://github.com/microsoft/vcpkg
cd vcpkg
git checkout 2023.04.15
./bootstrap-vcpkg.sh -disableMetrics
./vcpkg install libvpx libyuv opus aom
export VCPKG_ROOT=~/repos/vcpkg
```

--------------------------------

### Install Nginx on Alpine

Source: https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/faq

Command to install Nginx on Alpine Linux systems.

```bash
sudo apk add --no-cache nginx
```

--------------------------------

### Convert from RustDesk Open Source to Pro

Source: https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/installscript/script

Use this script to convert an existing RustDesk Server (open source) installation to RustDesk Server Pro. It disables old services, installs dependencies, sets up the firewall, prepares directories, downloads Pro binaries, and creates new systemd services. It also handles Nginx and Certbot for HTTPS if a domain is specified.

```bash
wget -qO- https://raw.githubusercontent.com/rustdesk/rustdesk-server-pro/main/convertfromos.sh | bash
```

--------------------------------

### Install and Connect to Exchange Online

Source: https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/smtp/microsoft-365

Installs the Exchange Online Management module and connects to your tenant. Use the explicit user principal name if needed.

```powershell
Install-Module -Name ExchangeOnlineManagement
Import-Module ExchangeOnlineManagement
Connect-ExchangeOnline
```

```powershell
Connect-ExchangeOnline -UserPrincipalName admin@contoso.com
```

--------------------------------

### Install RustDesk on RHEL/CentOS/Fedora

Source: https://rustdesk.com/docs/en/self-host/client-deployment

This script installs RustDesk on RHEL-based systems (including CentOS, Fedora, AlmaLinux, Rocky Linux) by downloading the .rpm package and installing it using yum. It requires root privileges to run.

```bash
#!/bin/bash

# Assign a random value to the password variable
rustdesk_pw=$(cat /dev/urandom | tr -dc 'a-zA-Z0-9' | fold -w 8 | head -n 1)

# Get your config string from your Web portal and Fill Below
rustdesk_cfg="configstring"

################################## Please Do Not Edit Below This Line #########################################

# Check if the script is being run as root
if [[ $EUID -ne 0 ]]; then
    echo "This script must be run as root."
    exit 1
fi

# Identify OS
if [ -f /etc/os-release ]; then
    # freedesktop.org and systemd
    . /etc/os-release
    OS=$NAME
    VER=$VERSION_ID

    UPSTREAM_ID=${ID_LIKE,,}

    # Fallback to ID_LIKE if ID was not 'ubuntu' or 'debian'
    if [ "${UPSTREAM_ID}" != "debian" ] && [ "${UPSTREAM_ID}" != "ubuntu" ]; then
        UPSTREAM_ID="$(echo ${ID_LIKE,,} | sed s/"//g | cut -d' ' -f1)"
    fi

elif type lsb_release >/dev/null 2>&1; then
    # linuxbase.org
    OS=$(lsb_release -si)
    VER=$(lsb_release -sr)
elif [ -f /etc/lsb-release ]; then
    # For some versions of Debian/Ubuntu without lsb_release command
    . /etc/lsb-release
    OS=$DISTRIB_ID
    VER=$DISTRIB_RELEASE
elif [ -f /etc/debian_version ]; then
    # Older Debian, Ubuntu, etc.
    OS=Debian
    VER=$(cat /etc/debian_version)
elif [ -f /etc/SuSE-release ]; then
    # Older SuSE etc.
    OS=SuSE
    VER=$(cat /etc/SuSE-release)
elif [ -f /etc/redhat-release ]; then
    # Older Red Hat, CentOS, etc.
    OS=RedHat
    VER=$(cat /etc/redhat-release)
else
    # Fall back to uname, e.g. "Linux <version>", also works for BSD, etc.
    OS=$(uname -s)
    VER=$(uname -r)
fi

# Install RustDesk

echo "Installing RustDesk"
if [ "${ID}" = "debian" ] || [ "$OS" = "Ubuntu" ] || [ "$OS" = "Debian" ] || [ "${UPSTREAM_ID}" = "ubuntu" ] || [ "${UPSTREAM_ID}" = "debian" ]; then
    wget https://github.com/rustdesk/rustdesk/releases/download/1.2.6/rustdesk-1.2.6-x86_64.deb
    apt-get install -fy ./rustdesk-1.2.6-x86_64.deb > null
elif [ "$OS" = "CentOS" ] || [ "$OS" = "RedHat" ] || [ "$OS" = "Fedora Linux" ] || [ "${UPSTREAM_ID}" = "rhel" ] || [ "$OS" = "Almalinux" ] || [ "$OS" = "Rocky*" ] ; then
    wget https://github.com/rustdesk/rustdesk/releases/download/1.2.6/rustdesk-1.2.6-0.x86_64.rpm
    yum localinstall ./rustdesk-1.2.6-0.x86_64.rpm -y > null
else
    echo "Unsupported OS"
    # here you could ask the user for permission to try and install anyway
    # if they say yes, then do the install
    # if they say no, exit the script
    exit 1
fi

# Run the rustdesk command with --get-id and store the output in the rustdesk_id variable
rustdesk_id=$(rustdesk --get-id)

# Apply new password to RustDesk
rustdesk --password $rustdesk_pw &> /dev/null

rustdesk --config $rustdesk_cfg

systemctl restart rustdesk

echo "...............................................".

```

--------------------------------

### Run RustDesk Flatpak

Source: https://rustdesk.com/docs/en/client/linux

This command launches the RustDesk application installed via Flatpak. Ensure the package has been installed first.

```bash
flatpak run com.rustdesk.RustDesk
```

--------------------------------

### Install Nginx on Arch Linux

Source: https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/faq

Command to install Nginx on Arch Linux systems.

```bash
sudo pacman -S install nginx
```

--------------------------------

### Install RustDesk on Ubuntu (Debian-based)

Source: https://rustdesk.com/docs/en/client/linux

Use this command to install the RustDesk .deb package on Ubuntu and Debian-based systems. Ensure you have the correct version number.

```bash
# please ignore the wrong disk usage report
sudo apt install -fy ./rustdesk-<version>.deb
```

--------------------------------

### Install FVM and Cocoapods

Source: https://rustdesk.com/docs/en/dev/build/osx

Use Homebrew to install FVM for Flutter version management and Cocoapods for iOS dependency management.

```bash
brew tap leoafarias/fvm
brew install fvm cocoapods
```

--------------------------------

### Install Arch Linux Dependencies

Source: https://rustdesk.com/docs/en/dev/build/linux

Installs required packages for building RustDesk on Arch Linux (Manjaro).

```bash
sudo pacman -Syu --needed unzip git cmake gcc curl wget yasm nasm zip make pkg-config clang gtk3 xdotool libxcb libxfixes alsa-lib pulseaudio
```

--------------------------------

### Install Fedora Dependencies

Source: https://rustdesk.com/docs/en/dev/build/linux

Installs necessary compiler and development packages for building RustDesk on Fedora 28 (CentOS 8).

```bash
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
```

--------------------------------

### Install RustDesk with Bash (macOS)

Source: https://rustdesk.com/docs/en/self-host/client-deployment

This Bash script is designed for macOS to install RustDesk. It generates a random password and prompts for a configuration string. It includes privilege escalation using `sudo` and specifies a mount point for the DMG file.

```bash
#!/bin/bash

# Assign the value random password to the password variable
rustdesk_pw=$(openssl rand -hex 4)

# Get your config string from your Web portal and Fill Below
rustdesk_cfg="configstring"

################################## Please Do Not Edit Below This Line #########################################

# Root password request for privilege escalation
[ "$UID" -eq 0 ] || exec sudo bash "$0" "$@"

# Specify the mount point for the DMG (temporary directory)
mount_point="/Volumes/RustDesk"

```

--------------------------------

### Install libnsl for AppImage on Fedora

Source: https://rustdesk.com/docs/en/client/linux

This command installs the libnsl library, which is a dependency for running the RustDesk AppImage on Fedora.

```bash
sudo yum install libnsl
```

--------------------------------

### Install Ubuntu Dependencies

Source: https://rustdesk.com/docs/en/dev/build/linux

Installs essential compiler and development packages for building RustDesk on Ubuntu 18 (Debian 10).

```bash
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
```

--------------------------------

### Install RustDesk on CentOS/Fedora (RPM-based)

Source: https://rustdesk.com/docs/en/client/linux

Use this command to install the RustDesk .rpm package on CentOS and Fedora systems. Replace <version> with the actual version number.

```bash
sudo yum localinstall ./rustdesk-<version>.rpm
```

--------------------------------

### Example: Add Read-Only Rule for User

Source: https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/console

Example of adding a read-only access rule for a specific user to an address book.

```bash
./ab.py --url https://example.com --token <token> add-rule --ab-guid <guid> --rule-user mike --rule-permission ro
```

--------------------------------

### Start RustDesk Server Pro with Docker Compose

Source: https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/installscript

Starts the RustDesk Server Pro containers using Docker Compose in detached mode.

```bash
sudo docker compose up -d
```

--------------------------------

### Install RustDesk on Arch Linux/Manjaro

Source: https://rustdesk.com/docs/en/client/linux

Use this command to install the RustDesk .pkg.tar.zst package on Arch Linux and Manjaro systems. Ensure the version number is correct.

```bash
sudo pacman -U ./rustdesk-<version>.pkg.tar.zst
```

--------------------------------

### Initialize and Configure Rust Toolchain

Source: https://rustdesk.com/docs/en/dev/build/osx

Initializes Rust using rustup, sets the default Rust version to 1.75.0, and adds the rustfmt component. Use 'rustup show' to view installed toolchains.

```bash
rustup-init
rustup default 1.75.0
rustup component add rustfmt
```

--------------------------------

### Run hbbs with Proxy Configuration

Source: https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/license

Use this command to start the hbbs server with a specified HTTP proxy for license verification. The proxy URL can include authentication credentials.

```bash
proxy=http://username:password@example.com:8080 ./hbbs
```

--------------------------------

### Silent Install RustDesk on Windows

Source: https://rustdesk.com/docs/en/client

Installs RustDesk on Windows silently without user interaction. This is useful for automated deployments.

```bash
rustdesk.exe --silent-install
```

--------------------------------

### Clone RustDesk Source and Install Python Dependencies

Source: https://rustdesk.com/docs/en/dev/build/osx

Clones the RustDesk repository with submodules, navigates to the portable libs directory, upgrades pip, and installs project dependencies from requirements.txt.

```bash
git clone --recurse-submodules https://github.com/rustdesk/rustdesk
cd rustdesk/libs/portable/
python3 -m pip install --upgrade pip
pip3 install -r requirements.txt
```

--------------------------------

### Remove Nginx if installed by script

Source: https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/faq

Command to remove Nginx if it was installed as part of the RustDesk setup.

```bash
sudo apt remove nginx
```

--------------------------------

### Get Personal Address Book GUID

Source: https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/console

Retrieve the GUID for the personal address book using the `ab.py` script.

```bash
./ab.py --url <url> --token <token> get-personal-ab
```

--------------------------------

### View Specific Strategy

Source: https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/console

View a specific strategy by its name or GUID using the `strategies.py` script.

```bash
./strategies.py --url <url> --token <token> view --name "Default"
```

```bash
./strategies.py --url <url> --token <token> view --guid "01983006-fcca-7c12-9a91-b1df483c6073"
```

--------------------------------

### Manage RustDesk Services with Systemd

Source: https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/faq

Commands to start, stop, restart, and check the status of RustDesk H BBS and H BBR services using systemd.

```bash
sudo systemctl stop|start|restart rustdesk-hbbs|rustdesk-hbbr
e.g. sudo systemctl restart rustdesk-hbbs
```

```bash
sudo systemctl status rustdesk-hbbs|rustdesk-hbbr
e.g. sudo systemctl status rustdesk-hbbs
```

--------------------------------

### Configure PipeWire for Ubuntu 18.04

Source: https://rustdesk.com/docs/en/client/linux

These commands are required for Ubuntu 18.04 to ensure proper PipeWire functionality before installing RustDesk.

```bash
sudo apt install software-properties-common
sudo add-apt-repository ppa:pipewire-debian/pipewire-upstream
sudo apt update
```

--------------------------------

### Silent MSI Upgrade with Modified Parameters

Source: https://rustdesk.com/docs/en/client/windows/msi

Upgrade the MSI installation while modifying specific parameters like installation folder, shortcuts, and printer installation. The /l*v flag logs the installation process.

```bash
msiexec /i RustDesk-1.msi /qn INSTALLFOLDER="C:\Program Files\RustDesk" CREATESTARTMENUSHORTCUTS="N" CREATEDESKTOPSHORTCUTS="N" INSTALLPRINTER="N" /l*v install.log
```

--------------------------------

### Run RustDesk AppImage

Source: https://rustdesk.com/docs/en/client/linux

Execute the RustDesk AppImage file directly after ensuring necessary dependencies are installed. This provides a portable single-file usage option.

```bash
./rustdesk-<version>.AppImage
```

--------------------------------

### Run RustDesk in Nix Shell

Source: https://rustdesk.com/docs/en/client

Temporarily enters a shell with RustDesk available for execution on Nix/NixOS. This command makes RustDesk ready to run without a permanent installation.

```bash
nix shell nixpkgs#rustdesk
```

--------------------------------

### List All Strategies

Source: https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/console

List all available strategies using the `strategies.py` script. Requires URL and token.

```bash
./strategies.py --url <url> --token <token> list
```

--------------------------------

### Build RustDesk with default settings

Source: https://rustdesk.com/docs/en/dev/build/windows

Clone the RustDesk repository, create the target debug directory, download sciter.dll, move it to the debug directory, and run the default build command. This must be executed in Git Bash.

```bash
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.win/x64/sciter.dll
mv sciter.dll target/debug
cargo run
```

--------------------------------

### Run hbbr Container with Docker

Source: https://rustdesk.com/docs/en/self-host/rustdesk-server-oss/docker

Starts the hbbr (RustDesk relay server) container using Docker. It maps a local data directory, uses host networking, and restarts automatically. Note: `--net=host` is Linux-specific.

```bash
sudo docker run --name hbbr -v ./data:/root -td --net=host --restart unless-stopped rustdesk/rustdesk-server hbbr
```

--------------------------------

### Create New User with Python CLI

Source: https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/console

Create a new user with a username, password, and group name using the Python CLI. Email and note are optional. Requires server URL and API token.

```python
./users.py --url <url> --token <token> new --name username --password 'password123' --group_name Default [--email user@example.com] [--note "note"]
```

--------------------------------

### Import Configuration from TOML File

Source: https://rustdesk.com/docs/en/client

Imports RustDesk client settings from a TOML configuration file. This allows for easy deployment of pre-configured clients.

```bash
rustdesk.exe --import-config RustDesk2.toml
```

--------------------------------

### Configure Nginx for RustDesk (sites-available/enabled)

Source: https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/faq

Create a Nginx configuration file for RustDesk when using the sites-available and sites-enabled directories. Replace YOUR_DOMAIN with your actual domain name.

```nginx
cat > /etc/nginx/sites-available/rustdesk.conf << EOF
server {
    server_name YOUR_DOMAIN;
    location / {
        proxy_set_header        X-Real-IP       $remote_addr;
        proxy_set_header        X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_pass http://127.0.0.1:21114/;
    }
}
EOF
```

--------------------------------

### Configure SELinux for RustDesk Server

Source: https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/faq

Apply SELinux security contexts to RustDesk server binaries (hbbs, hbbr) and restore them to ensure proper operation. This is useful if you encounter 'Waiting for RustDesk Relay service to become active...' errors.

```bash
sudo semanage fcontext -a -t NetworkManager_dispatcher_exec_t 'hbbs'
sudo semanage fcontext -a -t NetworkManager_dispatcher_exec_t 'hbbr'
sudo restorecon -v '/usr/bin/hbbs'
sudo restorecon -v '/usr/bin/hbbr'
```

--------------------------------

### Assign User via Command Line

Source: https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/console

Use the RustDesk executable with the --assign parameter to assign users to a device from the command line. Requires a generated token and the username.

```bash
"C:\\Program Files\\RustDesk\\rustdesk.exe" --assign --token <generatedtoken> --user_name <username>
```

--------------------------------

### Configure Nginx for RustDesk (conf.d)

Source: https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/faq

Create a Nginx configuration file for RustDesk when using the conf.d directory. Replace YOUR_DOMAIN with your actual domain name.

```nginx
cat > /etc/nginx/conf.d/rustdesk.conf << EOF
server {
    server_name YOUR_DOMAIN;
    location / {
        proxy_set_header        X-Real-IP       $remote_addr;
        proxy_set_header        X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_pass http://127.0.0.1:21114/;
    }
}
EOF
```

--------------------------------

### Silent MSI Upgrade without Parameters

Source: https://rustdesk.com/docs/en/client/windows/msi

Perform a silent upgrade using the MSI package, retaining previous installation settings. The /l*v flag logs the installation process.

```bash
msiexec /i RustDesk-2.msi /qn /l*v install.log
```

--------------------------------

### Install Flutter Rust Bridge Codegen

Source: https://rustdesk.com/docs/en/dev/build/osx

Install the flutter_rust_bridge_codegen tool using Cargo, specifying a version and enabling the 'uuid' feature. This tool is essential for generating bridge code between Rust and Flutter.

```bash
cargo install flutter_rust_bridge_codegen --version "1.80.1" --features "uuid"
```

--------------------------------

### Show Device Group Help

Source: https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/console

Displays the help message for the device_group.py script. Use this to see all available commands and options.

```bash
./device_group.py -h
```

--------------------------------

### Clang Not Installed or LIBCLANG_PATH Not Set Error

Source: https://rustdesk.com/docs/en/dev/build/faq

This error arises when the build process cannot find the libclang library, which is necessary for tools like bindgen. Ensure LLVM is installed and the `LIBCLANG_PATH` environment variable points to the LLVM bin directory.

```bash
thread 'main' panicked at 'Unable to find libclang: "couldn't find any valid shared libraries matching: ['clang.dll', 'libclang.dll'], set the `LIBCLANG_PATH` environment variable to a path where one of these files can be found (invalid: [])"', C:\Users\selfd\.cargo\registry\src\mirrors.ustc.edu.cn-61ef6e0cd06fb9b8\bindgen-0.59.2\src/lib.rs:2144:31
```

--------------------------------

### Delete Access Rule

Source: https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/console

Delete an access rule using its rule GUID with the `ab.py` script.

```bash
./ab.py --url <url> --token <token> delete-rule --rule-guid <rule_guid>
```

--------------------------------

### View Tags in Address Book

Source: https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/console

View all tags associated with an address book using its GUID.

```bash
./ab.py --url <url> --token <token> view-tag --ab-guid <guid>
```

--------------------------------

### Delete Shared Address Book

Source: https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/console

Delete a shared address book using its GUID with the `ab.py` script.

```bash
./ab.py --url <url> --token <token> delete-ab --ab-guid <guid>
```

--------------------------------

### Enable Audio

Source: https://rustdesk.com/docs/en/self-host/client-configuration/advanced-settings

Enable or disable audio recording and transfer to the peer. 'Y' enables it.

```INI
enable-audio=Y
```

--------------------------------

### Update Access Rule

Source: https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/console

Update an existing access rule using its GUID. Allows changing the permission level.

```bash
./ab.py --url <url> --token <token> update-rule --rule-guid <rule_guid> --rule-permission rw
```

--------------------------------

### Build Sciter Version

Source: https://rustdesk.com/docs/en/dev/build/osx

Execute the build script to compile the Sciter version of RustDesk. This command should be run from the 'rustdesk' directory.

```bash
python3 ./build.py
```

--------------------------------

### View Access Rules for Address Book

Source: https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/console

View access rules for a specific address book using its GUID.

```bash
./ab.py --url <url> --token <token> view-rule --ab-guid <guid>
```

--------------------------------

### Configure Firewall with UFW

Source: https://rustdesk.com/docs/en/self-host/rustdesk-server-oss/install

Opens the necessary TCP and UDP ports for RustDesk Server and enables the UFW firewall.

```bash
ufw allow 21114:21119/tcp
ufw allow 21116/udp
sudo ufw enable
```

--------------------------------

### Configure Remote Window Following

Source: https://rustdesk.com/docs/en/self-host/client-configuration/advanced-settings

Sets the default 'follow-remote-window' option for all peers after the first connection. The individual peer setting will then control whether to follow the remote window. Previewed in PR 7717.

```INI
follow-remote-window=Y
```

--------------------------------

### Docker Run Commands for Windows (No Host Networking)

Source: https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/installscript/docker

These commands are for running RustDesk Server Pro containers on Windows, where `--net=host` is not supported. Specific ports are mapped manually, and a random MAC address is generated for `hbbs`.

```bash
macaddrhbbs=$(echo -n A0-62-2F; dd bs=1 count=3 if=/dev/random 2>/dev/null |hexdump -v -e '/1 "-%02X"')
sudo docker run --name hbbs -p 21114:21114 -p 21115:21115 -p 21116:21116 -p 21116:21116/udp -p 21118:21118 -v ./data:/root -td --mac-address="$macaddrhbbs" --restart unless-stopped docker.io/rustdesk/rustdesk-server-pro hbbs
sudo docker run --name hbbr -p 21117:21117 -p 21119:21119 -v ./data:/root -td --restart unless-stopped docker.io/rustdesk/rustdesk-server-pro hbbr
```

--------------------------------

### Delete Tag from Address Book

Source: https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/console

Delete a tag from an address book using its GUID and tag name with the `ab.py` script.

```bash
./ab.py --url <url> --token <token> delete-tag --ab-guid <guid> --tag-name <name>
```

--------------------------------

### Delete Peer from Address Book

Source: https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/console

Delete a peer from an address book using its GUID and peer ID with the `ab.py` script.

```bash
./ab.py --url <url> --token <token> delete-peer --ab-guid <guid> --peer-id <peer_id>
```

--------------------------------

### Configure Displays as Individual Windows

Source: https://rustdesk.com/docs/en/self-host/client-configuration/advanced-settings

Sets the default behavior to show each remote display in its own window. This option applies to all peers after the first connection.

```INI
displays-as-individual-windows=Y
```

--------------------------------

### NSSM Command Templates

Source: https://rustdesk.com/docs/en/self-host/rustdesk-server-oss/windows

Templates for installing hbbs and hbbr services with NSSM, allowing customization of service names and binary paths.

```bash
nssm install <Desired hbbs servicename> <RustDesk hbbs binary path> <RustDesk hbbs arguments>
nssm install <Desired hbbr servicename> <RustDesk hbbr binary path> <RustDesk hbbr arguments>
```

--------------------------------

### Get Service Principal Identity

Source: https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/smtp/microsoft-365

Retrieves service principal details, including the Identity value required for subsequent permission commands.

```powershell
Get-ServicePrincipal | Format-Table DisplayName,AppId,ObjectId,Identity
```

--------------------------------

### Show Audits Help

Source: https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/console

Displays the help message for the audits script, listing available commands and options.

```bash
./audits.py -h
```

--------------------------------

### Pull RustDesk Server Docker Image

Source: https://rustdesk.com/docs/en/self-host/rustdesk-server-oss/docker

Pulls the latest RustDesk server Docker image from the registry. Ensure Docker is installed and accessible.

```bash
sudo docker image pull rustdesk/rustdesk-server
```

--------------------------------

### Docker Compose Configuration for RustDesk Server Pro

Source: https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/installscript/docker

Use this `compose.yml` file to set up RustDesk Server Pro with `network_mode: "host"`. This configuration ensures proper licensing and keeps `hbbs` and `hbbr` services together.

```yaml
services:
  hbbs:
    container_name: hbbs
    image: docker.io/rustdesk/rustdesk-server-pro:latest
    command: hbbs
    volumes:
      - ./data:/root
    network_mode: "host"

    depends_on:
      - hbbr
    restart: unless-stopped

  hbbr:
    container_name: hbbr
    image: docker.io/rustdesk/rustdesk-server-pro:latest
    command: hbbr
    volumes:
      - ./data:/root
    network_mode: "host"
    restart: unless-stopped

```

--------------------------------

### Unassign Device Group

Source: https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/console

Unassigns a specified device group from resources. Supports names or GUIDs for device groups. Requires Strategy Permission.

```bash
./strategies.py --url <url> --token <token> unassign --device-groups "device_group1"
```

--------------------------------

### Update Shared Address Book

Source: https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/console

Update an existing shared address book using its GUID. Allows changing the name, note, or password.

```bash
./ab.py --url <url> --token <token> update-ab --ab-guid <guid> [--ab-update-name <new_name>] [--note <note>]
```
Tokens:
Raw