Skip to content

Commit c2c15a1

Browse files
authored
Docs:Synchronous v3.31/2.0 some functions (#330)
* one commit * update * update
1 parent e50c4c4 commit c2c15a1

33 files changed

+2083
-1322
lines changed
556 Bytes
Loading

docs/.vuepress/theme.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ export default hopeTheme(
137137
{
138138
path: "/",
139139
title: 'Kind tips',
140-
content: '<i class="fa-solid fa-light-emergency-on fa-bounce" style="color: #ff0000;"></i>&nbsp;<span style="color:rgb(255, 0, 0);font-weight:bold;">Please check the reminder content carefully</span><br/><br/>1.<span style="color:blue; font-weight:bold;">The new version v3.25.0 has updated the new password method, and the acquisition method has also been changed. For details, please refer to the documentation page of your own installation method</span><br/>2.v3.25.1 Aliyun_open can choose to mount the backup disk or resource library by itself, for details <a href="/guide/drivers/aliyundrive_open.html#drive-type">Click to view for details</a><br/>3.The new version of AList version greater than v3.22.1 adds single sign-on to automatically register as an AList account, click to view the <a href="/guide/advanced/sso.html#sso-automatically-registers-as-an-alist-account">detailed description</a><br/>4.<a href="/guide/drivers/139.html">139Cloud</a>和<a href="/guide/drivers/189.html">189Cloud</a>For details of changes, please view the document by yourself, respectively<br/>5.v3.20.1version Breaking Changes <a href="https://github.com/alist-org/alist/discussions/4702">View detailed description</a>, go to <a href="/config/configuration.html#scheme">Configure documentation page</a><br/>6. AList v3.30.0 will no longer support Win7 because Go does not support it. <a href="https://github.com/golang/go/issues/64622">Click to view detailed instructions</a> .<br/>7.After adding the cloud disk, please configure [anti-theft/meta information] and other measures in time to prevent the account from being [frozen/disabled] due to malicious [access/sharing] by [crawlers/others].</span></span>',
140+
content: '<i class="fa-solid fa-light-emergency-on fa-bounce" style="color: #ff0000;"></i>&nbsp;<span style="color:rgb(255, 0, 0);font-weight:bold;">Please check the reminder content carefully</span><br/><br/>1.<span style="color:blue; font-weight:bold;">The new version v3.25.0 has updated the new password method, and the acquisition method has also been changed. For details, please refer to the documentation page of your own installation method</span><br/>2.v3.25.1 Aliyun_open can choose to mount the backup disk or resource library by itself, for details <a href="/guide/drivers/aliyundrive_open.html#drive-type">Click to view for details</a><br/>3.The new version of AList version greater than v3.22.1 adds single sign-on to automatically register as an AList account, click to view the <a href="/guide/advanced/sso.html#sso-automatically-registers-as-an-alist-account">detailed description</a><br/>4.<a href="/guide/drivers/139.html">139Cloud</a>和<a href="/guide/drivers/189.html">189Cloud</a>For details of changes, please view the document by yourself, respectively<br/>5.v3.20.1version Breaking Changes <a href="https://github.com/alist-org/alist/discussions/4702">View detailed description</a>, go to <a href="/config/configuration.html#scheme">Configure documentation page</a><br/>6. AList v3.30.0 will no longer support Win7/Server2008 because Go does not support it. <a href="https://github.com/golang/go/issues/64622">Click to view detailed instructions</a> .<br/>7.After adding the cloud disk, please configure [anti-theft/meta information] and other measures in time to prevent the account from being [frozen/disabled] due to malicious [access/sharing] by [crawlers/others].</span></span>',
141141
actions: [
142142
// {
143143
// text: "Aliyun open",
@@ -160,7 +160,7 @@ export default hopeTheme(
160160
{
161161
path: "/zh",
162162
title: '温馨提示',
163-
content: '<i class="fa-solid fa-light-emergency-on fa-bounce" style="color: #ff0000;"></i>&nbsp;<span style="color:rgb(255, 0, 0);font-weight:bold;">请仔细查看弹窗提示内容</span><br/><br/>1.<span style="color:blue; font-weight:bold;">v3.25.1新版更新了新的密码方式,获取方式也进行了更改,详细说明请看自己安装方式的文档页面内</span><br/>2.v3.25.1阿里云盘open可以自行选择挂载备份盘或者资源库,详情<a href="/zh/guide/drivers/aliyundrive_open.html#云盘类型">详情点击查看</a><br/>3.AList版本大于v3.22.1,新版本新增单点登录自动注册为AList账户,点击查看<a href="/zh/guide/advanced/sso.html#单点登录自动注册为alist帐号">详细说明</a><br/>4.<a href="/zh/guide/drivers/139.html">移动云盘</a>和<a href="/zh/guide/drivers/189.html">天翼云</a>分别有改动详情请自行查看文档<br/>5.v3.20.1的版本破坏性更新<a href="https://github.com/alist-org/alist/discussions/4702">查看详细说明</a>,前往<a href="/zh/config/configuration.html#scheme">配置文档页面</a><br/>6.AList v3.30.0版本开始将不再支持Win7,因为Go不支持了,<a href="https://github.com/golang/go/issues/64622">点击查看详细说明</a>.<br/><span style="color:rgb(255, 0, 0);font-weight:bold;">7.添加云盘后请及时配置[防盗/元信息]等措施,防止被[爬虫/其他人]恶意[访问/分享]导致帐号被[冻结/禁用].</span></span>',
163+
content: '<i class="fa-solid fa-light-emergency-on fa-bounce" style="color: #ff0000;"></i>&nbsp;<span style="color:rgb(255, 0, 0);font-weight:bold;">请仔细查看弹窗提示内容</span><br/><br/>1.<span style="color:blue; font-weight:bold;">v3.25.1新版更新了新的密码方式,获取方式也进行了更改,详细说明请看自己安装方式的文档页面内</span><br/>2.v3.25.1阿里云盘open可以自行选择挂载备份盘或者资源库,详情<a href="/zh/guide/drivers/aliyundrive_open.html#云盘类型">详情点击查看</a><br/>3.AList版本大于v3.22.1,新版本新增单点登录自动注册为AList账户,点击查看<a href="/zh/guide/advanced/sso.html#单点登录自动注册为alist帐号">详细说明</a><br/>4.<a href="/zh/guide/drivers/139.html">移动云盘</a>和<a href="/zh/guide/drivers/189.html">天翼云</a>分别有改动详情请自行查看文档<br/>5.v3.20.1的版本破坏性更新<a href="https://github.com/alist-org/alist/discussions/4702">查看详细说明</a>,前往<a href="/zh/config/configuration.html#scheme">配置文档页面</a><br/>6.AList v3.30.0版本开始将不再支持Win7/Server2008,因为Go不支持了,<a href="https://github.com/golang/go/issues/64622">点击查看详细说明</a>.<br/><span style="color:rgb(255, 0, 0);font-weight:bold;">7.添加云盘后请及时配置[防盗/元信息]等措施,防止被[爬虫/其他人]恶意[访问/分享]导致帐号被[冻结/禁用].</span></span>',
164164
actions: [
165165
// {
166166
// text: "阿里云open",

docs/config/configuration.md

+48-5
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,13 @@ After modifying the configuration file, restart AList for changes to take effect
4747
"name": "",
4848
"db_file": "data\\data.db",
4949
"table_prefix": "x_",
50-
"ssl_mode": ""
50+
"ssl_mode": "",
51+
"dsn": ""
52+
},
53+
"meilisearch": {
54+
"host": "http://localhost:7700",
55+
"api_key": "",
56+
"index_prefix": ""
5157
},
5258
"scheme": {
5359
"address": "0.0.0.0",
@@ -61,11 +67,12 @@ After modifying the configuration file, restart AList for changes to take effect
6167
},
6268
"temp_dir": "data\\temp",
6369
"bleve_dir": "data\\bleve",
70+
"dist_dir": "",
6471
"log": {
6572
"enable": true,
6673
"name": "data\\log\\log.log",
67-
"max_size": 10,
68-
"max_backups": 5,
74+
"max_size": 50,
75+
"max_backups": 30,
6976
"max_age": 28,
7077
"compress": false
7178
},
@@ -100,7 +107,7 @@ After modifying the configuration file, restart AList for changes to take effect
100107
"allow_headers": [
101108
"*"
102109
]
103-
}
110+
}
104111
}
105112
```
106113

@@ -194,7 +201,8 @@ The database configuration, which is by default `sqlite3`. Available options are
194201
"name": "", //database name
195202
"db_file": "data\\data.db", //Database location, used by sqlite3
196203
"table_prefix": "x_", //database table name prefix
197-
"ssl_mode": "" //To control the encryption options during the SSL handshake, the parameters can be searched by themselves, or check the answer from ChatGPT below
204+
"ssl_mode": "", //To control the encryption options during the SSL handshake, the parameters can be searched by themselves, or check the answer from ChatGPT below
205+
"dsn": "" // https://github.com/alist-org/alist/pull/6031
198206
},
199207
```
200208

@@ -247,6 +255,24 @@ In PostgreSQL, the `ssl_mode` parameter is used to specify how the client uses S
247255

248256

249257

258+
### **meilisearch**
259+
260+
```json
261+
"meilisearch": {
262+
"host": "http://localhost:7700", //Use `meilisearch` link, the default is the local machine
263+
"api_key": "", //Please check the `meilisearch` documentation
264+
"index_prefix": "" //Please check the `meilisearch` documentation
265+
},
266+
```
267+
268+
Documentation link::https://www.meilisearch.com/docs
269+
270+
271+
272+
<br/>
273+
274+
275+
250276
### **scheme**
251277

252278
The configuration of scheme. Set this field if using HTTPS.
@@ -290,6 +316,23 @@ Where data is stored when using **`bleve`** index.
290316

291317

292318

319+
### **dist_dir**
320+
321+
If this item is set, the front -end file of this option is preferred to render, support the use of other front -end files, and the back -end continues to use the original application
322+
323+
- https://github.com/alist-org/alist/issues/5531
324+
- https://github.com/alist-org/alist/discussions/6110
325+
326+
Upload the front -end file (dist) to the `data` folder of the application, and then fill in this way. The disadvantage is that if you update each time, you need to change the file manually
327+
328+
```json
329+
"dist_dir": "data\\dist",
330+
```
331+
332+
<br/>
333+
334+
335+
293336
### **log**
294337

295338
The log configuration. Set this field to save detailed logs of disable.

docs/config/global.md

+33-2
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,12 @@ star: true
2020

2121
### **Hide files**
2222

23-
Match files hidden by regular expressions(`javascript`). If you don't understand, don't fill in them randomly. Wrong regular expressions will cause the front-end page to crash. One per line. By default, there is an example expression that hides README.md in all directories.
23+
Match files hidden by regular expressions(`javascript`). If you don't understand, don't fill in them randomly. Wrong regular expressions `/\/README.md/i` will cause the front-end page to crash. One per line. By default, there is an example expression that hides README.md in all directories.
2424

2525
It's not really hiding. It still exists in the list returned by the api, it just doesn't show up in the frontend list. So if you want to really hide, add a [meta](../guide/advanced/meta.md) record instead.
2626

27+
<br/>
28+
2729

2830

2931
### **Package download**
@@ -33,18 +35,24 @@ Whether to enable package download, default is true. 【Not recommended especial
3335
- It is recommended to push files to Aria2 for downloading. Aria2 supports the download folder to save the directory structure.
3436
- View in detail【[What is the difference between the two Aria2](./other.md#other)
3537

38+
<br/>
39+
3640

3741

3842
### **Customize head**
3943

4044
Any content you want which are automatically placed at the beginning of the head of the web page
4145

46+
<br/>
47+
4248

4349

4450
### **Customize body**
4551

4652
Any content you want which are automatically placed at the end of the body of the web page
4753

54+
<br/>
55+
4856

4957

5058
### **Link expiration**
@@ -54,32 +62,53 @@ The expiration time of the direct link, in hours. If it equals 0, it will not ex
5462
Only the straight chain of the path with the password added will have an expiration time, otherwise it will not expire.Because the expiration time is added to the sign query parameter, and the path without adding the password will not check the sign.
5563
:::
5664

65+
<br/>
66+
5767

5868

5969
### **Privacy regs**
6070

6171
What you don't want to show in the error message, One regular expression (in `Golang`) per line. The matched content will be replaced with * of the corresponding length.
6272

73+
<br/>
74+
6375

6476

6577
### **Ocr api**
6678

6779
Used to identify verification codes. You can deploy yourself: https://hub.docker.com/r/xhofe/ddddocr_server. The default ocr api is deployed on the [koyeb](https://app.koyeb.com/)(No availability guarantee), which is not recommended to use in production environment.
6880

81+
<br/>
82+
6983

7084

7185
### **Sign all**
7286

73-
Add signatures to the direct link of all files (whether with password or not) That is https://xxxx.com/d/xx? ==**sign=vUQ5KFXnwMseKnIUXGRcfoG3cEHzKFBiPGp1NriMDXA=:0**==
87+
Add signatures to the direct link of all files (whether with password or not)
88+
89+
That is`https://xxxx.com/d/xx?sign=vUQ5KFXnwMseKnIUXGRcfoG3cEHzKFBiPGp1NriMDXA=:0`
7490

7591
If you need to close it, you can close it yourself, but you need to pay attention to security issues. After closing the signature, if the site can be accessed by the public network, the password may be bypassed to access private files.
7692

93+
There are two other methods that also carry the `sign?xxx` parameter, 1. Add Storage Select `Enable Signing`, 2. Meta Information Add Password
94+
95+
The scope of the three methods`Sign All` > `Meta Information Add Password` > Add Storage Select `Enable Signing`
96+
97+
1. Sign All: If this option is turned on, the sign parameter will be carried regardless of whether meta-information is encrypted or not, and whether `Enable Signing` is checked when adding storage.
98+
2. Meta Information Add Password:Only files under this meta information path will carry the sign parameter.
99+
- If **Apply to sub folder** is turned on, all files in this path will carry the sign parameter
100+
3. Add Storage Select `Enable Signing`:Only this storage driver carries the sign parameter.
101+
102+
<br/>
103+
77104

78105

79106
## **Forward direct link params**
80107

81108
You can check it out yourself:**https://github.com/alist-org/alist/issues/3123**
82109

110+
<br/>
111+
83112

84113

85114
### **Filename char mapping**
@@ -94,6 +123,8 @@ For example, the `/` symbol is a path symbol in the Alist program. Some people
94123

95124
The default is the first one at the beginning. If you want to add it later, you can add it later. The format is as simple as above.
96125

126+
<br/>
127+
97128

98129

99130
## **Webauthn login enabled**

0 commit comments

Comments
 (0)