Skip to content

mikipal7/ha-rustdesk-server

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

25 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Home Assistant Add-on: RustDesk Server

GitHub Release License

Supports amd64 Architecture Supports aarch64 Architecture

Self-hosted RustDesk server (hbbs + hbbr) for your own remote desktop relay, running as a Home Assistant add-on.

Open Home Assistant and add repository.

About

RustDesk is a full open-source remote desktop software, written in Rust. It is an alternative to TeamViewer or AnyDesk. This add-on lets you self-host the signaling (hbbs) and relay (hbbr) servers required by RustDesk clients, so your remote desktop traffic stays on infrastructure you control.

No License Required: Unlike the RustDesk Server PRO version, this add-on bundles the free, open-source version of RustDesk Server. You do not need any paid license or subscription to run this relay for your personal devices!

The public RustDesk servers are intended for testing and research; they are not sized for production traffic. Self-hosting gives you:

  • Predictable connection times and throughput.
  • Full control over keys and who can connect to your relay.
  • The option to enforce end-to-end encrypted clients only.

Installation and Configuration

  1. Click the button above to add this repository to your Home Assistant instance. (Note: This only adds the repository to your Add-on Store, it doesn't install the addon directly).
  2. Navigate to Settings > Add-ons > Add-on Store.
  3. Scroll all the way down to RustDesk Server Home Assistant Add-on and select it.
  4. Click Install.
  5. Start the add-on. (It auto-generates your public_key and private_key on the first boot).
  6. Check the Add-on Logs for your generated keys and put them into your clients!

Detailed documentation lives in DOCS.md.

Using with an Internal Domain (NGINX)

If you want to use a domain name like rustdesk.example.com, note that RustDesk uses raw TCP/UDP connections. A standard HTTP reverse proxy (like a default Nginx web proxy) will not work.

You must configure TCP/UDP Streams for ports 21115-21117. If you use Nginx Proxy Manager, add these ports under the Streams tab, not the Hosts tab! See DOCS.md for the exact configuration snippet.

Support

Got questions?

License

MIT License - see LICENSE for details. Bundles the upstream RustDesk Server binaries released by the RustDesk project.

About

Home Assistant add-on to self-host your own RustDesk Server — hbbs (ID/rendezvous) and hbbr (relay) for private, open-source remote desktop.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • Dockerfile 65.3%
  • Jinja 34.7%