Skip to content

Commit 551ee51

Browse files
authored
update docs (#185)
* 更新文档杂项 * test New url open * 添加移动云,alias,流程图跳转测试等 * 完成 * 添加做种时间说明 * 添加离线 torrent 类型文件说明 * update docs * index readme add aliss * fix error * fix errot2
1 parent 17f635a commit 551ee51

File tree

14 files changed

+191
-22
lines changed

14 files changed

+191
-22
lines changed
18.9 KB
Loading
58.3 KB
Loading

docs/guide/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ A file list program that supports multiple storage, and supports web browsing an
5353
- [x] [TeraBox](https://www.terabox.com/)
5454
- [x] Alist v2/v3
5555
- [x] SMB
56+
- [x] [alias](../guide/advanced/alias.md)
5657
- [x] [115](https://115.com/)
5758
- [x] [Seafile](https://www.seafile.com/)
5859
- [x] Cloudreve

docs/guide/advanced/alias.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,11 @@ The folder content rules when displaying are as follows
3838

3939
Let me explain **`same name first²`** access rules
4040

41+
42+
:::tabs#alias
43+
44+
@tab example 1
45+
4146
Example 1. Fill in the access according to the following path(302 mode has priority)
4247

4348
```
@@ -54,6 +59,8 @@ local: /localtest/local4
5459
- If 3 uses a local proxy and 4 uses `302`, call 4 first
5560

5661

62+
@tab example 2
63+
5764
Example 2. Fill in the access according to the following path(302 mode has priority)
5865

5966
```
@@ -69,7 +76,28 @@ local: /localtest/local1
6976
- 2, a video 3 4 has then every visit is `4`
7077
- If 4 uses a local proxy and 2 uses `302`, call 2 first
7178

79+
@tab example 3
80+
81+
Example 3、 Fill in the access according to the following path(302 mode has priority)
82+
83+
Of course, it is not limited to only 2 folders, just write according to personal needs
84+
85+
```
86+
Local test:/local1/video
87+
Local test:/local2/video
88+
Test other:/test3/images
89+
Test other:/test4/video/tv
90+
```
91+
92+
- local1 local2 merged together
93+
- If 2 uses a local proxy and 1 uses `302`, call 2 first
94+
- Test 3 and Test 4 merged together
95+
- If 3 uses a local proxy and 4 uses `302`, call 4 first
96+
- In the above two cases, two different folders will appear for display, which will be displayed as follows without interfering with each other
97+
98+
![alias](/img/drivers/alias/alias-3.png)
7299

100+
:::
73101

74102

75103
### How to add

docs/guide/advanced/offline-download.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,9 +67,13 @@ According to [source code](https://github.com/alist-org/alist/blob/main/internal
6767

6868

6969
3. Use **`qBittorrent`** to offline `.torrent` type files
70-
- Although you cannot directly add offline `.torrent` type files, you can save the country with a curve Reference: [View method](https://github.com/alist-org/alist/issues/2459#issuecomment-1354870010)
70+
- Although you cannot directly add offline `.torrent` type files, you can save the country with a curve Reference: [View method](https://github.com/alist-org/alist/issues/2459#issuecomment-1354870010)
71+
72+
7173
4. You can configure it yourself not to delete after the download is complete, but to do seeding, the default is `0`, and it will be deleted immediately after uploading
7274
- Modification location: **Alist background** --> **Settings** --> **Qbittorrent seedtime** option, set the time you need to configure, the unit is `minute`, after the set seeding time is reached, it will automatically delete
75+
76+
7377
5. ==We can also customize, instead of using the default presets==
7478
- Modification location: **Alist Manage** --> **Settings** --> **Qbittorrent url** option, just follow the modification
7579

docs/guide/drivers/alias.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ 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)
3334

3435

3536
## How to fill in
@@ -99,3 +100,6 @@ According to the second method, we can merge and display different folders, whic
99100
> At the same time, the uppercase `Video` will gather the files of the three folders
100101
101102
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
103+
104+
> 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)
105+

docs/guide/drivers/aliyundrive_open.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,9 @@ typeof fetch !== "undefined" && getLimit()
4242
1. ==The refresh token obtained by this tool can only be used for **Aliyundrive open platform** storage mount method==
4343
2. The token filled in when Alist is mounted should also be provided by this tool, and the previous acquisition method will not be available
4444
3. Not applicable to others, but only for Alist
45-
4. If the same IP requests {{ max }} times within {{ minutes }} minutes, **TooManyRequests** will appear. :no_entry_sign:So please do not abuse:no_entry_sign:
45+
4. If the same IP requests =={{ max }}== times within =={{ minutes }}== minutes, **TooManyRequests** will appear. :no_entry_sign:So please do not abuse:no_entry_sign:
4646
- For example, a request is counted when saving/editing, and viewing a file or watching a video download is not counted.
47+
- The number of times and time mentioned above are dynamic~
4748

4849
:::
4950

@@ -118,6 +119,23 @@ two、
118119
>- Real-time transcoding takes some time.
119120
>- The picture quality are: LD|SD|HD|FHD|QHD
120121
122+
three、
123+
124+
> - If the Alibaba cloud disk you mounted is Open, after restarting, reloading, and updating, you will find a prompt **TooManyRequests**
125+
>
126+
> - Check whether your account exceeds the number mentioned in the note in the red prompt at the top, that is, the number of open Alibaba Cloud disks you added > =={{ max }}==
127+
>
128+
> - The solution is to disable all the mounted Alibaba cloud disk Open, wait for =={{ minutes }}== minutes, and then click one by one to enable the number not to exceed =={{ max }}== times, and then wait =={{ minutes }}== After a few minutes, click to open again, and it will recover slowly.
129+
> - (Whispering reminder: If you have more than a dozen accounts, it’s okay, it’s not a big problem to restore =={{ max }}== one at a time. If you have 30 or 50 accounts, it is recommended that you restore about 4 each time , because it will help you refresh the refresh token every 2 hours, and it will also be called to prevent you from causing GG too many times...)
130+
>
131+
>
132+
>
133+
>- Another problem, if the Alibaba Cloud Disk Open you mounted is a cloud disk account, and then mounted different folders to the account and added multiple accounts, resulting in too many Alibaba Cloud Open accounts added, this is a good solution
134+
> - Solution: Go to the official page of Alibaba Cloud Disk and integrate all the folders you need to mount into one folder, then only mount the integrated folder, and then pass [**alias**](../advanced/alias.md) are mounted separately, just write one for each path, so that a single path can be mounted and displayed separately. Of course, you can also integrate multiple ones together, or use it directly. Example 3 to show different ones can also be
135+
>
136+
>
137+
>
138+
> If you add more than =={{ max }}== to one account and one network disk, then you can only restore it slowly by starting.
121139
122140

123141
### The default download method used

docs/guide/drivers/s3.md

Lines changed: 30 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -176,13 +176,39 @@ Fill in example:
176176

177177
[**Amazon S3 Official Website**](https://s3.console.aws.amazon.com/s3/)
178178

179-
No example
179+
The endpoint URL contains the name of the region where the bucket is located
180180

181-
None: Get **Endpoint** hellish difficulty....
181+
Example ^1^, if your bucket is in the US East (Ohio) region
182182

183-
If you have to give it a try, you can refer to **https://www.youtube.com/watch?v=uvKWJ4c1EYc**
183+
> Then the format of the Endpoint URL is **`s3.us-east-2.amazonaws.com/your-bucket-name`**
184+
>
185+
> Region parameter: **`us-east-2`**
186+
>
187+
> Bucket name: **`your-bucket-name`** (your own bucket name)
184188
185-
Or use your own method, welcome to add after success~
189+
Example^2^, my storage bucket is `Tokyo`, and the name of the storage bucket is `cdn-aw`, then the complete parameter filling is as follows
190+
191+
>1. **Endpoint**: s3.ap-northeast-1.amazonaws.com
192+
>2. **Region**: ap-northeast-1
193+
>3. **Bucket Name**: cdn-aw
194+
195+
Let's take a look at the complete parameter filling example
196+
197+
Fill in example:
198+
199+
![s3](/img/drivers/s3/aws.png)
200+
201+
@tab R2
202+
203+
[**cloudflare R2 Official Website**](https://dash.cloudflare.com/)
204+
205+
**Endpoint** :The S3 endpoint is available via the **`https://<ACCOUNT_ID>.r2.cloudflarestorage.com`** endpoint.
206+
207+
**`ACCOUNT_ID`** :This account ID can be seen everywhere, and the simplest is the position at the top of the browser. The string of IDs behind the website link is your account ID.
208+
209+
Fill in example:
210+
211+
![s3](/img/drivers/s3/cfr2.png)
186212

187213
@tab R2
188214

docs/zh/guide/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@ category:
5151
- [x] [TeraBox -海外百度](https://www.terabox.com/)
5252
- [x] Alist v2/v3
5353
- [x] SMB
54+
- [x] [别名](../guide/advanced/alias.md)
5455
- [x] [115](https://115.com/)
5556
- [x] [Seafile](https://www.seafile.com/)
5657
- [x] Cloudreve

docs/zh/guide/advanced/alias.md

Lines changed: 36 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,12 @@ sticky: true
1616
star: true
1717
---
1818

19-
# alias
2019

21-
`alias`是什么? `alias`是路径合并的功能
20+
# alias别名
21+
22+
`别名-alias`是什么? `别名-alias`是路径合并的功能
23+
24+
2225

2326
除了 **`下载预览(只读)`** 操作之外 ^(复制,删除,重命名,离线下载,上传)^ 均不可以
2427

@@ -37,7 +40,12 @@ star: true
3740

3841

3942

40-
下面解释一下 **`同名优先²`** 访问规则
43+
44+
下面解释一下 **`同名优先²`** 访问规则,强烈建议查看个举例都查看
45+
46+
:::tabs#alias
47+
48+
@tab 例1
4149

4250
例1、 根据下面路径填写访问(302模式有优先权)
4351

@@ -55,7 +63,7 @@ star: true
5563
- 如果 3 使用的本地代理,4 使用的`302`,优先调用 4
5664

5765

58-
66+
@tab 例2
5967

6068
例2、根据下面的路径填写访问(302模式有优先权)
6169

@@ -72,9 +80,32 @@ star: true
7280
- 2,一个视频 2 4 有 那么每次访问的都是`4`
7381
- 如果 4 使用的本地代理,2 使用的`302`,优先调用 2
7482

83+
@tab 例3
84+
85+
例3、根据下面的路径填写访问(302模式有优先权)
86+
87+
当然了不限于只有2个文件夹,根据个人需求来写即可
88+
89+
```
90+
本地测试:/本地1/video
91+
本地测试:/本地2/video
92+
测试其他:/测试3/images
93+
测试其他:/测试4/video/电视
94+
```
95+
96+
- 本地1 本地2 合并在一起了
97+
- 如果2 使用的本地代理,1 使用的`302`,优先调用 2
98+
- 测试3 测试4 合并在一起了
99+
- 如果3 使用的本地代理,4 使用的`302`,优先调用 4
100+
- 以上两种情况会出现两个不同的文件夹来展示,会如下展示,不会互相干扰
101+
102+
![alias](/img/drivers/alias/alias-3.png)
103+
104+
:::
75105

76106

77107

78108
### 如何添加
79109

80-
前往存储添加 [**alias**](../drivers/alias.md)
110+
前往存储添加 [**别名-alias**](../drivers/alias.md)
111+

0 commit comments

Comments
 (0)