lejianwen месяцев назад: 11
Родитель
Сommit
983025538f
2 измененных файлов с 38 добавлено и 38 удалено
  1. 37 37
      README.md
  2. 1 1
      README_EN.md

+ 37 - 37
README.md

@@ -213,43 +213,43 @@ ldap:
213 213
 环境变量和配置文件`conf/config.yaml`中的配置一一对应,变量名前缀是`RUSTDESK_API`
214 214
 下面表格并未全部列出,可以参考`conf/config.yaml`中的配置。
215 215
 
216
-| 变量名                                               | 说明                                                                             | 示例                           |
217
-|---------------------------------------------------|--------------------------------------------------------------------------------|------------------------------|
218
-| TZ                                                | 时区                                                                             | Asia/Shanghai                |
219
-| RUSTDESK_API_LANG                                 | 语言                                                                             | `en`,`zh-CN`                 |
220
-| RUSTDESK_API_APP_WEB_CLIENT                       | 是否启用web-client; 1:启用,0:不启用; 默认启用                                               | 1                            |
221
-| RUSTDESK_API_APP_REGISTER                         | 是否开启注册; `true`, `false`  默认`false`                                             | `false`                      |
222
-| RUSTDESK_API_APP_SHOW_SWAGGER                     | 是否可见swagger文档;`1`显示,`0`不显示,默认`0`不显示                                            | `1`                          |
223
-| RUSTDESK_API_APP_TOKEN_EXPIRE                     | token有效时长(秒)                                                                   | `3600`                       |
224
-| -----ADMIN配置-----                                 | ----------                                                                     | ----------                   |
225
-| RUSTDESK_API_ADMIN_TITLE                          | 后台标题                                                                           | `RustDesk Api Admin`         |
226
-| RUSTDESK_API_ADMIN_HELLO                          | 后台欢迎语,可以使用`html`                                                               |                              |
227
-| RUSTDESK_API_ADMIN_HELLO_FILE                     | 后台欢迎语文件,如果内容多,使用文件更方便。<br>会覆盖`RUSTDESK_API_ADMIN_HELLO`                        | `./conf/admin/hello.html`    |
228
-| -----GIN配置-----                                   | ----------                                                                     | ----------                   |
229
-| RUSTDESK_API_GIN_TRUST_PROXY                      | 信任的代理IP列表,以`,`分割,默认信任所有                                                        | 192.168.1.2,192.168.1.3      |
230
-| -----GORM配置-----                                  | ----------                                                                     | ---------------------------  |
231
-| RUSTDESK_API_GORM_TYPE                            | 数据库类型sqlite或者mysql,默认sqlite                                                    | sqlite                       |
232
-| RUSTDESK_API_GORM_MAX_IDLE_CONNS                  | 数据库最大空闲连接数                                                                     | 10                           |
233
-| RUSTDESK_API_GORM_MAX_OPEN_CONNS                  | 数据库最大打开连接数                                                                     | 100                          |
234
-| RUSTDESK_API_RUSTDESK_PERSONAL                    | 是否启用个人版API, 1:启用,0:不启用; 默认启用                                                   | 1                            |
235
-| -----MYSQL配置-----                                 | ----------                                                                     | ----------                   |
236
-| RUSTDESK_API_MYSQL_USERNAME                       | mysql用户名                                                                       | root                         |
237
-| RUSTDESK_API_MYSQL_PASSWORD                       | mysql密码                                                                        | 111111                       |
238
-| RUSTDESK_API_MYSQL_ADDR                           | mysql地址                                                                        | 192.168.1.66:3306            |
239
-| RUSTDESK_API_MYSQL_DBNAME                         | mysql数据库名                                                                      | rustdesk                     |
240
-| -----RUSTDESK配置-----                              | ----------                                                                     | ----------                   |
241
-| RUSTDESK_API_RUSTDESK_ID_SERVER                   | Rustdesk的id服务器地址                                                               | 192.168.1.66:21116           |
242
-| RUSTDESK_API_RUSTDESK_RELAY_SERVER                | Rustdesk的relay服务器地址                                                            | 192.168.1.66:21117           |
243
-| RUSTDESK_API_RUSTDESK_API_SERVER                  | Rustdesk的api服务器地址                                                              | http://192.168.1.66:21114    |
244
-| RUSTDESK_API_RUSTDESK_KEY                         | Rustdesk的key                                                                   | 123456789                    |
245
-| RUSTDESK_API_RUSTDESK_KEY_FILE                    | Rustdesk存放key的文件                                                               | `./conf/data/id_ed25519.pub` |
246
-| RUSTDESK_API_RUSTDESK_WEBCLIENT_MAGIC_QUERYONLINE | Web client v2 中是否启用新的在线状态查询方法; `1`:启用,`0`:不启用,默认不启用                            | `0`                          |
247
-| ----PROXY配置-----                                  | ----------                                                                     | ----------                   |
248
-| RUSTDESK_API_PROXY_ENABLE                         | 是否启用代理:`false`, `true`                                                         | `false`                      |
249
-| RUSTDESK_API_PROXY_HOST                           | 代理地址                                                                           | `http://127.0.0.1:1080`      |
250
-| ----JWT配置----                                     | --------                                                                       | --------                     |
251
-| RUSTDESK_API_JWT_KEY                              | 自定义JWT KEY,为空则不启用JWT<br/>如果没使用`lejianwen/rustdesk-server`中的`MUST_LOGIN`,建议设置为空 |                              |
252
-| RUSTDESK_API_JWT_EXPIRE_DURATION                  | JWT有效时间                                                                        | 360000                       |
216
+| 变量名                                                    | 说明                                                                             | 示例                           |
217
+|--------------------------------------------------------|--------------------------------------------------------------------------------|------------------------------|
218
+| TZ                                                     | 时区                                                                             | Asia/Shanghai                |
219
+| RUSTDESK_API_LANG                                      | 语言                                                                             | `en`,`zh-CN`                 |
220
+| RUSTDESK_API_APP_WEB_CLIENT                            | 是否启用web-client; 1:启用,0:不启用; 默认启用                                               | 1                            |
221
+| RUSTDESK_API_APP_REGISTER                              | 是否开启注册; `true`, `false`  默认`false`                                             | `false`                      |
222
+| RUSTDESK_API_APP_SHOW_SWAGGER                          | 是否可见swagger文档;`1`显示,`0`不显示,默认`0`不显示                                            | `1`                          |
223
+| RUSTDESK_API_APP_TOKEN_EXPIRE                          | token有效时长(秒)                                                                   | `3600`                       |
224
+| -----ADMIN配置-----                                      | ----------                                                                     | ----------                   |
225
+| RUSTDESK_API_ADMIN_TITLE                               | 后台标题                                                                           | `RustDesk Api Admin`         |
226
+| RUSTDESK_API_ADMIN_HELLO                               | 后台欢迎语,可以使用`html`                                                               |                              |
227
+| RUSTDESK_API_ADMIN_HELLO_FILE                          | 后台欢迎语文件,如果内容多,使用文件更方便。<br>会覆盖`RUSTDESK_API_ADMIN_HELLO`                        | `./conf/admin/hello.html`    |
228
+| -----GIN配置-----                                        | ----------                                                                     | ----------                   |
229
+| RUSTDESK_API_GIN_TRUST_PROXY                           | 信任的代理IP列表,以`,`分割,默认信任所有                                                        | 192.168.1.2,192.168.1.3      |
230
+| -----GORM配置-----                                       | ----------                                                                     | ---------------------------  |
231
+| RUSTDESK_API_GORM_TYPE                                 | 数据库类型sqlite或者mysql,默认sqlite                                                    | sqlite                       |
232
+| RUSTDESK_API_GORM_MAX_IDLE_CONNS                       | 数据库最大空闲连接数                                                                     | 10                           |
233
+| RUSTDESK_API_GORM_MAX_OPEN_CONNS                       | 数据库最大打开连接数                                                                     | 100                          |
234
+| RUSTDESK_API_RUSTDESK_PERSONAL                         | 是否启用个人版API, 1:启用,0:不启用; 默认启用                                                   | 1                            |
235
+| -----MYSQL配置-----                                      | ----------                                                                     | ----------                   |
236
+| RUSTDESK_API_MYSQL_USERNAME                            | mysql用户名                                                                       | root                         |
237
+| RUSTDESK_API_MYSQL_PASSWORD                            | mysql密码                                                                        | 111111                       |
238
+| RUSTDESK_API_MYSQL_ADDR                                | mysql地址                                                                        | 192.168.1.66:3306            |
239
+| RUSTDESK_API_MYSQL_DBNAME                              | mysql数据库名                                                                      | rustdesk                     |
240
+| -----RUSTDESK配置-----                                   | ----------                                                                     | ----------                   |
241
+| RUSTDESK_API_RUSTDESK_ID_SERVER                        | Rustdesk的id服务器地址                                                               | 192.168.1.66:21116           |
242
+| RUSTDESK_API_RUSTDESK_RELAY_SERVER                     | Rustdesk的relay服务器地址                                                            | 192.168.1.66:21117           |
243
+| RUSTDESK_API_RUSTDESK_API_SERVER                       | Rustdesk的api服务器地址                                                              | http://192.168.1.66:21114    |
244
+| RUSTDESK_API_RUSTDESK_KEY                              | Rustdesk的key                                                                   | 123456789                    |
245
+| RUSTDESK_API_RUSTDESK_KEY_FILE                         | Rustdesk存放key的文件                                                               | `./conf/data/id_ed25519.pub` |
246
+| RUSTDESK_API_RUSTDESK_WEBCLIENT<br/>_MAGIC_QUERYONLINE | Web client v2 中是否启用新的在线状态查询方法; `1`:启用,`0`:不启用,默认不启用                            | `0`                          |
247
+| ----PROXY配置-----                                       | ----------                                                                     | ----------                   |
248
+| RUSTDESK_API_PROXY_ENABLE                              | 是否启用代理:`false`, `true`                                                         | `false`                      |
249
+| RUSTDESK_API_PROXY_HOST                                | 代理地址                                                                           | `http://127.0.0.1:1080`      |
250
+| ----JWT配置----                                          | --------                                                                       | --------                     |
251
+| RUSTDESK_API_JWT_KEY                                   | 自定义JWT KEY,为空则不启用JWT<br/>如果没使用`lejianwen/rustdesk-server`中的`MUST_LOGIN`,建议设置为空 |                              |
252
+| RUSTDESK_API_JWT_EXPIRE_DURATION                       | JWT有效时间                                                                        | 360000                       |
253 253
 
254 254
 
255 255
 ### 运行

+ 1 - 1
README_EN.md

@@ -242,7 +242,7 @@ The table below does not list all configurations. Please refer to the configurat
242 242
 | RUSTDESK_API_RUSTDESK_API_SERVER                  | Rustdesk API server address                                                                                                                          | http://192.168.1.66:21114     |
243 243
 | RUSTDESK_API_RUSTDESK_KEY                         | Rustdesk key                                                                                                                                         | 123456789                     |
244 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`                           |
245
+| RUSTDESK_API_RUSTDESK<br/>_WEBCLIENT_MAGIC_QUERYONLINE | New online query method is enabled in the web client v2; '1': Enabled, '0': Disabled, not enabled by default                                         | `0`                           |
246 246
 | ---- PROXY -----                                  | ---------------                                                                                                                                      | ----------                    |
247 247
 | RUSTDESK_API_PROXY_ENABLE                         | proxy_enable :`false`, `true`                                                                                                                        | `false`                       |
248 248
 | RUSTDESK_API_PROXY_HOST                           | proxy_host                                                                                                                                           | `http://127.0.0.1:1080`       |