Skip to content

Docd: Update #428

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 23, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.vuepress/public/img/config/readme_b.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.vuepress/public/img/config/readme_h.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.vuepress/public/img/desktop/key_mbd.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.vuepress/public/img/desktop/logIn_mbd.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
18 changes: 16 additions & 2 deletions docs/config/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,8 @@ After modifying the configuration file, restart AList for changes to take effect
"cert_file": "",
"key_file": "",
"unix_file": "",
"unix_file_perm": ""
"unix_file_perm": "",
"enable_h2c": false
},
"temp_dir": "data\\temp",
"bleve_dir": "data\\bleve",
Expand Down Expand Up @@ -328,7 +329,8 @@ The configuration of scheme. Set this field if using HTTPS.
"cert_file": "data\\cert.crt", // Path of cert file
"key_file": "data\\key.key", // Path of key file
"unix_file": "", // Unix socket file path to listen on, default empty, if you want to use unix socket, set it to non empty
"unix_file_perm": "" // Unix socket file permission, set to the appropriate permissions
"unix_file_perm": "", // Unix socket file permission, set to the appropriate permissions
"enable_h2c": false // Support HTTP/2 Cleartext (H2C) protocol for alist's http service. The cleartext HTTP/2 protocol supports nginx's grpc_pass after it is enabled - https://github.com/AlistGo/alist/pull/8294
},
```

Expand Down Expand Up @@ -486,6 +488,18 @@ Configuration for background task threads.
- **decompress_upload**:false
- **allow_retry_canceled**:Allow users to retry previously canceled tasks

-----

A new **transmission** configuration path is added to the background configuration: `/@manage/settings/traffic`

- Supports limiting the number of threads and transmission uplink and downlink rates of ==6 tasks==
- **https://github.com/AlistGo/alist/pull/7948**

Operation principle: If `settings/traffic` does not have a thread number field (first run or just upgraded from an old version), `settings/traffic` will be initialized with the value of the config configuration file. If `settings/traffic` has a value, the thread configuration information of config will be ignored

- **https://github.com/AlistGo/alist/pull/7948#issuecomment-2775174617**

- Summary: For newly installed or upgraded versions, the values will be read from the configuration file to initialize the `traffic` configuration information. Subsequent modifications to the thread only need to be modified in the background.

<br/>

Expand Down
20 changes: 19 additions & 1 deletion docs/config/preview.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,11 @@ If you want to use self-deployed onlyoffice to preview office files, you can add
}
}
```
Deploying and using `OnlyOffice` Reference:

- https://github.com/AlistGo/alist/discussions/3255
- https://github.com/AlistGo/alist/discussions/8271

:::

### **Audio cover**
Expand All @@ -124,9 +129,22 @@ After turning on this option, compressed package format files will be previewed

![](/img/advanced/user_read_archives_dark.png#dark)

<br/>
### **Readme autorender**

After closing, the content of the `readme.md` file will not be automatically rendered at the bottom of the file.

### **Filter readme scripts**

Prevent virus script attacks. After turning it on, the contents of `readme.md` will be displayed in text form. The specific effects are as follows

- Including but not limited to strikethrough, tables, task lists, etc. displayed in text form

![](/img/config/readme_b.png#light)
![](/img/config/readme_h.png#dark)



<br/>

-----

Expand Down
11 changes: 11 additions & 0 deletions docs/guide/advanced/meta.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,17 @@ Password required to access this path

- Meta information password will not take effect when accessed using `WebDav`

::: danger Notes

If you want the password to be effective in subfolders, please check `Apply to sub folder` after the password. Do not check `Write` and then check `Apply to sub folder`

The correct check example is shown below. If you configure the options correctly, if you check the wrong option `Write` and then check `Apply to sub folder`, it will cause anyone to have permission to write dangerous operations

![](/img/advanced/meta/password_b.png#light)
![](/img/advanced/meta/password_h.png#dark)

:::

<br/>


Expand Down
2 changes: 1 addition & 1 deletion docs/guide/drivers/115.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# This is the icon of the page
icon: iconfont icon-state
# This control sidebar order
order: 24
order: 26
# A page can have multiple categories
category:
- Guide
Expand Down
15 changes: 13 additions & 2 deletions docs/guide/drivers/115_open.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# This is the icon of the page
icon: iconfont icon-state
# This control sidebar order
order: 25
order: 21
# A page can have multiple categories
category:
- Guide
Expand All @@ -11,6 +11,7 @@ tag:
- Storage
- Guide
- "302"
- Official
# this page is sticky in article list
sticky: true
# this page will appear in starred articles
Expand All @@ -22,7 +23,13 @@ headerDepth: 5

::: tip

Developed using [**115 Open Platform**](https://open.115.com/)、Please use your account in a standardized manner. If you use your account illegally, you will be responsible for the consequences if it is blocked.
Developed using the official [**115 Open Platform API**](https://open.115.com)

:::

::: danger Please read the precautions carefully

Please use your account in a standardized manner. Do not use it for distribution services including but not limited to **`multi-person sharing`**, **`image hosting, software hosting`** and **`video external links to video websites for playback`**, as well as some other irregular uses not mentioned above. You will be responsible for the consequences of your account being blocked.

:::

Expand All @@ -34,6 +41,10 @@ Developed using [**115 Open Platform**](https://open.115.com/)、Please use your

- **https://alist.nn.ci/tool/115/token**

Scan the QR code with your phone and click the blue button to get `refresh token`

When filling in the drive information, you only need to fill in **`refresh token`**, and you don’t need to fill in `access token`

![](/img/drivers/115/115_b.png#light)
![](/img/drivers/115/115_h.png#dark)

Expand Down
2 changes: 1 addition & 1 deletion docs/guide/drivers/123.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# This is the icon of the page
icon: iconfont icon-state
# This control sidebar order
order: 9
order: 61
# A page can have multiple categories
category:
- Guide
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/drivers/139.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# This is the icon of the page
icon: iconfont icon-state
# This control sidebar order
order: 7
order: 51
# A page can have multiple categories
category:
- Guide
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/drivers/163music.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# This is the icon of the page
icon: iconfont icon-state
# This control sidebar order
order: 26
order: 166
# A page can have multiple categories
category:
- Guide
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/drivers/189.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# This is the icon of the page
icon: iconfont icon-state
# This control sidebar order
order: 6
order: 41
# A page can have multiple categories
category:
- Guide
Expand Down
4 changes: 2 additions & 2 deletions docs/guide/drivers/Alist V2 V3.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# This is the icon of the page
icon: iconfont icon-state
# This control sidebar order
order: 32
order: 256
# A page can have multiple categories
category:
- Guide
Expand All @@ -17,7 +17,7 @@ sticky: true
# this page will appear in starred articles
star: true
---
# Alist V2/V3
# AList V2/V3



Expand Down
2 changes: 1 addition & 1 deletion docs/guide/drivers/Crypt.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# This is the icon of the page
icon: iconfont icon-state
# This control sidebar order
order: 12
order: 96
# A page can have multiple categories
category:
- Guide
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/drivers/SMB.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# This is the icon of the page
icon: iconfont icon-state
# This control sidebar order
order: 28
order: 196
# A page can have multiple categories
category:
- Guide
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/drivers/Seafile.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# This is the icon of the page
icon: iconfont icon-state
# This control sidebar order
order: 38
order: 216
# A page can have multiple categories
category:
- Guide
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/drivers/Terabox.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# This is the icon of the page
icon: iconfont icon-state
# This control sidebar order
order: 37
order: 266
# A page can have multiple categories
category:
- Guide
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/drivers/Trainbit.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# This is the icon of the page
icon: iconfont icon-state
# This control sidebar order
order: 39
order: 231
# A page can have multiple categories
category:
- Guide
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/drivers/UrlTree.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# This is the icon of the page
icon: iconfont icon-state
# This control sidebar order
order: 33
order: 181
# A page can have multiple categories
category:
- Guide
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/drivers/alias.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# This is the icon of the page
icon: iconfont icon-state
# This control sidebar order
order: 31
order: 246
# A page can have multiple categories
category:
- Guide
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/drivers/aliyundrive.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# This is the icon of the page
icon: iconfont icon-state
# This control sidebar order
order: 4
order: 16
# A page can have multiple categories
category:
- Guide
Expand Down
3 changes: 2 additions & 1 deletion docs/guide/drivers/aliyundrive_open.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# This is the icon of the page
icon: iconfont icon-state
# This control sidebar order
order: 3
order: 11
# A page can have multiple categories
category:
- Guide
Expand All @@ -11,6 +11,7 @@ tag:
- Storage
- Guide
- "302"
- Official
# this page is sticky in article list
sticky: true
# this page will appear in starred articles
Expand Down
26 changes: 22 additions & 4 deletions docs/guide/drivers/baidu.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# This is the icon of the page
icon: iconfont icon-state
# This control sidebar order
order: 12
order: 66
# A page can have multiple categories
category:
- Guide
Expand All @@ -11,6 +11,7 @@ tag:
- Storage
- Guide
- "302"
- Official
# this page is sticky in article list
sticky: true
# this page will appear in starred articles
Expand Down Expand Up @@ -58,12 +59,24 @@ The root foler to mount, defaults to `/`
- ~~Or turn on the Web proxy, you do not need to modify the UA (you need a large broadband to use it stably)~~
- ~~It is limited to play/download **`video (only tested in the mp4 format other formats are not tested)`**,If it is other format files, such a prompt will appear~~
- ~~This is not a mistake, this is a limit, please do not panic.~~

```json{2-4}

- Crack video: unofficial video interface, dedicated to playing videos, the following errors will occur in non-video formats, which is normal
- The browser also needs to modify the UA: `pan.baidu.com` or `netdisk` In short, if it is not the browser User-Agent, the video can be played.

- The specific situation is the same as the previous unofficial interface usage
- ==The continuous use time is unknown, and 100% availability is not guaranteed==


```json{2-4,7-9}
{
error_code: 31119,
error_msg: "hit black userlist , hit illeage dlna",
request_id: 541111111111111140
},
{
error_code: 31329,
error_msg: "hit black userlist , hit illeage dlna",
request_id: 921111381111111100
}
```

Expand All @@ -84,7 +97,7 @@ It will only be useful if a member finishes modifying **`"User-Agent"`** (choose
If you don’t change **`"User-Agent"`**, you can enable ==Web Agent==, the disadvantage is that you need to build an Alist machine for transfer, that is to say, you need a large broadband to help you transfer

<div>
<p style="text-align: center;"><span>Tutorial on how to modify UA in web page 302 mode: <br/></span>On the left is<span style="color:red;font-weight: bold;font-size: xx-large;">『Official』</span>API,On the right is the<span style="color:blue;font-weight: bold;font-size: xx-large;">『Crack』</span>API</p>
<p style="text-align: center;"><span>Tutorial on how to modify UA in web page 302 mode: <br/></span>On the left is<span style="color:red;font-weight: bold;font-size: xx-large;">『Official』</span>API,On the right is the<span style="color:blue;font-weight: bold;font-size: xx-large;">『Crack video』</span>API</p>
<div class="image-preview">
<video width="360" height="240" controls>
<source src="https://r2.izyt.cc/alist/baidu/%E7%99%BE%E5%BA%A6%E5%AE%98%E6%96%B9%E6%8E%A5%E5%8F%A3.mp4" type="video/mp4">
Expand All @@ -95,6 +108,7 @@ If you don’t change **`"User-Agent"`**, you can enable ==Web Agent==, the disa
</div>
</div>


:::tabs#ua

@tab Web plugin
Expand Down Expand Up @@ -134,6 +148,10 @@ If you use the webpage to modify the **`user-agent`**, you do not need to config

::::

<br/>



## **Upload Config**

Official Documentation: [百度网盘开放平台 - 上传 - 能力说明](https://pan.baidu.com/union/doc/3ksg0s9ye)
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/drivers/baidu.photo.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# This is the icon of the page
icon: iconfont icon-state
# This control sidebar order
order: 13
order: 76
# A page can have multiple categories
category:
- Guide
Expand Down
6 changes: 3 additions & 3 deletions docs/guide/drivers/baidu_share.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# This is the icon of the page
icon: iconfont icon-state
# This control sidebar order
order: 12
order: 71
# A page can have multiple categories
category:
- Guide
Expand Down Expand Up @@ -74,9 +74,9 @@ Since we don't have an official document, there might be some compatible problem

We can't break those limits from Baidu and you should follow the official laws.

<br/>


<!-- @include: baidu.md{74-125} -->
<!-- @include: baidu.md{87-148} -->



Expand Down
2 changes: 1 addition & 1 deletion docs/guide/drivers/chaoxing.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# This is the icon of the page
icon: iconfont icon-state
# This control sidebar order
order: 18
order: 146
# A page can have multiple categories
category:
- Guide
Expand Down
Loading