Home

CortenDesk Wiki

A self-hosted web console for open-source RustDesk servers, with a native in-browser client.

CortenDesk does not replace hbbs/hbbr. It runs alongside them and speaks the same HTTP API stock RustDesk clients already use, so you point clients at it as their API Server — no patched client, no fork.

New here? What CortenDesk is covers what it does, what it needs, and what it deliberately leaves to the RustDesk server.

Install

Work down this list in order. A running RustDesk server is a prerequisite, not part of CortenDesk.

• RustDesk server in Docker — hbbs and hbbr from scratch: every port, the key, and the three things that usually go wrong
• Install with Docker — the published image, Compose with MySQL, first boot
• Install on a VM — nginx, php-fpm and MySQL, without Docker
• Reverse proxy and TLS — Caddy, Traefik and nginx, the WebSocket paths, and trusted proxies
• Web client requires HTTPS — why the in-browser client cannot run over plain http://, and how to get a certificate on an internal network

Upgrade

• How to upgrade — Docker and manual installs, and what to back up first
• Releases and changelog

Features

What the console does, and how to set each part up.

Devices and device groups	Presence, aliases, folders, pre-registration, approval, recycle bin
Users and access scoping	Who sees which devices, and how that carries into the client API
Roles and delegated administration	Grant one screen without handing over the whole console
Address books	Shared books, share rules, tags — modern and legacy client APIs
Strategies (device policies)	Push client settings to devices over the heartbeat
Web client	The in-browser RustDesk client: video, audio, clipboard, file transfer
Two-factor authentication	TOTP, recovery codes, enforcement, and the break-glass reset
Single sign-on (OIDC)	Console and RustDesk client sign-in through your identity provider
Audit logs	Connections, file transfers, logins, alarms, console actions
Email, invitations and password reset	SMTP, inviting users, self-service reset, sign-in codes
Automation API	Scoped bearer tokens, the REST API, and --assign for unattended rollout
Dashboard and active sessions	Live stats, charts, and ending a session from the console

Documentation

• Settings reference — every setting, what it does, and its default
• Command-line reference — the artisan commands, including the break-glass ones
• Importing from lejianwen/rustdesk-api — migrate users, devices, address books and history
• Troubleshooting — devices not appearing, web client failures, sign-in problems, mail

Help

• Report an issue