This repository powers RustDesk’s official documentation site, serving as the central knowledge base for installing, configuring, and operating the open-source remote desktop ecosystem. It consolidates step-by-step guides for end users, administrators, and self-hosting teams, from client setup to server deployment and maintenance. The docs explain concepts like rendezvous versus relay roles, NAT traversal, security settings, and platform-specific nuances across Windows, macOS, Linux, and mobile. Clear navigation and task-oriented articles help readers move quickly from first-time installation to advanced troubleshooting. The project treats documentation as code, enabling version control, community contributions, and swift iteration alongside product releases. It also provides best practices around performance tuning, authentication choices, and network topology so organizations can run RustDesk confidently at scale.
Features
- Task-oriented guides for clients, servers, and self-hosting
- Concept overviews that clarify architecture and security
- Platform-specific instructions across desktop and mobile
- Troubleshooting playbooks and FAQs for common issues
- Docs-as-code workflow for contributions and versioning
- Best practices for performance, auth, and deployment
Project Samples
