up README.md

This commit is contained in:
ljw
2024-09-19 11:02:54 +08:00
parent a4b413dadb
commit d45e85d29b
2 changed files with 94 additions and 90 deletions

View File

@@ -18,17 +18,17 @@
1. PC客户端使用的是 ***1.3.0***,经测试 ***1.2.6+*** 都可以
2. server端必须指定key不能用自带的生成的key,否则可能链接不上或者超时
```bash
hbbs -r <relay-server-ip[:port]> -k <key>
hbbr -k <key>
```
```bash
hbbs -r <relay-server-ip[:port]> -k <key>
hbbr -k <key>
```
比如
比如
```bash
hbbs -r <relay-server-ip[:port]> -k abc1234567
hbbr -k abc1234567
```
```bash
hbbs -r <relay-server-ip[:port]> -k abc1234567
hbbr -k abc1234567
```
## 功能
@@ -66,6 +66,10 @@ hbbr -k abc1234567
![web_admin_gr](docs/web_admin_gr.png)
5. 可以直接打开webclient方便使用
![web_webclient](docs/admin_webclient.png)
6. Oauth,暂时只支持了`Github`, 需要创建一个`OAuth App`,然后配置到后台
![web_admin_oauth](docs/web_admin_oauth.png)
- github在`Settings`->`Developer settings`->`OAuth Apps`->`New OAuth App`
中创建,地址`https://github.com/settings/developers`
### **Web Client**:
@@ -148,10 +152,10 @@ lejianwen/rustdesk-api
2. 使用`docker compose`
- 简单示例
- 简单示例
```docker-compose
services:
```docker-compose
services:
rustdesk-api:
container_name: rustdesk-api
environment:
@@ -167,15 +171,15 @@ services:
networks:
- rustdesk-net
restart: unless-stopped
```
```
- 根据rustdesk提供的示例加上自己的rustdesk-api
- 根据rustdesk提供的示例加上自己的rustdesk-api
```docker-compose
networks:
```docker-compose
networks:
rustdesk-net:
external: false
services:
services:
hbbs:
container_name: hbbs
ports:
@@ -228,7 +232,7 @@ services:
- rustdesk-net
restart: unless-stopped
```
```
#### 下载release直接运行

BIN
docs/web_admin_oauth.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 43 KiB