up readme

This commit is contained in:
lejianwen
2024-11-17 18:27:15 +08:00
parent 601d47570e
commit b06d9c4e22
3 changed files with 12 additions and 0 deletions

View File

@@ -39,6 +39,7 @@
- 自动获取ID服务器和KEY - 自动获取ID服务器和KEY
- 自动获取地址簿 - 自动获取地址簿
- 游客通过临时分享链接直接远程到设备 - 游客通过临时分享链接直接远程到设备
- v2 Preview
- CLI - CLI
- 重置管理员密码 - 重置管理员密码
@@ -142,6 +143,11 @@
![webclient_conf](docs/webclient_conf.png) ![webclient_conf](docs/webclient_conf.png)
3. 登录后会自动同步ID服务器和KEY 3. 登录后会自动同步ID服务器和KEY
4. 登录后会将地址簿自动保存到web client中方便使用 4. 登录后会将地址簿自动保存到web client中方便使用
5. 现已支持`v2 Preview`,访问路径是`/webclient2`
![webclientv2](./docs/webclientv2.png)
6. `v2 preview` 部署
- 如果是通过`443`端口的`https`部署,必须配置反向代理,可以参考[官方文档](https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/faq/#8-add-websocket-secure-wss-support-for-the-id-server-and-relay-server-to-enable-secure-communication-for-the-web-client)
- 如果是`http`或者其他的`https`端口部署,则和`v1`一样,配置好`21118`,`21119`即可
### 自动化文档: 使用 Swag 生成 API 文档,方便开发者理解和使用 API。 ### 自动化文档: 使用 Swag 生成 API 文档,方便开发者理解和使用 API。

View File

@@ -147,6 +147,12 @@ installation are `admin` `admin`, please change the password immediately.
![webclient_conf](docs/webclient_conf.png) ![webclient_conf](docs/webclient_conf.png)
3. After logging in, the ID server and key will be automatically synced. 3. After logging in, the ID server and key will be automatically synced.
4. The address book will also be automatically saved to the web client for convenient use. 4. The address book will also be automatically saved to the web client for convenient use.
5. Now supports `v2 Preview`, accessible at `/webclient2`
![webclientv2](./docs/webclientv2.png)
6. `v2 preview` deployment
- If deploying via `https` on port `443`, you must configure a reverse proxy. Refer to the [official documentation](https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/faq/#8-add-websocket-secure-wss-support-for-the-id-server-and-relay-server-to-enable-secure-communication-for-the-web-client)
- If deploying via `http` or other `https` ports, configure `21118` and `21119` as with `v1`
### Automated Documentation : API documentation is generated using Swag, making it easier for developers to understand and use the API. ### Automated Documentation : API documentation is generated using Swag, making it easier for developers to understand and use the API.

BIN
docs/webclientv2.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 31 KiB