Skip to content

Commit efd9acf

Browse files
authored
[translation: en] update english translation of configuration.md (#277)
* configuration.md part 1 * configuration.md part 2 * update
1 parent 1e68f0b commit efd9acf

File tree

2 files changed

+52
-54
lines changed

2 files changed

+52
-54
lines changed

docs/config/configuration.md

Lines changed: 50 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,13 @@ star: true
2121
### **Initial config**
2222

2323
::: tip
24-
After modifying the configuration file in `config.json`, you need to restart AList to take effect
24+
After modifying the configuration file, restart AList for changes to take effect
2525

26-
- Windows/Mac: `data/config.json` in the same level folder as AList
27-
- Linux: One-click Script /opt/alist/data/config.json, manually install /xx-path/`data/config.json`
28-
- Docker: Enter the docker container, `data/config.json`
29-
- openwrt: If you use `Luci-APP-Alist`, please modify on the webpage,other Please find the AList execution file, the same level directory `data/config.json`
30-
- Other: Find the `data/config.json` in AList executing files
26+
- Windows/MacOS: `<alist dir>/data/config.json`
27+
- Linux: one-click script directory, `/opt/alist/data/config.json` or `<alist dir>/data/config.json`
28+
- Docker: `<docker container dir>/data/config.json`
29+
- openwrt: modify config on server if using `luci-app-alist` , otherwise `<alist dir>/data/config.json`
30+
- Other: `<alist dir>/data/config.json`
3131

3232
:::
3333

@@ -75,40 +75,39 @@ After modifying the configuration file in `config.json`, you need to restart ALi
7575
}
7676
```
7777

78-
## Field Description
78+
## Field Explanation
7979

8080
### **force**
8181

82-
The program will preferentially read the configuration from the environment variable, set `force` to `true` to force the program to read the configuration file.
82+
By default AList reads the configuration from environment variables, set this field to `true` to force AList to read config from the configuration file.
8383

8484
### **site_url**
8585

86-
The url of your `alist` site, such as `https://pan.nn.ci`.This address will be used in some places in the program, If you do not set this field, Some features may not work properly, such as:
86+
The address of your AList server, such as `https://pan.nn.ci`. This address is essential for some features, and thus thry may not work properly if unset:
8787

88-
- thumbnail of `LocalStorage`
89-
- Preview after opening web proxy
90-
- The download address after opening the web proxy
91-
- Reverse proxy to sub directory
88+
- thumbnailing `LocalStorage`
89+
- previewing site after setting web proxy
90+
- displaying download address after setting web proxy
91+
- reverse-proxying to site sub directories
9292
- ...
9393

94-
Please do not include `/` at the end of the URL link, refer to the following example, otherwise the above function will also not be available or exceptions will occur
94+
Do not include the slash \(`/`\) at the end of the address. For example:
9595

9696
```json
97-
# Correct way of writing:
97+
# correct:
9898
"site_url": "https://al.nn.ci",
99-
# Wrong way of writing:
99+
# incorrect (exceptions occur):
100100
"site_url": "https://al.nn.ci/",
101101
```
102102

103103
### **cdn**
104104

105-
The CDN address, if you want to use CDN, you can set this field, the `$version` will be replaced with the real version of `alist-web`
106-
This is dynamic and changeable. Existing dist resources are hosted on both npm and GitHub, and their locations are:
105+
The address of the CDN. Included `$version` values will be dynamically replaced by the version of AList. Existing dist resources are hosted on both npm and GitHub, which can be found at:
107106

108107
- https://www.npmjs.com/package/alist-web
109108
- https://github.com/alist-org/web-dist
110109

111-
So you can use any npm or github cdn as the path, for example:
110+
Thus it is possible to use any npm or GitHub CDN path for this field. For example:
112111

113112
- https://registry.npmmirror.com/alist-web/$version/files/dist/
114113
- https://cdn.jsdelivr.net/npm/alist-web@$version/dist/
@@ -120,21 +119,21 @@ So you can use any npm or github cdn as the path, for example:
120119
- https://jsd.onmicrosoft.cn/npm/alist-web@$version/dist/
121120
- https://jsd.onmicrosoft.cn/gh/alist-org/web-dist@$version/dist/
122121

123-
Also you can keep it empty to use local dist.
122+
Keep empty to use local dist resources.
124123

125124
### **jwt_secret**
126125

127-
The secret used to sign the JWT token, random generated first time start.
126+
The secret used to sign the JWT token, randomly generated on first run.
128127

129128
### **token_expires_in**
130129

131-
User login expiration time, unit: `hours`.
130+
User login expiration time, in hours.
132131

133132
### **database**
134133

135-
The database configuration, the default is `sqlite3`, you can also use `mysql` or `postgres`.
134+
The database configuration, which is by default `sqlite3`. Available options are `sqlite3`, `mysql` and `postgres`.
136135

137-
- If you do not use `MySQL` or `postgres`, the configuration file database options do not need to be modified
136+
- The database options do not need to be modified if using `sqlite3`.
138137

139138
```json
140139
"database": {
@@ -150,48 +149,48 @@ The database configuration, the default is `sqlite3`, you can also use `mysql` o
150149
},
151150
```
152151

153-
:::: details Expand to view `ssl_mode` parameter options
152+
:::: details Expand to view details of `ssl_mode`
154153

155-
If you don't know how to fill in, fill in the default blank, no need to modify, if you can't use it if you don't fill it in, do your own research, and you can't provide much effective help
154+
Leave blank if you do not understand what this is; no effective help can be given easily.
156155

157156
---
158157

159158
In MySQL, the `ssl_mode` parameter is used to specify the authentication mode of the SSL connection. Here are a few common options:
160159

161160
- `DISABLED`: Disable SSL connections.
162-
- `PREFERRED`: If the server has SSL enabled, use an SSL connection; otherwise use a normal connection.
163-
- `REQUIRED`: Must use SSL connection, if the server does not support SSL connection, the connection will fail.
164-
- `VERIFY_CA`: Must use SSL connection and verify the authenticity of the server certificate.
165-
- `VERIFY_IDENTITY`: must use an SSL connection and verify the authenticity of the server certificate and that the name matches the connecting hostname.
161+
- `PREFERRED`: Use an SSL connection if server has SSL enabled, and otherwise fallback to a normal connection.
162+
- `REQUIRED`: Force to use SSL connection and fail if the server does not support SSL connection.
163+
- `VERIFY_CA`: Force to use SSL connection and verify the authenticity of the server certificate.
164+
- `VERIFY_IDENTITY`: Force to use an SSL connection and verify the authenticity of the server certificate and that the name matches the connecting hostname.
166165

167-
MySQL 5.x and 8.x are also different. If you use the free/fee database provided by the service provider, the service provider will have documentation. You must know the database you deploy yourself.
166+
Additional, MySQL 5.x and 8.x have differences. If you are using databases provided by service providers, BTFM. If you deployed the database yourself, STFW.
168167

169168
---
170169

171170
In PostgreSQL, the `ssl_mode` parameter is used to specify how the client uses SSL connections. Here are a few common options:
172171

173172
- `disable`: Disable SSL connections.
174-
- `allow`: SSL connections are allowed, but not required.
175-
- `prefer`: If the server has SSL enabled, use an SSL connection; otherwise use a normal connection.
176-
- `require`: Must use SSL connection, if the server does not support SSL connection, the connection will fail.
177-
- `verify-ca`: Must use SSL connection and verify the authenticity of the server certificate.
178-
- `verify-full`: MUST connect using SSL and verify the authenticity and name of the server certificate matches the connected hostname.
173+
- `allow`: Allow SSL connections.
174+
- `prefer`: Use an SSL connection if server has SSL enabled, and otherwise fallback to a normal connection.
175+
- `require`: Force to use SSL connection and fail if the server does not support SSL connection.
176+
- `verify-ca`: Force to use SSL connection and verify the authenticity of the server certificate.
177+
- `verify-full`: Force to use an SSL connection and verify the authenticity of the server certificate and that the name matches the connecting hostname.
179178

180179
---
181180

182181
::: right
183182

184-
:warning::warning:**The above parameters are from ChatGPT, the authenticity/practicability/accuracy has not been verified**:warning::warning:
183+
:warning::warning:**The above information is from ChatGPT, so the accuracy has not been verified**:warning::warning:
185184

186185
:::
187186

188187
::::
189188

190189
### **scheme**
191190

192-
The scheme configuration, if you want to use https, you can set this field.
191+
The configuration of scheme. Set this field if using HTTPS.
193192

194-
- Fill in the example: Remember to throw the certificate file into the data directory to be recognized~
193+
- Remember to copy the certificate file to the data directory. Config example:
195194

196195
```json
197196
"scheme": {
@@ -208,23 +207,23 @@ The scheme configuration, if you want to use https, you can set this field.
208207

209208
### **temp_dir**
210209

211-
The temporary directory, default `data/temp`
210+
The directory to keep temporary files. By default AList uses `data/temp`.
212211

213212
::: danger
214-
temp_dir is a temporary folder exclusive to alist. In order to avoid program interruption and generate garbage files, it will be cleared every time it starts, so please do not manually put any content in this folder, and do not use this folder and its subfolders when using docker Folders are mapped to folders in use.
213+
temp_dir is a temporary folder exclusive to alist. In order to prevent AList from generating garbage files when being interrupted, the directory will be cleared every time AList starts, so do not store anything in this directory or map this directory & subdirectories to directories in use when using Docker.
215214
:::
216215

217216
### **bleve_dir**
218217

219-
When you use **`bleve`** indexes, the location of the data storage
218+
Where data is stored when using **`bleve`** index.
220219

221220
### **log**
222221

223-
The log configuration, if you want to setup the log level, you can set this field.
222+
The log configuration. Set this field to save detailed logs of disable.
224223

225224
```json
226225
"log": {
227-
"enable": true, //Whether to turn on the log record function, the default is to open the status true
226+
"enable": true, // Whether AList should store logs
228227
"name": "data\\log\\log.log", //The path and name of the log file
229228
"max_size": 10, //the maximum size of a single log file, in MB. After reaching the specified size, the file will be automatically split.
230229
"max_backups": 5, //the number of log backups to keep. Old backups will be deleted automatically when the limit is exceeded.
@@ -235,19 +234,18 @@ The log configuration, if you want to setup the log level, you can set this fiel
235234

236235
### **delayed_start**
237236

238-
**Unit: s** (V3.19.0 new function)
237+
**Time unit: second** (new feature of v3.19.0)
239238

240-
Whether to delay start, generally this function is often used in Alist to start the self -startup option
241-
242-
Because sometimes the network connection is slow, the driver that needs to be connected after the Alist is launched is too fast, so that it cannot be opened normally.
239+
Whether to delay AList startup.
240+
Generally this option is used when AList is configured to auto-start. The reason is that sometimes network takes some time to connect, so drivers requiring cannot start correctly after Alist starts.
243241

244242
### **max_connections**
245243

246-
The maximum number of connections (concurrent) at the same time, the default is 0, that is, unlimited.
244+
The maximum amount of connections at the same time. The default is 0, which is unlimited.
247245

248-
- 10 or 20 is recommended for general equipment such as n1
249-
- Use scenarios (for example, if the picture mode is turned on, the device will crash if the concurrency is not very good)
246+
- 10 or 20 is recommended for general devices such as n1.
247+
- Usage Scenarios: the device will crash if the device is bad at concurrency when picture mode is enabled.
250248

251249
### **tls_insecure_skip_verify**
252250

253-
Whether to examine the SSL certificate, if there is a problem with the certificate of the website used after opening (such as not including the intermediate certificate, certificate expiration, certificate forgery, etc.), the service will not be available,Close this option, please try to run the program in a safe network environment
251+
Whether not to verify the SSL certificate. If there is a problem with the certificate of the website used when this option is not enabled (such as not including the intermediate certificate, having the certificate expired, or forging the certificate, etc.), the service will not be available. Run the program in a safe network environment when this option is enabled.

docs/zh/config/configuration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ MySQL 5.x 和 8.x 也不一样。如果使用服务商提供的免费/收费数
181181

182182
::: right
183183

184-
:warning::warning:**以上参数来自 ChatGPT,未验证真实性/实用性/准确性:warning:**:warning:
184+
:warning::warning:**以上信息来自 ChatGPT,未验证真实性/实用性/准确性:warning:**:warning:
185185

186186
:::
187187

@@ -250,4 +250,4 @@ temp_dir 为 alist 独占的临时文件夹,为避免程序中断产生垃圾
250250

251251
### **tls_insecure_skip_verify**
252252

253-
是否检查 SSL 证书,开启后如使用的网站的证书出现问题(如未包含中级证书、证书过期、证书伪造等),将不能使用该服务,关闭该选项请尽量在安全的网络环境下运行程序
253+
是否不检查 SSL 证书,关闭后如使用的网站的证书出现问题(如未包含中级证书、证书过期、证书伪造等),将不能使用该服务,开启该选项请尽量在安全的网络环境下运行程序

0 commit comments

Comments
 (0)