up readme

2024-10-12 10:02:04 +08:00
parent 1e41784bb9
commit 0eb733cc33
4 changed files with 109 additions and 72 deletions
--- a/README.md
+++ b/README.md
@@ -44,7 +44,8 @@
 #### PC客户端使用的是 ***1.3.0***，经测试 ***1.2.6+*** 都可以

 #### 关于PC端链接超时或者链接不上的问题以及解决方案
- 链接不上是因为server端相对于客户端落后版本，server不会响应客户端的`secure_tcp`请求，所以客户端超时
+##### 链接不上是或者超时
+因为server端相对于客户端落后版本，server不会响应客户端的`secure_tcp`请求，所以客户端超时。
 相关代码代码位置在`https://github.com/rustdesk/rustdesk/blob/master/src/client.rs#L322`
  ```rust
    if !key.is_empty() && !token.is_empty() {
@@ -55,8 +56,7 @@
  可看到当`key`和`token`都不为空时，会调用`secure_tcp`，但是server端不会响应，所以客户端超时
  `secure_tcp` 代码位置在 `https://github.com/rustdesk/rustdesk/blob/master/src/common.rs#L1203`
  
- ***解决方案***
-
+##### 4种解决方案
 1. server端指定key。
    - 优点：简单
    - 缺点：链接不是加密的
@@ -79,11 +79,13 @@
 4. 使用[我fork的代码](https://github.com/lejianwen/rustdesk)，已经修改了`secure_tcp`，可以直接下载使用，[下载地址](https://github.com/lejianwen/rustdesk/releases)
    - 优点：代码改动可查看，`Github Actions`编译，链接加密，直接下载使用
    - 缺点：可能跟不上官方版本更新
-##### 对链接加密要求不高的可以使用`1`，对链接加密要求高的可以使用`3`或`4`
+     
+***对链接加密要求不高的可以使用`1`，对链接加密要求高的可以使用`3`或`4`***

 ## 功能

-### API 服务: 基本实现了PC端基础的接口。支持Personal版本接口，可以通过配置文件`rustdesk.personal`或环境变量`RUSTDESK_API_RUSTDESK_PERSONAL`来控制是否启用
+### API 服务 
+基本实现了PC端基础的接口。支持Personal版本接口，可以通过配置文件`rustdesk.personal`或环境变量`RUSTDESK_API_RUSTDESK_PERSONAL`来控制是否启用

 #### 登录

@@ -96,26 +98,27 @@

 ![pc_ab](docs/pc_ab.png)

-#### 群组,群组分为`共享组`和`普通组`，共享组中所有人都能看到小组成员的设备，普通组只有管理员能看到所有小组成员的设备
+#### 群组
+群组分为`共享组`和`普通组`，共享组中所有人都能看到小组成员的设备，普通组只有管理员能看到所有小组成员的设备

 ![pc_gr](docs/pc_gr.png)

 ### Web Admin:

-***使用前后端分离，提供用户友好的管理界面，主要用来管理和展示。前端代码在[rustdesk-api-web](https://github.com/lejianwen/rustdesk-api-web)***
+* 使用前后端分离，提供用户友好的管理界面，主要用来管理和展示。前端代码在[rustdesk-api-web](https://github.com/lejianwen/rustdesk-api-web)

-***后台访问地址是`http://<your server>[:port]/_admin/`初次安装管理员为用户名密码为`admin` `admin`，请即时更改密码***
+* 后台访问地址是`http://<your server>[:port]/_admin/`初次安装管理员为用户名密码为`admin` `admin`，请即时更改密码

 1. 管理员界面
   ![web_admin](docs/web_admin.png)
 2. 普通用户界面
   ![web_user](docs/web_admin_user.png)
-   右上角也可以更改密码
+   右上角可以更改密码,也可以切换语言
   ![web_resetpwd](docs/web_resetpwd.png)

 3. 分组可以自定义，方便管理，暂时支持两种类型: `共享组` 和 `普通组`
   ![web_admin_gr](docs/web_admin_gr.png)
-4. 可以直接打开webclient，方便使用
+4. 可以直接打开webclient，方便使用；也可以分享给游客，游客可以直接通过webclient远程到设备
   ![web_webclient](docs/admin_webclient.png)
 5. Oauth,暂时只支持了`Github`和`Google`, 需要创建一个`OAuth App`，然后配置到后台
   ![web_admin_oauth](docs/web_admin_oauth.png)
@@ -174,7 +177,8 @@ logger:
  report-caller: true
 ```

-* 环境变量,变量名前缀是RUSTDESK_API，环境变量如果存在将覆盖配置文件中的配置
+### 环境变量
+变量名前缀是`RUSTDESK_API`，环境变量如果存在将覆盖配置文件中的配置

 | 变量名                                 | 说明                                   | 示例                          |
 |-------------------------------------|--------------------------------------|-----------------------------|
@@ -441,7 +445,22 @@ logger:

 6. 打开浏览器访问`http://<your server[:port]>/_admin/`，默认用户名密码为`admin`，请及时更改密码。

+#### nginx反代
+在`nginx`中配置反代
+```
+server {
+    listen <your port>;
+    server_name <your server>;
+    location / {
+        proxy_pass http://<api-server[:port]>;
+        proxy_set_header Host $host;
+        proxy_set_header X-Real-IP $remote_addr;
+        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+        proxy_set_header X-Forwarded-Proto $scheme;
+    }
+}
+```
 ## 其他

 - [修改客户端ID](https://github.com/abdullah-erturk/RustDesk-ID-Changer)
- [webclient](https://hub.docker.com/r/keyurbhole/flutter_web_desk)
+- [webclient来源](https://hub.docker.com/r/keyurbhole/flutter_web_desk)
--- a/README_EN.md
+++ b/README_EN.md
@@ -44,7 +44,8 @@ desktop software that provides self-hosted solutions.
 #### The PC client uses version ***1.3.0***, and versions ***1.2.6+*** have been tested to work.

 #### Solutions for PC client connection timeout or connection issues
- The connection issue is due to the server version lagging behind the client version, causing the server to not respond to the client's `secure_tcp` request, resulting in a timeout.
+##### Connection issues or timeouts
+Because the server version lags behind the client version, the server does not respond to the client's `secure_tcp` request, causing the client to timeout.
  Relevant code can be found at `https://github.com/rustdesk/rustdesk/blob/master/src/client.rs#L322`
  ```rust
    if !key.is_empty() && !token.is_empty() {
@@ -56,7 +57,7 @@ desktop software that provides self-hosted solutions.
 As seen, when both `key` and `token` are not empty, `secure_tcp` is called, but the server does not respond, causing the client to timeout.
 The `secure_tcp` code is located at `https://github.com/rustdesk/rustdesk/blob/master/src/common.rs#L1203`

- ***Solutions***
+##### Four Solutions
 1. Specify the key on the server.
    - Advantage: Simple
    - Disadvantage: The connection is not encrypted
@@ -79,11 +80,13 @@ The `secure_tcp` code is located at `https://github.com/rustdesk/rustdesk/blob/m
 4. Use [my forked code](https://github.com/lejianwen/rustdesk), which has already modified `secure_tcp`. You can download and use it directly from [here](https://github.com/lejianwen/rustdesk/releases)
    - Advantage: Code changes are viewable, compiled with `Github Actions`, encrypted connection, ready to use
    - Disadvantage: May not keep up with official version updates
-##### If encryption is not a high priority, use `1`. If encryption is important, use `3` or `4`.
+   
+***If encryption is not a high priority, use `1`. If encryption is important, use `3` or `4`.***

 ## Overview

-### API Service: Basic implementation of the PC client's primary interfaces.Supports the Personal version api, which can be enabled by configuring the `rustdesk.personal` file or the `RUSTDESK_API_RUSTDESK_PERSONAL` environment variable.
+### API Service
+Basic implementation of the PC client's primary interfaces.Supports the Personal version api, which can be enabled by configuring the `rustdesk.personal` file or the `RUSTDESK_API_RUSTDESK_PERSONAL` environment variable.

 #### Login

@@ -97,17 +100,18 @@ The `secure_tcp` code is located at `https://github.com/rustdesk/rustdesk/blob/m

 ![pc_ab](docs/en_img/pc_ab.png)

-#### Groups: Groups are divided into `shared groups` and `regular groups`. In shared groups, everyone can see the peers of all group members, while in regular groups, only administrators can see all members' peers.
+#### Groups
+Groups are divided into `shared groups` and `regular groups`. In shared groups, everyone can see the peers of all group members, while in regular groups, only administrators can see all members' peers.

 ![pc_gr](docs/en_img/pc_gr.png)

 ### Web Admin

-***The frontend and backend are separated to provide a user-friendly management interface, primarily for managing and
-displaying data.Frontend code is available at [rustdesk-api-web](https://github.com/lejianwen/rustdesk-api-web)***
+* The frontend and backend are separated to provide a user-friendly management interface, primarily for managing and
+displaying data.Frontend code is available at [rustdesk-api-web](https://github.com/lejianwen/rustdesk-api-web)

-***Admin panel URL: `http://<your server[:port]>/_admin/`. The default username and password for the initial
-installation are `admin` `admin`, please change the password immediately.***
+* Admin panel URL: `http://<your server[:port]>/_admin/`. The default username and password for the initial
+installation are `admin` `admin`, please change the password immediately.

 1. Admin interface:
   ![web_admin](docs/en_img/web_admin.png)
@@ -117,7 +121,7 @@ installation are `admin` `admin`, please change the password immediately.***
   ![web_resetpwd](docs/en_img/web_resetpwd.png)
 3. Groups can be customized for easy management. Currently, two types are supported: `shared group` and `regular group`.
   ![web_admin_gr](docs/en_img/web_admin_gr.png)
-4. You can open the web client directly for convenience:
+4. You can directly open the web client for convenient use; it can also be shared with guests, allowing them to remotely access the device via the web client.
   ![web_webclient](docs/en_img/admin_webclient.png)
 5. OAuth support: Currently, `GitHub` and `Google`  is supported. You need to create an `OAuth App` and configure it in
   the admin
@@ -179,9 +183,8 @@ logger:
  report-caller: true
 ```

-* Environment variables, with the prefix `RUSTDESK_API_RUSTDESK_PERSONAL`, will override the settings in the
-  configuration file if
-  present.
+### Environment Variables
+The prefix for variable names is `RUSTDESK_API`. If environment variables exist, they will override the configurations in the configuration file.

 | Variable Name                      | Description                                               | Example                        |
 |------------------------------------|-----------------------------------------------------------|--------------------------------|
@@ -454,7 +457,22 @@ Download the release from [release](https://github.com/lejianwen/rustdesk-api/re
 6. Open your browser and visit `http://<your server[:port]>/_admin/`, with default credentials `admin admin`. Please
   change the password promptly.

-## Miscellaneous
+#### nginx reverse proxy
+Configure reverse proxy in `nginx`
+```
+server {
+    listen <your port>;
+    server_name <your server>;
+    location / {
+        proxy_pass http://<api-server[:port]>;
+        proxy_set_header Host $host;
+        proxy_set_header X-Real-IP $remote_addr;
+        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+        proxy_set_header X-Forwarded-Proto $scheme;
+    }
+}
+```
+## Others

 - [Change client ID](https://github.com/abdullah-erturk/RustDesk-ID-Changer)
- [webclient](https://hub.docker.com/r/keyurbhole/flutter_web_desk)
+- [Web client source](https://hub.docker.com/r/keyurbhole/flutter_web_desk)
--- a/docs/admin_webclient.png
+++ b/docs/admin_webclient.png
--- a/docs/en_img/admin_webclient.png
+++ b/docs/en_img/admin_webclient.png