Browse Source

up readme

ljw 1 year ago
parent
commit
95a1bd6c21
2 changed files with 7 additions and 5 deletions
  1. 3 2
      README.md
  2. 4 3
      README_EN.md

+ 3 - 2
README.md

@@ -55,7 +55,7 @@
55 55
 
56 56
 ## 功能
57 57
 
58
-### API 服务: 基本实现了PC端基础的接口。支持Personal版本接口,可以通过配置文件`rustdesk.personal`或环境变量`RUSTDESK_PERSONAL`来控制是否启用
58
+### API 服务: 基本实现了PC端基础的接口。支持Personal版本接口,可以通过配置文件`rustdesk.personal`或环境变量`RUSTDESK_API_RUSTDESK_PERSONAL`来控制是否启用
59 59
 
60 60
 #### 登录
61 61
 
@@ -136,6 +136,7 @@ rustdesk:
136 136
   relay-server: "192.168.1.66:21117"
137 137
   api-server: "http://192.168.1.66:21114"
138 138
   key: "123456789"
139
+  personal: 1
139 140
 ```
140 141
 
141 142
 * 环境变量,变量名前缀是RUSTDESK_API,环境变量如果存在将覆盖配置文件中的配置
@@ -149,7 +150,7 @@ rustdesk:
149 150
 | RUSTDESK_API_GORM_TYPE              | 数据库类型sqlite或者mysql,默认sqlite          | sqlite                      |
150 151
 | RUSTDESK_API_GORM_MAX_IDLE_CONNS    | 数据库最大空闲连接数                           | 10                          |
151 152
 | RUSTDESK_API_GORM_MAX_OPEN_CONNS    | 数据库最大打开连接数                           | 100                         |
152
-| RUSTDESK_PERSONAL                   | 是否启用个人版API, 1:启用,0:不启用; 默认启用         | 1                           |
153
+| RUSTDESK_API_RUSTDESK_PERSONAL      | 是否启用个人版API, 1:启用,0:不启用; 默认启用         | 1                           |
153 154
 | -----MYSQL配置-----                   | ----------                           | ----------                  |
154 155
 | RUSTDESK_API_MYSQL_USERNAME         | mysql用户名                             | root                        |
155 156
 | RUSTDESK_API_MYSQL_PASSWORD         | mysql密码                              | 111111                      |

+ 4 - 3
README_EN.md

@@ -55,7 +55,7 @@ desktop software that provides self-hosted solutions.
55 55
 
56 56
 ## Features
57 57
 
58
-### 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_PERSONAL` environment variable.
58
+### 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.
59 59
 
60 60
 #### Login
61 61
 
@@ -147,6 +147,7 @@ rustdesk:
147 147
   relay-server: "192.168.1.66:21117"
148 148
   api-server: "http://192.168.1.66:21114"
149 149
   key: "123456789"
150
+  personal: 1
150 151
 ```
151 152
 
152 153
 * Environment variables, with the prefix `RUSTDESK_API`, will override the settings in the configuration file if
@@ -154,14 +155,14 @@ rustdesk:
154 155
 
155 156
 | Variable Name                      | Description                                               | Example                        |
156 157
 |------------------------------------|-----------------------------------------------------------|--------------------------------|
158
+| TZ                                 | timezone                                                  | Asia/Shanghai                  |
157 159
 | ----- GIN Configuration -----      | ---------------------------------------                   | ------------------------------ |
158
-| TZ                                 | 时区                                                        | Asia/Shanghai                  |
159 160
 | RUSTDESK_API_GIN_TRUST_PROXY       | Trusted proxy IPs, separated by commas.                   | 192.168.1.2,192.168.1.3        |
160 161
 | ----- GORM Configuration -----     | ---------------------------------------                   | ------------------------------ |
161 162
 | RUSTDESK_API_GORM_TYPE             | Database type (`sqlite` or `mysql`). Default is `sqlite`. | sqlite                         |
162 163
 | RUSTDESK_API_GORM_MAX_IDLE_CONNS   | Maximum idle connections                                  | 10                             |
163 164
 | RUSTDESK_API_GORM_MAX_OPEN_CONNS   | Maximum open connections                                  | 100                            |
164
-| RUSTDESK_PERSONAL                  | Open Personal Api 1:Enable,0:Disable                      | 1                              |
165
+| RUSTDESK_API_RUSTDESK_PERSONAL     | Open Personal Api 1:Enable,0:Disable                      | 1                              |
165 166
 | ----- MYSQL Configuration -----    | ---------------------------------------                   | ------------------------------ |
166 167
 | RUSTDESK_API_MYSQL_USERNAME        | MySQL username                                            | root                           |
167 168
 | RUSTDESK_API_MYSQL_PASSWORD        | MySQL password                                            | 111111                         |