up README.md
This commit is contained in:
40
README.md
40
README.md
@@ -18,17 +18,17 @@
|
|||||||
1. PC客户端使用的是 ***1.3.0***,经测试 ***1.2.6+*** 都可以
|
1. PC客户端使用的是 ***1.3.0***,经测试 ***1.2.6+*** 都可以
|
||||||
2. server端必须指定key,不能用自带的生成的key,否则可能链接不上或者超时
|
2. server端必须指定key,不能用自带的生成的key,否则可能链接不上或者超时
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
hbbs -r <relay-server-ip[:port]> -k <key>
|
hbbs -r <relay-server-ip[:port]> -k <key>
|
||||||
hbbr -k <key>
|
hbbr -k <key>
|
||||||
```
|
```
|
||||||
|
|
||||||
比如
|
比如
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
hbbs -r <relay-server-ip[:port]> -k abc1234567
|
hbbs -r <relay-server-ip[:port]> -k abc1234567
|
||||||
hbbr -k abc1234567
|
hbbr -k abc1234567
|
||||||
```
|
```
|
||||||
|
|
||||||
## 功能
|
## 功能
|
||||||
|
|
||||||
@@ -66,6 +66,10 @@ hbbr -k abc1234567
|
|||||||

|

|
||||||
5. 可以直接打开webclient,方便使用
|
5. 可以直接打开webclient,方便使用
|
||||||

|

|
||||||
|
6. Oauth,暂时只支持了`Github`, 需要创建一个`OAuth App`,然后配置到后台
|
||||||
|

|
||||||
|
- github在`Settings`->`Developer settings`->`OAuth Apps`->`New OAuth App`
|
||||||
|
中创建,地址`https://github.com/settings/developers`
|
||||||
|
|
||||||
### **Web Client**:
|
### **Web Client**:
|
||||||
|
|
||||||
@@ -148,10 +152,10 @@ lejianwen/rustdesk-api
|
|||||||
|
|
||||||
2. 使用`docker compose`
|
2. 使用`docker compose`
|
||||||
|
|
||||||
- 简单示例
|
- 简单示例
|
||||||
|
|
||||||
```docker-compose
|
```docker-compose
|
||||||
services:
|
services:
|
||||||
rustdesk-api:
|
rustdesk-api:
|
||||||
container_name: rustdesk-api
|
container_name: rustdesk-api
|
||||||
environment:
|
environment:
|
||||||
@@ -167,15 +171,15 @@ services:
|
|||||||
networks:
|
networks:
|
||||||
- rustdesk-net
|
- rustdesk-net
|
||||||
restart: unless-stopped
|
restart: unless-stopped
|
||||||
```
|
```
|
||||||
|
|
||||||
- 根据rustdesk提供的示例加上自己的rustdesk-api
|
- 根据rustdesk提供的示例加上自己的rustdesk-api
|
||||||
|
|
||||||
```docker-compose
|
```docker-compose
|
||||||
networks:
|
networks:
|
||||||
rustdesk-net:
|
rustdesk-net:
|
||||||
external: false
|
external: false
|
||||||
services:
|
services:
|
||||||
hbbs:
|
hbbs:
|
||||||
container_name: hbbs
|
container_name: hbbs
|
||||||
ports:
|
ports:
|
||||||
@@ -228,7 +232,7 @@ services:
|
|||||||
- rustdesk-net
|
- rustdesk-net
|
||||||
restart: unless-stopped
|
restart: unless-stopped
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
#### 下载release直接运行
|
#### 下载release直接运行
|
||||||
|
|
||||||
|
|||||||
BIN
docs/web_admin_oauth.png
Normal file
BIN
docs/web_admin_oauth.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 43 KiB |
Reference in New Issue
Block a user