Skip to content

Commit 7b25d6f

Browse files
authored
docs: update docs (#257)
* fix url error * update docs * add webauthn docs * fix 123 typo Error * update webauthn * update Webauthn
1 parent 28b6fcc commit 7b25d6f

File tree

26 files changed

+424
-47
lines changed

26 files changed

+424
-47
lines changed
27 KB
Loading

docs/.vuepress/theme.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ export default hopeTheme(
138138
{
139139
path: "/",
140140
title: 'Kind tips',
141-
content: '<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.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/>3.<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/>4.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/>5. If there is an update to mount Lanzou Cloud, please refer to the document for details.<br/>6.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>',
141+
content: '<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. If there is an update to mount Lanzou Cloud, please refer to the document for details.<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>',
142142
actions: [
143143
// {
144144
// text: "Aliyun open",
@@ -161,7 +161,7 @@ export default hopeTheme(
161161
{
162162
path: "/zh",
163163
title: '温馨提示',
164-
content: '<span style="color:rgb(255, 0, 0);font-weight:bold;">请仔细查看弹窗提示内容</span><br/><br/>1.<span style="color:blue; font-weight:bold;">v3.25.0新版更新了新的密码方式,获取方式也进行了更改,详细说明请看自己安装方式的文档页面内</span><br/>2.AList版本大于v3.22.1,新版本新增单点登录自动注册为AList账户,点击查看<a href="/zh/guide/advanced/sso.html#单点登录自动注册为alist帐号">详细说明</a><br/>3.<a href="/zh/guide/drivers/139.html">移动云盘</a>和<a href="/zh/guide/drivers/189.html">天翼云</a>分别有改动详情请自行查看文档<br/>3.v3.20.1的版本破坏性更新<a href="https://github.com/alist-org/alist/discussions/4702">查看详细说明</a>,前往<a href="/zh/config/configuration.html#scheme">配置文档页面</a><br/>5.挂载蓝奏云有更新,详细请看文档.<br/>6.添加云盘后请及时配置[防盗/元信息]等措施,防止被[爬虫/其他人]恶意[访问/分享]导致帐号被[冻结/禁用].</span>',
164+
content: '<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.挂载蓝奏云有更新,详细请看文档.<br/>7.添加云盘后请及时配置[防盗/元信息]等措施,防止被[爬虫/其他人]恶意[访问/分享]导致帐号被[冻结/禁用].</span>',
165165
actions: [
166166
// {
167167
// text: "阿里云open",

docs/config/global.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,4 +72,17 @@ For example, the `/` symbol is a path symbol in the Alist program. Some people
7272
{"/": "|","xx1":"xx1","xx2":"xx2"}
7373
```
7474

75-
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.
75+
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.
76+
77+
## **Webauthn login enabled**
78+
79+
What is **Webauthn**? Search for yourself, today I just teach you how to use it
80+
81+
In the background `Settings`-->`Global`-->Open `Webauthn login enabled`, go back to the background `Profile`-->Bind `Add a Webauthn credential`
82+
83+
- `Add a Webauthn credential` using the `PIN` of this computer or `complementary devices (such as bracelets, watches)` [support all options in Windows Hello configuration, such as `face` and `fingerprint`]
84+
- Just like binding single sign-on, we can use **`Webauthn`** to log in after binding
85+
86+
- On the login page, click the login button on the far right, enter our user name, click login, and then unlock the required `Webauthn` verification method to log in
87+
- Adding `Webauthn` requires a secure origin and can only be used on `https` or `localhost`
88+
- Unsafe sources, such as: http, 192.168.x.x, 127.0.0.1, or directly use the server IP, etc. These places cannot be used

docs/config/other.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,4 +40,9 @@ The token that can be used to access all API.
4040

4141
### **other**
4242

43-
When using it, I found that there are two Aria2, but what is the difference? [**Click to view the detailed description**](../faq/why.md#what-is-the-difference-between-the-two-aria2)
43+
1. When using it, I found that there are two Aria2, but what is the difference? [**Click to view the detailed description**](../faq/why.md#what-is-the-difference-between-the-two-aria2)
44+
2. Support using Aria2 to download folders at the same time and save the folder directory structure style
45+
46+
- Opening method, `Toggle Checkbox` in the lower right corner--> select list file/folder--> `Download` at the bottom--> `send to Aria2`
47+
48+
- But it is recommended not to download too much at one time. For example, downloading thousands of folders and tens of thousands of files at one time may cause AList to crash

docs/faq/howto.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,23 @@ Otherwise you can ask the owner to reset the password.
5353
You need to stop alist server first if the version of your alist is v3.9.0 or later as this pr: https://github.com/alist-org/alist/pull/3074
5454
:::
5555

56+
#### Lower than v3.25.0
57+
58+
```bash
59+
./alist admin
60+
```
61+
62+
#### Higher than v3.25.0
63+
64+
Versions above 3.25.0 change the password to an encrypted hash value, and the password cannot be calculated directly. If the password is forgotten, it can only be re-**`randomly generated`** or **`manually set`**
65+
66+
```bash
67+
# Randomly generate a password
68+
./alist admin random
69+
# Manually set a password, `NEW_PASSWORD` refers to the password you need to set
70+
./alist admin set NEW_PASSWORD
71+
```
72+
5673
### **How to modify the listening port​**
5774

5875
Refer to [config](../config/configuration.md#port)

docs/guide/advanced/alias.md

Lines changed: 75 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,17 @@ star: true
1818

1919
# alias
2020

21+
Let's look at a schematic
22+
23+
![alias](/img/drivers/alias/alias.png)
24+
25+
We see that two different folders are merged into one folder, and the file folders with the same name are also merged together, and the unique ones are displayed separately
26+
27+
- Example 1 `riluo.jpg` is unique to local 1, shown above
28+
29+
- Example 2 Two folders have a `video` folder, but the content inside will also be merged, and the subfolders also apply to the display rules of `merging with the same name`
30+
- There are two videos in each of the two folders, but one of them has the same name. Finally, according to the display rules of `merging with the same name`, it becomes `3` files for display after merging
31+
2132
What are `alias`? `alias` is a function for path merging
2233

2334
Except **`download preview (read-only)`** operations ^(copy, delete, rename, offline download, upload)^ are not allowed
@@ -34,10 +45,40 @@ The folder content rules when displaying are as follows
3445
2. Priority of the same name: When accessing resources, the path file (folder) at the top (front) when filling in the path for each fixed access
3546
- If the files with the same name are merged, click **` to play, and when downloading`**, it will be called first. When filling in `Paths`, the file with the 302 mode path will be used first.
3647

48+
Let me explain **`same name first²`** access rules
49+
3750

51+
## **How to fill in**
3852

39-
Let me explain **`same name first²`** access rules
53+
There are two ways to fill in
54+
55+
1. The first one is that you can only fill in the path of the subfolder and the folder with the same name must be used at the end. It is not recommended to use :x:
56+
57+
-Paths filling example:
58+
59+
```path
60+
/file1/locala
61+
/file2/localb
62+
```
63+
64+
65+
66+
2. The second is to directly mount the root folder path, using the `renaming` method, it is strongly recommended to use :heavy_check_mark:
67+
68+
-Paths filling example:
69+
70+
```path
71+
#Example 1 Directly write the root folder
72+
merge: /file1
73+
merge: /file2
74+
75+
#Example 2 Mount different path folders for merging
76+
merge: /file1/localtest233
77+
merge: /file2/videos/TV series
78+
merge: /file3 2/TV/Domestic TV Series/Station XX
79+
```
4080
81+
According to the second method, we can `merge` and display different folders, which is convenient and quick
4182
4283
:::tabs#alias
4384
@@ -99,7 +140,38 @@ Test other:/test4/video/tv
99140
100141
:::
101142
143+
### **The download method to use**
144+
145+
​ When adding **`alias`**, `Web Proxy` and `Webdav Policy` are not modified by default. The storage path filled in the Paths path can be `302`, `Local Proxy`, `Download Proxy URL`, three modes Mixed Playback Mixed Playback is possible
146+
147+
​ If you checked `Web Proxy`, the storage filled in by the Paths path, if there is a 302 mode playback, it will be played in transit (local proxy mode) at that time, and it will become a proxy mode. If the Webdav policy is also changed, it will also change
148+
149+
​ Of course, it is up to you to choose whether to change the mode
150+
151+
152+
153+
### **What if you don’t know how the cloud disks you added are different?**
154+
155+
1. You can go to the bottom of the corresponding document to view the document, there is a flow chart description
156+
157+
- If there is a 302, the 302 method is used by default. If there are only local proxy and download proxy URLs, the default is to use the local proxy, provided that you have not manually selected
158+
159+
2. You can check when adding storage, select the corresponding storage to view, for example, let’s check the methods of Alibaba Cloud and 115 respectively
160+
161+
- As you can see from the figure below, Alibaba Cloud Disk has the option of `web proxy`, and `webdav policy` defaults to 302. It can be judged that Alibaba Cloud Disk uses the 302 method by default
162+
- As you can see from the figure below, the 115 network disk does not have the option of `web proxy`, and the `webdav strategy` defaults to the local proxy. It can be judged that the 115 network disk uses the local proxy mode by default
163+
164+
- ![alias](/img/drivers/alias/alias-2.png)
165+
166+
167+
168+
### **other instructions**
169+
170+
> If you are using `Windows`, the following situation will occur, and folders with different capitalization will also be regenerated
171+
> For example, Local 1 and Local 2 have a lowercase v for `video` respectively, and the folder OneDrive has an uppercase V `Video` folder
172+
> Then a lowercase video folder will be generated, which contains only `local 1, local 2` files merged by two folders
173+
> At the same time, the uppercase `Video` will gather the files of the three folders
102174
103-
### **How to add**
175+
This is because Windows is case-insensitive, video and Video will be considered as the same folder, you will not have this problem if you switch to Linux or Mac
104176
105-
Go to storage add [**alias**](../drivers/alias.md)
177+
> Aliases are not supported for load balancing for the time being (if it is supported later, the document will be modified here, if it is not modified, it is not yet supported)

docs/guide/drivers/123.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,9 @@ star: true
1818

1919
# 123Pan/Share
2020

21-
::: warning This driver is no longer actively maintained due to 123Pan's limitations
21+
::: warning
22+
23+
This driver is no longer actively maintained due to 123Pan's limitations
2224
:::
2325

2426
## **personal**

docs/guide/drivers/Crypt.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ What is `Crypt`?
2424

2525
In simple words, it's a two-password-protected safe. No one can open it without the key. The password and the salt in the configuration form the key.
2626

27-
::: Tips
27+
::: tip
2828

2929
1. If you don’t know how to use this encryption/decryption driver, please read this guide carefully
3030
2. Please test it locally to understand it fully before use in the production environment.

docs/guide/drivers/alias.md

Lines changed: 82 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,23 @@ We see that two different folders are merged into one folder, and the file folde
3030
- Example 2 Two folders have a `video` folder, but the content inside will also be merged, and the subfolders also apply to the display rules of `merging with the same name`
3131
- There are two videos in each of the two folders, but one of them has the same name. Finally, according to the display rules of `merging with the same name`, it becomes `3` files for display after merging
3232

33-
See additional explanation [**alias-alias**](../advanced/alias.md)
33+
What are `alias`? `alias` is a function for path merging
34+
35+
Except **`download preview (read-only)`** operations ^(copy, delete, rename, offline download, upload)^ are not allowed
36+
37+
For example: cloud disk account 1 and cloud disk account 2 both have the folder `Movies`, but the contents may not (all) overlap
38+
39+
**`Previously (virtual path)`**: can only be mounted to two different paths (cloud disk 1/movie, cloud disk 2/movie) or (movie\cloud disk 1, movie\cloud disk 2 )
40+
**`Now(alias)`**: Provide an aggregated folder (movie) which can contain the contents of cloud disk 1 and cloud disk 2 at the same time
41+
42+
43+
44+
The folder content rules when displaying are as follows
45+
1. Merge with the same name: the same files (folders) are automatically merged into one
46+
2. Priority of the same name: When accessing resources, the path file (folder) at the top (front) when filling in the path for each fixed access
47+
- If the files with the same name are merged, click **` to play, and when downloading`**, it will be called first. When filling in `Paths`, the file with the 302 mode path will be used first.
48+
49+
Let me explain **`same name first²`** access rules
3450

3551

3652
## **How to fill in**
@@ -48,24 +64,82 @@ There are two ways to fill in
4864
4965
5066
51-
2. The second is to directly mount the root folder path, using the renaming method, it is strongly recommended to use :heavy_check_mark:
67+
2. The second is to directly mount the root folder path, using the `renaming` method, it is strongly recommended to use :heavy_check_mark:
5268
5369
-Paths filling example:
5470
5571
```path
5672
#Example 1 Directly write the root folder
57-
local: /file1
58-
local: /file2
73+
merge: /file1
74+
merge: /file2
5975
6076
#Example 2 Mount different path folders for merging
61-
test: /file1/localtest233
62-
Test: /file2/videos/TV series
63-
Test: /file3 2/TV/Domestic TV Series/Station XX
77+
merge: /file1/localtest233
78+
merge: /file2/videos/TV series
79+
merge: /file3 2/TV/Domestic TV Series/Station XX
6480
```
6581
66-
According to the second method, we can merge and display different folders, which is convenient and quick
82+
According to the second method, we can `merge` and display different folders, which is convenient and quick
83+
84+
:::tabs#alias
85+
86+
@tab example 1
87+
88+
Example 1. Fill in the access according to the following path(302 mode has priority)
89+
90+
```
91+
local: /localtest/local1
92+
local: /localtest/local2
93+
local: /localtest/local3
94+
local: /localtest/local4
95+
```
96+
97+
- 1, if there is a video 1 2 3 4, each visit is `1`
98+
- If 1 3 4 uses the local proxy and 2 uses `302`, call 2 first
99+
100+
- 2, a video 3 4 yes then every visit is `3`
101+
- If 3 uses a local proxy and 4 uses `302`, call 4 first
102+
103+
104+
@tab example 2
105+
106+
Example 2. Fill in the access according to the following path(302 mode has priority)
107+
108+
```
109+
local: /localtest/local4
110+
local: /localtest/local3
111+
local: /localtest/local2
112+
local: /localtest/local1
113+
```
114+
115+
- 1, if a video has 1 2 3 4, each visit is `4`
116+
- If 1 3 4 uses the local proxy and 2 uses `302`, call 2 first
117+
118+
- 2, a video 3 4 has then every visit is `4`
119+
- If 4 uses a local proxy and 2 uses `302`, call 2 first
120+
121+
@tab example 3
122+
123+
Example 3、 Fill in the access according to the following path(302 mode has priority)
124+
125+
Of course, it is not limited to only 2 folders, just write according to personal needs
126+
127+
```
128+
Local test:/local1/video
129+
Local test:/local2/video
130+
Test other:/test3/images
131+
Test other:/test4/video/tv
132+
```
133+
134+
- local1 local2 merged together
135+
- If 2 uses a local proxy and 1 uses `302`, call 2 first
136+
- Test 3 and Test 4 merged together
137+
- If 3 uses a local proxy and 4 uses `302`, call 4 first
138+
- In the above two cases, two different folders will appear for display, which will be displayed as follows without interfering with each other
67139
140+
![alias](/img/drivers/alias/alias-3.png)
68141
142+
:::
69143
70144
### **The download method to use**
71145

docs/guide/drivers/aliyundrive_open.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,9 @@ If you don’t set it, it will be deleted to the recycle bin by default. If ther
130130

131131
## **Drive type**
132132

133-
Have Intelligeent level users default to `Resource`, No Have Intelligent User's default display is` Backup`
133+
You can choose the type of cloud disk, and you can choose a different type according to your needs. You can set it when adding a driver using AList of v3.25.1 and above. The default is the `default` type
134+
135+
- **default**: Have Intelligeent level users default to `Resource`, No Have Intelligent User's default display is` Backup`
134136

135137
- **Resource**: corresponding to `Resource` of the cloud disk
136138
- **Backup**: corresponding to the `Backup` of the cloud disk

0 commit comments

Comments
 (0)