Home

BetterDesk Wiki

Self-hosted RustDesk-compatible server (Go) plus a Node.js web console.

One binary replaces hbbs + hbbr. The panel handles devices, users, updates, and browser remote. Optional CDAP covers IoT and custom agents.

Warning

The Tauri MGMT and Agent desktop apps are alpha. For production use the web console and a normal RustDesk client. See Alpha Software Notice.

---

First 15 minutes

1. Install (Linux script, Windows script, or Docker — below).
2. Open http://your-server:5000 and sign in.
3. Copy ID / Relay / Key / API from Settings → Server Configuration.
4. Point a RustDesk client at those values (Client Setup).
5. Optional: TLS (TLS / SSL Certificates), then Panel Updates.

Linux

git clone https://github.com/UNITRONIX/BetterDesk.git
cd BetterDesk
sudo ./betterdesk.sh

Pick 1 for a new install, or sudo ./betterdesk.sh --auto for non-interactive setup.

Docker

All-in-one container (server + relay + console) — recommended:

curl -fsSL https://raw.githubusercontent.com/UNITRONIX/BetterDesk/main/docker-compose.quick.single.yml -o docker-compose.yml
docker compose pull && docker compose up -d
docker compose exec betterdesk betterdesk-show-admin-credentials

Panel: http://your-server:5000 (plain HTTP). Default paths: Go /opt/betterdesk, console /opt/BetterDeskConsole (legacy /opt/rustdesk still detected). The two-container split layout lives in docker-compose.quick.yml — see Docker.

Windows: see Installation.

---

Docs map

Need	Page
Install	Installation, Docker
Clients	Client Setup
Panel	Web Console, Panel Updates
Config & TLS	Configuration, TLS / SSL Certificates
Users / SSO	User Management, OIDC SSO, LDAP / Active Directory
Ops	Monitoring, Unattended Access and WoL, Migration
Privacy	Privacy
Help	Troubleshooting, FAQ
Developers	API Reference, CDAP, SDK

Deep dive in the repo: docs/.

---

Ports (short)

Clients  → :21116 signal, :21117 relay, :21121 Client API (Go; optional Node proxy)
Panel    → :5000 console, :21114 admin REST (often localhost)
Optional → :21122 CDAP, :21118/:21119 WebSocket signal/relay

---

What to run in production

Component	Status
Go server + web console	Production
Stock RustDesk client	Production
Support Agent (from BetterDesk-Client releases)	Production path for inbound support
Native CDAP agent (Go)	OK when you need headless/IoT
MGMT / Agent (Tauri)	Alpha — do not use
Native BetterDesk Desktop (Flutter)	Early — not for production yet

---

Links

• Repository · Issues · Discussions · Releases
• Sponsors · Licensing · Privacy