rustdesk-server README

The project's README from github.com/rustdesk/rustdesk-server. As one markdown file: README.md.

RustDesk Server Program

build

Download

Manual

Configuration & environment variables

FAQ

How to migrate OSS to Pro

Self-host your own RustDesk server, it is free and open source.

[!IMPORTANT] Need more features? RustDesk Server Pro might suit you better.

Want to develop your own server? Start with rustdesk-server-demo, a simpler starting point than this repository.

How to build manually

cargo build --release

Three executables will be generated in target/release.

You can find updated binaries on the Releases page.

Configuration

hbbs and hbbr can be configured with command-line flags, environment variables, or an .env / config file. Run hbbs --help or hbbr --help to see the available flags.

The most common options:

Option Flag Env var Applies to Purpose
Key -k KEY hbbs, hbbr hbbs loads/generates one by default
Bind address -b BIND hbbs, hbbr Local IP address to listen on (default: all interfaces; requires 1.1.17+)
Port -p PORT hbbs, hbbr Listening port (hbbs 21116, hbbr 21117)
Relay servers -r RELAY-SERVERS hbbs Override when the relay uses a different address or a non-standard port
Force relay — ALWAYS_USE_RELAY hbbs Y disables direct connections
Log level — RUST_LOG hbbs, hbbr e.g. debug (default info)

See docs/environment-variables.md for the full list of variables, the file/flag/env precedence rules, database and relay bandwidth tuning, Docker image variables, and examples.

Installation

Please follow this doc

rustdesk-server (rustdesk/rustdesk-server)

Searching Database…

这是什么?RustDesk 的服务器程序,RustDesk 是一款远程桌面工具。运行它就可以自建自己的 RustDesk 服务,而不必依赖免费的公共服务器。它是开源的。
那这是完整的远程桌面应用,还是只是服务器那一半?只有服务器那一半。构建后会得到三个可执行文件:hbbs(ID/注册服务器)、hbbr(中继服务器)和 rustdesk-utils(命令行工具)——连接时你仍然需要使用 RustDesk 客户端。
我怎么把它跑起来?可以从源码构建(可执行文件会生成在 target/release 目录),也可以从 Releases 页面下载现成的,或者直接运行 Docker 镜像——仓库里自带了 hbbs 和 hbbr 的 docker-compose 文件。
运行它的机器需要什么条件?要求很低:两者都是单个 Rust 可执行文件。它们默认监听 21116(hbbs)和 21117(hbbr)端口,所以这些端口必须开放;可以用 -p 参数或 PORT 环境变量来修改。
免费的服务器够用吗,还是会遇到需要 RustDesk Server Pro 才能解决的限制?这个仓库是免费的开源服务器;如果你需要更多功能,README 建议 RustDesk Server Pro 这个单独的产品可能更适合你。
如果我运行这个,我的远程桌面流量还会经过 RustDesk 的服务器吗?不会——自建正是它的意义所在:ID 和中继服务都运行在你自己的机器上,所以会话走的是你自己掌控的设施。
hbbs 和 hbbr 分别是做什么的?hbbs 是 ID/注册服务器:它负责让 RustDesk 客户端互相认识,从而建立连接。hbbr 是中继服务器,在客户端无法直连时转发会话流量。
为什么我要自建这个,而不是用 RustDesk 默认的服务?这样你的远程桌面会话就运行在由你掌控的设施上,而不是第三方服务器上,而且这个程序本身免费开源——这正是 README 的核心卖点。
如果我想自己写一个服务器,有没有更简单的起点?有——README 向开发者推荐了 rustdesk-server-demo,它比这个仓库更简单,适合作为起点。
可以用 Docker 部署吗?可以。仓库里自带 docker-compose 配置,Docker 镜像的环境变量在 docs/environment-variables.md 里有说明,其中还包括参数与环境变量的优先级规则和调优提示。
What are similar projects?sshdesk, mRemoteNG, xpra, omnyssh, xpipe, rustdesk, dashbeam, bitbang
Creator
rustdesk
Size
1.9 MB
Stars
10.6K
Age
6y
Commits · 90 Days