ljw 1 год назад
Родитель
Сommit
5417e383c7
2 измененных файлов с 62 добавлено и 52 удалено
  1. 31 26
      README.md
  2. 31 26
      README_EN.md

+ 31 - 26
README.md

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

+ 31 - 26
README_EN.md

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