Skip to content

Commit

Permalink
Docs:Synchronous v3.31/2.0 some functions (#330)
Browse files Browse the repository at this point in the history
* one commit

* update

* update
  • Loading branch information
anwen-anyi committed Mar 2, 2024
1 parent e50c4c4 commit c2c15a1
Show file tree
Hide file tree
Showing 33 changed files with 2,083 additions and 1,322 deletions.
Binary file modified docs/.vuepress/public/img/advanced/backup.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions docs/.vuepress/theme.ts
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ export default hopeTheme(
{
path: "/",
title: 'Kind tips',
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>',
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>',
actions: [
// {
// text: "Aliyun open",
Expand All @@ -160,7 +160,7 @@ export default hopeTheme(
{
path: "/zh",
title: '温馨提示',
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>',
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>',
actions: [
// {
// text: "阿里云open",
Expand Down
53 changes: 48 additions & 5 deletions docs/config/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,13 @@ After modifying the configuration file, restart AList for changes to take effect
"name": "",
"db_file": "data\\data.db",
"table_prefix": "x_",
"ssl_mode": ""
"ssl_mode": "",
"dsn": ""
},
"meilisearch": {
"host": "http://localhost:7700",
"api_key": "",
"index_prefix": ""
},
"scheme": {
"address": "0.0.0.0",
Expand All @@ -61,11 +67,12 @@ After modifying the configuration file, restart AList for changes to take effect
},
"temp_dir": "data\\temp",
"bleve_dir": "data\\bleve",
"dist_dir": "",
"log": {
"enable": true,
"name": "data\\log\\log.log",
"max_size": 10,
"max_backups": 5,
"max_size": 50,
"max_backups": 30,
"max_age": 28,
"compress": false
},
Expand Down Expand Up @@ -100,7 +107,7 @@ After modifying the configuration file, restart AList for changes to take effect
"allow_headers": [
"*"
]
}
}
}
```

Expand Down Expand Up @@ -194,7 +201,8 @@ The database configuration, which is by default `sqlite3`. Available options are
"name": "", //database name
"db_file": "data\\data.db", //Database location, used by sqlite3
"table_prefix": "x_", //database table name prefix
"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
"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
"dsn": "" // https://github.com/alist-org/alist/pull/6031
},
```

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



### **meilisearch**

```json
"meilisearch": {
"host": "http://localhost:7700", //Use `meilisearch` link, the default is the local machine
"api_key": "", //Please check the `meilisearch` documentation
"index_prefix": "" //Please check the `meilisearch` documentation
},
```

Documentation link::https://www.meilisearch.com/docs



<br/>



### **scheme**

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



### **dist_dir**

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

- https://github.com/alist-org/alist/issues/5531
- https://github.com/alist-org/alist/discussions/6110

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

```json
"dist_dir": "data\\dist",
```

<br/>



### **log**

The log configuration. Set this field to save detailed logs of disable.
Expand Down
35 changes: 33 additions & 2 deletions docs/config/global.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,12 @@ star: true

### **Hide files**

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.
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.

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.

<br/>



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

<br/>



### **Customize head**

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

<br/>



### **Customize body**

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

<br/>



### **Link expiration**
Expand All @@ -54,32 +62,53 @@ The expiration time of the direct link, in hours. If it equals 0, it will not ex
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.
:::

<br/>



### **Privacy regs**

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.

<br/>



### **Ocr api**

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.

<br/>



### **Sign all**

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

That is`https://xxxx.com/d/xx?sign=vUQ5KFXnwMseKnIUXGRcfoG3cEHzKFBiPGp1NriMDXA=:0`

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.

There are two other methods that also carry the `sign?xxx` parameter, 1. Add Storage Select `Enable Signing`, 2. Meta Information Add Password

The scope of the three methods`Sign All` > `Meta Information Add Password` > Add Storage Select `Enable Signing`

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.
2. Meta Information Add Password:Only files under this meta information path will carry the sign parameter.
- If **Apply to sub folder** is turned on, all files in this path will carry the sign parameter
3. Add Storage Select `Enable Signing`:Only this storage driver carries the sign parameter.

<br/>



## **Forward direct link params**

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

<br/>



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

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.

<br/>



## **Webauthn login enabled**
Expand Down

0 comments on commit c2c15a1

Please sign in to comment.