BetterDesk/docs

Documentation

This directory contains comprehensive documentation for BetterDesk Console, organized by topic.

GitHub Wiki: User-facing wiki pages are maintained in wiki/ and published to github.com/UNITRONIX/BetterDesk/wiki via scripts/sync-wiki.sh or scripts/sync-wiki.ps1.

Setup & Installation

• Installation Guide — Full installation instructions
• Update Guide — Updating existing installations
• Build Guide — Building from source
• Synology Installation — NAS-specific setup
• HTTPS Setup — SSL/TLS certificate configuration

Docker

• Docker Support — Docker installation guide
• Docker Quick Start — 30-second quick start with pre-built images
• Docker Troubleshooting — Docker-specific issues & fixes
• Docker Migration — Migrating from existing RustDesk Docker

Features

• Client Generator — Custom client generator
• Client Generator Quick Start — Quick start guide
• Device ID Change — Device ID change feature
• Status Tracking v3 — Device status tracking system
• CDAP / Custom Device API — Custom Device Access Protocol
• Web Remote Client — Browser-based remote desktop

Architecture

• Project Structure — Codebase overview
• BetterDesk Client — Desktop client architecture
• BetterDesk v3 Overview — v3 architecture summary
• CDAP Protocol — CDAP wire protocol specification
• CDAP Implementation — CDAP implementation plan
• Port Security — Port configuration & security

Troubleshooting

• General Troubleshooting — Common issues & solutions
• Key Troubleshooting — Key and encryption issues
• Quick Fix — Quick fixes for common problems

Performance

• GPU Optimization — GPU optimization guide
• GPU Quick Fix — Quick GPU fix
• Optimization Summary — Performance optimization overview

Development

• Contributing — Contribution guidelines
• Translation Guide — Adding new languages
• Translation Summary — Translation coverage status
• Changelog — Version history

Enterprise

• Enterprise Roadmap — Future enterprise features

Security

• Threat Model — Security assumptions and trust boundaries
• Encryption Specification — Cryptographic design details
• Audit Log — Audit event model and operational notes
• Login and API Security Audit — Focused review of authentication, sessions, tokens, and API authorization
• Audyt bezpieczeństwa logowania i API — Polska wersja dokumentu audytu logowania, sesji, tokenów i autoryzacji API

---

Note: The original Rust-based HBBS patch has been replaced by the Go server and moved to archive/. See the main README for current architecture.