lejianwen 1 год назад
Родитель
Сommit
5cddbf14c8
2 измененных файлов с 66 добавлено и 64 удалено
  1. 33 32
      README.md
  2. 33 32
      README_EN.md

+ 33 - 32
README.md

@@ -210,38 +210,39 @@ proxy:
210 210
 ### 环境变量
211 211
 变量名前缀是`RUSTDESK_API`,环境变量如果存在将覆盖配置文件中的配置
212 212
 
213
-| 变量名                                | 说明                                                      | 示例                           |
214
-|------------------------------------|---------------------------------------------------------|------------------------------|
215
-| TZ                                 | 时区                                                      | Asia/Shanghai                |
216
-| RUSTDESK_API_LANG                  | 语言                                                      | `en`,`zh-CN`                 |
217
-| RUSTDESK_API_APP_WEB_CLIENT        | 是否启用web-client; 1:启用,0:不启用; 默认启用                        | 1                            |
218
-| RUSTDESK_API_APP_REGISTER          | 是否开启注册; `true`, `false`  默认`false`                      | `false`                      |
219
-| RUSTDESK_API_APP_SHOW_SWAGGER      | 是否可见swagger文档;`1`显示,`0`不显示,默认`0`不显示                     | `1`                          |
220
-| -----ADMIN配置-----                  | ----------                                              | ----------                   |
221
-| RUSTDESK_API_ADMIN_TITLE           | 后台标题                                                    | `RustDesk Api Admin`         |
222
-| RUSTDESK_API_ADMIN_HELLO           | 后台欢迎语,可以使用`html`                                        |                              |
223
-| RUSTDESK_API_ADMIN_HELLO_FILE      | 后台欢迎语文件,如果内容多,使用文件更方便。<br>会覆盖`RUSTDESK_API_ADMIN_HELLO` | `./conf/admin/hello.html`    |
224
-| -----GIN配置-----                    | ----------                                              | ----------                   |
225
-| RUSTDESK_API_GIN_TRUST_PROXY       | 信任的代理IP列表,以`,`分割,默认信任所有                                 | 192.168.1.2,192.168.1.3      |
226
-| -----------GORM配置----------------  | ------------------------------------                    | ---------------------------  |
227
-| RUSTDESK_API_GORM_TYPE             | 数据库类型sqlite或者mysql,默认sqlite                             | sqlite                       |
228
-| RUSTDESK_API_GORM_MAX_IDLE_CONNS   | 数据库最大空闲连接数                                              | 10                           |
229
-| RUSTDESK_API_GORM_MAX_OPEN_CONNS   | 数据库最大打开连接数                                              | 100                          |
230
-| RUSTDESK_API_RUSTDESK_PERSONAL     | 是否启用个人版API, 1:启用,0:不启用; 默认启用                            | 1                            |
231
-| -----MYSQL配置-----                  | ----------                                              | ----------                   |
232
-| RUSTDESK_API_MYSQL_USERNAME        | mysql用户名                                                | root                         |
233
-| RUSTDESK_API_MYSQL_PASSWORD        | mysql密码                                                 | 111111                       |
234
-| RUSTDESK_API_MYSQL_ADDR            | mysql地址                                                 | 192.168.1.66:3306            |
235
-| RUSTDESK_API_MYSQL_DBNAME          | mysql数据库名                                               | rustdesk                     |
236
-| -----RUSTDESK配置-----               | ---------------                                         | ----------                   |
237
-| RUSTDESK_API_RUSTDESK_ID_SERVER    | Rustdesk的id服务器地址                                        | 192.168.1.66:21116           |
238
-| RUSTDESK_API_RUSTDESK_RELAY_SERVER | Rustdesk的relay服务器地址                                     | 192.168.1.66:21117           |
239
-| RUSTDESK_API_RUSTDESK_API_SERVER   | Rustdesk的api服务器地址                                       | http://192.168.1.66:21114    |
240
-| RUSTDESK_API_RUSTDESK_KEY          | Rustdesk的key                                            | 123456789                    |
241
-| RUSTDESK_API_RUSTDESK_KEY_FILE     | Rustdesk存放key的文件                                        | `./conf/data/id_ed25519.pub` |
242
-| ----PROXY配置-----                   | ---------------                                         | ----------                   |
243
-| RUSTDESK_API_PROXY_ENABLE          | 是否启用代理:`false`, `true`                                  | `false`                      |
244
-| RUSTDESK_API_PROXY_HOST            | 代理地址                                                    | `http://127.0.0.1:1080`      |
213
+| 变量名                                               | 说明                                                      | 示例                           |
214
+|---------------------------------------------------|---------------------------------------------------------|------------------------------|
215
+| TZ                                                | 时区                                                      | Asia/Shanghai                |
216
+| RUSTDESK_API_LANG                                 | 语言                                                      | `en`,`zh-CN`                 |
217
+| RUSTDESK_API_APP_WEB_CLIENT                       | 是否启用web-client; 1:启用,0:不启用; 默认启用                        | 1                            |
218
+| RUSTDESK_API_APP_REGISTER                         | 是否开启注册; `true`, `false`  默认`false`                      | `false`                      |
219
+| RUSTDESK_API_APP_SHOW_SWAGGER                     | 是否可见swagger文档;`1`显示,`0`不显示,默认`0`不显示                     | `1`                          |
220
+| -----ADMIN配置-----                                 | ----------                                              | ----------                   |
221
+| RUSTDESK_API_ADMIN_TITLE                          | 后台标题                                                    | `RustDesk Api Admin`         |
222
+| RUSTDESK_API_ADMIN_HELLO                          | 后台欢迎语,可以使用`html`                                        |                              |
223
+| RUSTDESK_API_ADMIN_HELLO_FILE                     | 后台欢迎语文件,如果内容多,使用文件更方便。<br>会覆盖`RUSTDESK_API_ADMIN_HELLO` | `./conf/admin/hello.html`    |
224
+| -----GIN配置-----                                   | ----------                                              | ----------                   |
225
+| RUSTDESK_API_GIN_TRUST_PROXY                      | 信任的代理IP列表,以`,`分割,默认信任所有                                 | 192.168.1.2,192.168.1.3      |
226
+| -----------GORM配置----------------                 | ------------------------------------                    | ---------------------------  |
227
+| RUSTDESK_API_GORM_TYPE                            | 数据库类型sqlite或者mysql,默认sqlite                             | sqlite                       |
228
+| RUSTDESK_API_GORM_MAX_IDLE_CONNS                  | 数据库最大空闲连接数                                              | 10                           |
229
+| RUSTDESK_API_GORM_MAX_OPEN_CONNS                  | 数据库最大打开连接数                                              | 100                          |
230
+| RUSTDESK_API_RUSTDESK_PERSONAL                    | 是否启用个人版API, 1:启用,0:不启用; 默认启用                            | 1                            |
231
+| -----MYSQL配置-----                                 | ----------                                              | ----------                   |
232
+| RUSTDESK_API_MYSQL_USERNAME                       | mysql用户名                                                | root                         |
233
+| RUSTDESK_API_MYSQL_PASSWORD                       | mysql密码                                                 | 111111                       |
234
+| RUSTDESK_API_MYSQL_ADDR                           | mysql地址                                                 | 192.168.1.66:3306            |
235
+| RUSTDESK_API_MYSQL_DBNAME                         | mysql数据库名                                               | rustdesk                     |
236
+| -----RUSTDESK配置-----                              | ---------------                                         | ----------                   |
237
+| RUSTDESK_API_RUSTDESK_ID_SERVER                   | Rustdesk的id服务器地址                                        | 192.168.1.66:21116           |
238
+| RUSTDESK_API_RUSTDESK_RELAY_SERVER                | Rustdesk的relay服务器地址                                     | 192.168.1.66:21117           |
239
+| RUSTDESK_API_RUSTDESK_API_SERVER                  | Rustdesk的api服务器地址                                       | http://192.168.1.66:21114    |
240
+| RUSTDESK_API_RUSTDESK_KEY                         | Rustdesk的key                                            | 123456789                    |
241
+| RUSTDESK_API_RUSTDESK_KEY_FILE                    | Rustdesk存放key的文件                                        | `./conf/data/id_ed25519.pub` |
242
+| RUSTDESK_API_RUSTDESK_WEBCLIENT_MAGIC_QUERYONLINE | Web client v2 中是否启用新的在线状态查询方法; `1`:启用,`0`:不启用,默认不启用     | `0`                          |
243
+| ----PROXY配置-----                                  | ---------------                                         | ----------                   |
244
+| RUSTDESK_API_PROXY_ENABLE                         | 是否启用代理:`false`, `true`                                  | `false`                      |
245
+| RUSTDESK_API_PROXY_HOST                           | 代理地址                                                    | `http://127.0.0.1:1080`      |
245 246
 
246 247
 
247 248
 ### 运行

+ 33 - 32
README_EN.md

@@ -213,38 +213,39 @@ proxy:
213 213
 ### Environment Variables
214 214
 The prefix for variable names is `RUSTDESK_API`. If environment variables exist, they will override the configurations in the configuration file.
215 215
 
216
-| Variable Name                      | Description                                                             | Example                       |
217
-|------------------------------------|-------------------------------------------------------------------------|-------------------------------|
218
-| TZ                                 | timezone                                                                | Asia/Shanghai                 |
219
-| RUSTDESK_API_LANG                  | Language                                                                | `en`,`zh-CN`                  |
220
-| RUSTDESK_API_APP_WEB_CLIENT        | web client on/off; 1: on, 0 off, default: 1                             | 1                             |
221
-| RUSTDESK_API_APP_REGISTER          | register enable; `true`, `false`; default:`false`                       | `false`                       |
222
-| RUSTDESK_API_APP_SHOW_SWAGGER      | swagger visible; 1: yes, 0: no; default: 0                              | `0`                           |
223
-| ----- ADMIN Configuration-----     | ----------                                                              | ----------                    |
224
-| RUSTDESK_API_ADMIN_TITLE           | Admin Title                                                             | `RustDesk Api Admin`          |
225
-| RUSTDESK_API_ADMIN_HELLO           | Admin welcome message, you can use `html`                               |                               |
226
-| RUSTDESK_API_ADMIN_HELLO_FILE      | Admin welcome message file,<br>will override `RUSTDESK_API_ADMIN_HELLO` | `./conf/admin/hello.html`     |
227
-| ----- GIN Configuration -----      | ---------------------------------------                                 | ----------------------------- |
228
-| RUSTDESK_API_GIN_TRUST_PROXY       | Trusted proxy IPs, separated by commas.                                 | 192.168.1.2,192.168.1.3       |
229
-| ----- GORM Configuration -----     | ---------------------------------------                                 | ----------------------------- |
230
-| RUSTDESK_API_GORM_TYPE             | Database type (`sqlite` or `mysql`). Default is `sqlite`.               | sqlite                        |
231
-| RUSTDESK_API_GORM_MAX_IDLE_CONNS   | Maximum idle connections                                                | 10                            |
232
-| RUSTDESK_API_GORM_MAX_OPEN_CONNS   | Maximum open connections                                                | 100                           |
233
-| RUSTDESK_API_RUSTDESK_PERSONAL     | Open Personal Api 1:Enable,0:Disable                                    | 1                             |
234
-| ----- MYSQL Configuration -----    | ---------------------------------------                                 | ----------------------------- |
235
-| RUSTDESK_API_MYSQL_USERNAME        | MySQL username                                                          | root                          |
236
-| RUSTDESK_API_MYSQL_PASSWORD        | MySQL password                                                          | 111111                        |
237
-| RUSTDESK_API_MYSQL_ADDR            | MySQL address                                                           | 192.168.1.66:3306             |
238
-| RUSTDESK_API_MYSQL_DBNAME          | MySQL database name                                                     | rustdesk                      |
239
-| ----- RUSTDESK Configuration ----- | ---------------------------------------                                 | ----------------------------- |
240
-| RUSTDESK_API_RUSTDESK_ID_SERVER    | Rustdesk ID server address                                              | 192.168.1.66:21116            |
241
-| RUSTDESK_API_RUSTDESK_RELAY_SERVER | Rustdesk relay server address                                           | 192.168.1.66:21117            |
242
-| RUSTDESK_API_RUSTDESK_API_SERVER   | Rustdesk API server address                                             | http://192.168.1.66:21114     |
243
-| RUSTDESK_API_RUSTDESK_KEY          | Rustdesk key                                                            | 123456789                     |
244
-| RUSTDESK_API_RUSTDESK_KEY_FILE     | Rustdesk存放key的文件                                                        | `./conf/data/id_ed25519.pub`  |
245
-| ---- PROXY -----                   | ---------------                                                         | ----------                    |
246
-| RUSTDESK_API_PROXY_ENABLE          | proxy_enable :`false`, `true`                                           | `false`                       |
247
-| RUSTDESK_API_PROXY_HOST            | proxy_host                                                              | `http://127.0.0.1:1080`       |
216
+| Variable Name                                       | Description                                                                                                  | Example                       |
217
+|-----------------------------------------------------|--------------------------------------------------------------------------------------------------------------|-------------------------------|
218
+| TZ                                                  | timezone                                                                                                     | Asia/Shanghai                 |
219
+| RUSTDESK_API_LANG                                   | Language                                                                                                     | `en`,`zh-CN`                  |
220
+| RUSTDESK_API_APP_WEB_CLIENT                         | web client on/off; 1: on, 0 off, default: 1                                                                  | 1                             |
221
+| RUSTDESK_API_APP_REGISTER                           | register enable; `true`, `false`; default:`false`                                                            | `false`                       |
222
+| RUSTDESK_API_APP_SHOW_SWAGGER                       | swagger visible; 1: yes, 0: no; default: 0                                                                   | `0`                           |
223
+| ----- ADMIN Configuration-----                      | ----------                                                                                                   | ----------                    |
224
+| RUSTDESK_API_ADMIN_TITLE                            | Admin Title                                                                                                  | `RustDesk Api Admin`          |
225
+| RUSTDESK_API_ADMIN_HELLO                            | Admin welcome message, you can use `html`                                                                    |                               |
226
+| RUSTDESK_API_ADMIN_HELLO_FILE                       | Admin welcome message file,<br>will override `RUSTDESK_API_ADMIN_HELLO`                                      | `./conf/admin/hello.html`     |
227
+| ----- GIN Configuration -----                       | ---------------------------------------                                                                      | ----------------------------- |
228
+| RUSTDESK_API_GIN_TRUST_PROXY                        | Trusted proxy IPs, separated by commas.                                                                      | 192.168.1.2,192.168.1.3       |
229
+| ----- GORM Configuration -----                      | ---------------------------------------                                                                      | ----------------------------- |
230
+| RUSTDESK_API_GORM_TYPE                              | Database type (`sqlite` or `mysql`). Default is `sqlite`.                                                    | sqlite                        |
231
+| RUSTDESK_API_GORM_MAX_IDLE_CONNS                    | Maximum idle connections                                                                                     | 10                            |
232
+| RUSTDESK_API_GORM_MAX_OPEN_CONNS                    | Maximum open connections                                                                                     | 100                           |
233
+| RUSTDESK_API_RUSTDESK_PERSONAL                      | Open Personal Api 1:Enable,0:Disable                                                                         | 1                             |
234
+| ----- MYSQL Configuration -----                     | ---------------------------------------                                                                      | ----------------------------- |
235
+| RUSTDESK_API_MYSQL_USERNAME                         | MySQL username                                                                                               | root                          |
236
+| RUSTDESK_API_MYSQL_PASSWORD                         | MySQL password                                                                                               | 111111                        |
237
+| RUSTDESK_API_MYSQL_ADDR                             | MySQL address                                                                                                | 192.168.1.66:3306             |
238
+| RUSTDESK_API_MYSQL_DBNAME                           | MySQL database name                                                                                          | rustdesk                      |
239
+| ----- RUSTDESK Configuration -----                  | ---------------------------------------                                                                      | ----------------------------- |
240
+| RUSTDESK_API_RUSTDESK_ID_SERVER                     | Rustdesk ID server address                                                                                   | 192.168.1.66:21116            |
241
+| RUSTDESK_API_RUSTDESK_RELAY_SERVER                  | Rustdesk relay server address                                                                                | 192.168.1.66:21117            |
242
+| RUSTDESK_API_RUSTDESK_API_SERVER                    | Rustdesk API server address                                                                                  | http://192.168.1.66:21114     |
243
+| RUSTDESK_API_RUSTDESK_KEY                           | Rustdesk key                                                                                                 | 123456789                     |
244
+| RUSTDESK_API_RUSTDESK_KEY_FILE                      | Rustdesk key file                                                                                            | `./conf/data/id_ed25519.pub`  |
245
+| RUSTDESK_API_RUSTDESK_WEBCLIENT_MAGIC_QUERYONLINE   | New online query method is enabled in the web client v2; '1': Enabled, '0': Disabled, not enabled by default | `0`                           |
246
+| ---- PROXY -----                                    | ---------------                                                                                              | ----------                    |
247
+| RUSTDESK_API_PROXY_ENABLE                           | proxy_enable :`false`, `true`                                                                                | `false`                       |
248
+| RUSTDESK_API_PROXY_HOST                             | proxy_host                                                                                                   | `http://127.0.0.1:1080`       |
248 249
 
249 250
 ### Installation Steps
250 251