DOCSEARCHbyAlgolia
Submit Docs

RustDesk Documentation

repository·master·Indexed 20 days ago

https://github.com/rustdesk/doc.rustdesk.com

Documentation for RustDesk, an open-source remote desktop solution supporting Windows, macOS, Linux, iOS, Android, and Web. Includes guides on client installation, CLI reference, network configuration for self-hosting via RustDesk Server OSS or Pro, and development instructions.

Tokens
182.3K
Snippets
411
Records
832
Agent score
67%

What's inside RustDesk

  1. Overview of RustDesk features

    master

    RustDesk is an open-source remote desktop solution designed for security and self-hosting. Key capabilities include:

    • Multi-platform support: Works on Windows, macOS, Linux, iOS, Android, and Web.
    • Video Codecs: Supports software codecs (VP8, VP9, AV1) and hardware acceleration (H264, H265).
    • Security: Features P2P connections with NaCl-based end-to-end encryption.
    • Ease of Use: On Windows, no administrator privileges or installation are required to run the client; privileges can be elevated locally or remotely on demand.
    • Data Sovereignty: Allows for full control over your data via self-hosting on your own infrastructure.

  2. Overview of RustDesk Server Pro

    master

    RustDesk Server Pro is a commercial, self-hosted deployment option designed for teams requiring centralized administration and enterprise-grade features. It builds upon the RustDesk Server core by adding identity integrations, advanced security controls, and management tools.

    Key Enterprise Features:

    • Identity & Access: OIDC, LDAP, 2FA, and Access Control (permissions).
    • Management: Web console, API access, Address book, and Device management.
    • Security & Auditing: Log management (connection, file transfer, alarms) and Security Settings sync.
    • Advanced Connectivity: Multiple relay servers (automatic proximity selection), WebSocket support, and Web client self-hosting.
    • Customization: Custom client generator.

  3. Overview of RustDesk Server Pro features

    master

    RustDesk Server Pro is an advanced self-hosted remote desktop solution designed for professional and enterprise deployments. Compared to the open-source version, Pro provides centralized management, identity integration, and advanced security controls.

    Key Features:

    • Identity & Authentication: Support for OIDC, LDAP, and 2FA.
    • Management: Web Console for administration, API access, and Address Book management.
    • Security & Control: Audit logs (connections, file transfers, alerts), access control (permissions), and security setting synchronization.
    • Advanced Networking: Multi-relay server support (automatic selection of the nearest relay) and WebSocket support for Web/Desktop/Mobile clients.
    • Customization: Custom client generator (Pro only).

  4. Compare RustDesk and AnyDesk features and capabilities

    master

    RustDesk and AnyDesk both provide core remote-support workflows including remote view/control, unattended access, file transfer, in-session text chat, and session recording.

    Key functional differences include:

    • Self-hosting: RustDesk is built around self-hosting the ID/rendezvous and relay servers on your own infrastructure (VPS or local machine). AnyDesk defaults to their cloud and only offers an on-premises appliance on its highest tier.
    • Open Source: RustDesk is open source (AGPL), allowing for code audits and building from source. AnyDesk is proprietary.
    • Branding: RustDesk offers a custom-branded client generator starting from the Basic plan. AnyDesk provides customization on its top tier.
    • Concurrency: RustDesk standard plans offer unlimited concurrent connections (unless using Customized V2), whereas AnyDesk limits concurrency based on the specific plan tier.

  5. Security overview of Chrome Remote Desktop

    master

    Chrome Remote Desktop (CRD) is considered reasonably safe for casual personal use (e.g., accessing your own machine or helping family). Its security model relies on three primary mechanisms:

    1. Encryption: All sessions are fully encrypted, typically using standard web transport security (TLS with AES).
    2. PIN for Unattended Access: Access to pre-configured machines requires a PIN to prevent unauthorized connections from a compromised Google session.
    3. One-time Access Codes: For real-time support sessions, the host generates a single-use code that expires after one use.

    Critical Security Requirements:

    • Enable Two-Factor Authentication (2FA) on the Google account tied to CRD, as the account serves as the primary security perimeter.
    • Use strong PINs: Avoid predictable numbers (birthdays, sequences) for unattended access. The minimum requirement is six digits.
    • Avoid Social Engineering: Never share one-time access codes with anyone who contacts you unsolicited.

  6. Compare RustDesk and TeamViewer capabilities

    master

    RustDesk and TeamViewer provide similar core remote-access features, but differ in their delivery models. RustDesk is an open-source, self-hostable stack (AGPL), while TeamViewer is a managed, cloud-brokered SaaS.

    Feature Parity

    Both tools support:

    • Remote control: Core session functionality.
    • Unattended access: Controlling endpoints licensed as managed devices.
    • Mobile access: Android support (iOS is controller-only for RustDesk).
    • File transfer: Bi-directional transfer.
    • In-session chat: Text-based communication.
    • Session recording: Ability to record incoming or outgoing sessions.
    • Remote printing: Support for remote printers (Windows).
    • Multi-monitor support: Handling multiple displays.

    Key Differences

    • Infrastructure: RustDesk allows you to host the ID/rendezvous and relay servers on your own infrastructure (via RustDesk Server Pro), ensuring you control session metadata. TeamViewer brokers sessions through its own cloud network.
    • Concurrency: RustDesk standard plans offer unlimited concurrent connections, whereas TeamViewer caps simultaneous sessions based on the subscription tier.

  7. RustDesk Server Pro Features Overview

    master

    RustDesk Server Pro is a premium self-hosted solution designed for professional deployment, offering features not available in the open-source version:

    • Identity Integration: Enterprise authentication via OIDC, LDAP, and 2FA.
    • Centralized Management: Web console for device management and audit logs (connection history, file transfers, alarms).
    • Advanced Security: Access control, security policy synchronization, and directory management.
    • Scalability: Support for multiple relay servers with automatic selection of the nearest relay.
    • Customization: Custom client generator (Pro only) and Web client self-hosting.

  8. Compare free remote desktop software options

    master

    When choosing a free remote desktop solution for business, consider the trade-offs between ease of use, self-hosting requirements, and management capabilities.

    ToolFree for business?Self-host a server?Best for
    RustDeskYes (AGPL + free community server)Yes (free server / Server Pro)Cross-platform access with no commercial-use nag
    Chrome Remote DesktopYes; enterprise policies availableNo self-hosted control planeSimple access with Google-managed coordination
    VNC (TigerVNC/TightVNC/UltraVNC)Yes (open protocol)Yes (you assemble it)LAN/DIY access with a VPN
    Apache GuacamoleYes (Apache 2.0)Yes (gateway)Browser access to existing RDP/VNC/SSH
    MeshCentralYes (Apache 2.0)Yes (agent-based)Managing a fleet of devices
    RemminaYes (client only)N/A (client)A free remote desktop client on Linux

  9. Understand RustDesk Server Pro for MSPs

    master

    RustDesk Server Pro is a self-hosted, open-source (AGPL) remote-support platform designed to consolidate multiple remote-support tools into a single console. Unlike vendor-hosted cloud solutions, RustDesk Server Pro allows Managed Service Providers (MSPs) to host the ID/rendezvous server, relay, console, and stored device data on their own controlled infrastructure (on-prem or VPS).

    Key features for MSPs include:

    • Single Console: Manage all remote support from one self-hosted interface.
    • Custom Branding: A client generator to create branded tools for your clients (available from the Basic plan and up).
    • Access Control: Use device groups and shared address books for per-user permissions.
    • Identity Integration: LDAP/SSO (OIDC) support is available from the Basic plan and up.

  10. Quick reference for Windows deployment scenarios

    master

    Use these rules of thumb to decide your installation method:

    • End Users: The standard installer is sufficient for most users.
    • Corporate/Scripted Rollouts: Use the MSI guide.
    • Portable Mode + Admin Rights: Use the portable elevation guide.
    • Self-Hosting: Combine your chosen Windows installation method with the Client Deployment guide to implement server-distributed configurations.

  11. RustDesk features for MSPs and IT teams

    master

    RustDesk Server Pro provides enterprise-grade management tools for MSPs and large IT operations, including:

    • Self-hosted Web Console: Centralized management of your infrastructure.
    • Custom-branded Client Generator: Create clients tailored to your brand.
    • Device Groups & Shared Address Book: Manage device access and organization with per-user access control.
    • LDAP/SSO (OIDC): Available from the Basic plan and up for identity management.
    • Scalability: Designed for large fleets, with planning starting around 50,000 managed devices (larger estates require validation for caching, database tuning, and rollout design).

  12. Configure RustDesk clients for self-hosted servers

    master

    To connect RustDesk clients to a self-hosted server, you must configure the client with your server's connection details. There are several methods depending on your deployment scale and license level:

    1. Custom Client Generator (Pro/Base/Custom plans): Best for branded, pre-configured clients with your own logo and settings. Supports Windows, Mac, Linux, and Android.
    2. Manual Configuration: Best for small OSS or test environments. You manually enter the ID Server, Key, and API Server in the client settings.
    3. Import/Export: Allows you to configure one client and copy its settings to others via a configuration string.
    4. Automatic Configuration: Uses deployment scripts or a Base64 string to automate setup.
    5. CLI Configuration: Using the --config flag to pass a configuration string directly.