Skip to content

Commit

Permalink
docs: update Docs (#370)
Browse files Browse the repository at this point in the history
* update Docs

* update 115 and terabox
  • Loading branch information
anwen-anyi authored Aug 18, 2024
1 parent dc18658 commit 4ab934d
Show file tree
Hide file tree
Showing 49 changed files with 1,470 additions and 116 deletions.
7 changes: 6 additions & 1 deletion docs/.vuepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,12 @@ export default defineUserConfig({
description: "AList v3的文档",
},
},

markdown: {
headers: {
level: [2, 3, 4, 5, 6]
}
},

theme,
plugins: [
docsearchPlugin({
Expand Down
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/mianbaoduo.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.
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.
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.
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/drivers/tv_qrcode.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.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
32 changes: 23 additions & 9 deletions docs/config/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,19 +82,23 @@ After modifying the configuration file, restart AList for changes to take effect
"tasks": {
"download": {
"workers": 5,
"max_retry": 1
"max_retry": 1,
"task_persistant": true
},
"transfer": {
"workers": 5,
"max_retry": 2
"max_retry": 2,
"task_persistant": true
},
"upload": {
"workers": 5,
"max_retry": 0
"max_retry": 0,
"task_persistant": false
},
"copy": {
"workers": 5,
"max_retry": 2
"max_retry": 2,
"task_persistant": true
}
},
"cors": {
Expand Down Expand Up @@ -395,21 +399,25 @@ Configuration for background task threads.
"tasks": {
"download": {
"workers": 5,
"max_retry": 1
"max_retry": 1,
"task_persistant": true
},
"transfer": {
"workers": 5,
"max_retry": 2
"max_retry": 2,
"task_persistant": true
},
"upload": {
"workers": 5,
"max_retry": 0
"max_retry": 0,
"task_persistant": false
},
"copy": {
"workers": 5,
"max_retry": 2
"max_retry": 2,
"task_persistant": true
}
}
},
```

- **workers**: Number of task threads.
Expand All @@ -420,6 +428,12 @@ Configuration for background task threads.
- **transfer**: upload transfer task after offline download is completed
- **upload**: upload task
- **copy**: copy the task
- **task_persistant**:The task is persistent and will not be cancelled after restarting `AList`
- download:true
- transfer:true
- upload:false
- copy:true


<br/>

Expand Down
2 changes: 1 addition & 1 deletion docs/faq/howto.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ location /alist/ {
proxy_set_header Range $http_range;
proxy_set_header If-Range $http_if_range;
proxy_redirect off;
proxy_pass http://127.0.0.1:5244/alist/;
proxy_pass http://127.0.0.1:5244/alist;
# the max size of file to upload
client_max_body_size 20000m;
}
Expand Down
5 changes: 3 additions & 2 deletions docs/guide/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ A file list program that supports multiple storage, and supports web browsing an
- [x] [MoPan](https://mopan.sc.189.cn/mopan/#/downloadPc)
- [x] [YandexDisk](https://disk.yandex.com/)
- [x] [BaiduNetdisk](https://pan.baidu.com/) / [share](./drivers/baidu_share.md)
- [x] [Quark](https://pan.quark.cn/)
- [x] [Quark/TV](https://pan.quark.cn/)
- [x] [Thunder / X Browser](../guide/drivers/thunder.md)
- [x] [Lanzou](https://www.lanzou.com/)[NewLanzou](https://www.ilanzou.com)
- [x] [Feiji Cloud](https://feijipan.com/)
Expand All @@ -65,14 +65,15 @@ A file list program that supports multiple storage, and supports web browsing an
- [x] [Trainbit](https://trainbit.com/)
- [x] [UrlTree](../guide/drivers/UrlTree.md)
- [x] IPFS
- [x] [UC Clouddrive](https://drive.uc.cn/)
- [x] [UC Clouddrive/TV](https://drive.uc.cn/)
- [x] [Dropbox](https://www.dropbox.com)
- [x] [Tencent weiyun](https://www.weiyun.com/)
- [x] [vtencent](https://app.v.tencent.com/)
- [x] [ChaoxingGroupCloud](../guide/drivers/chaoxing.md)
- [x] [Quqi Cloud](https://quqi.com)
- [x] [163 Music Drive](../guide/drivers/163music.md)
- [x] [halalcloud](../guide/drivers/halalcloud.md)
- [x] [LenovoNasShare](https://pc.lenovo.com.cn)

### Discussion

Expand Down
21 changes: 17 additions & 4 deletions docs/guide/advanced/offline-download.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,27 +120,40 @@ Subsequent supplement

## **4.PikPak**

v3.36.0 and above versions support calling Pikpak offline download function in AList
<Badge text="v3.36.0" type="info" vertical="middle" /> and above versions support calling `Pikpak` offline download function in AList

Select <span style="color: rgb(24, 144, 255);"><svg fill="none" stroke-width="0" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" class="toolbar-toggle hope-icon hope-c-XNyZK hope-c-PJLV hope-c-PJLV-ifkxHPo-css" height="1em" width="1em" style="overflow: visible;"><path fill="currentColor" d="M7 14a2 2 0 100-4 2 2 0 000 4zM14 12a2 2 0 11-4 0 2 2 0 014 0zM17 14a2 2 0 100-4 2 2 0 000 4z"></path><path fill="currentColor" fill-rule="evenodd" d="M24 12c0 6.627-5.373 12-12 12S0 18.627 0 12 5.373 0 12 0s12 5.373 12 12zm-2 0c0 5.523-4.477 10-10 10S2 17.523 2 12 6.477 2 12 2s10 4.477 10 10z" clip-rule="evenodd"></path></svg></span><span style="color: rgb(24, 144, 255);"><svg fill="currentColor" stroke-width="0" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" class="hope-icon hope-c-XNyZK hope-c-PJLV hope-c-PJLV-iipViGO-css" tips="offline_download" height="1em" width="1em" style="overflow: visible;"><path fill="none" stroke="currentColor" stroke-miterlimit="10" stroke-width="32" d="M421.83 293.82A144 144 0 00218.18 90.17M353.94 225.94a48 48 0 00-67.88-67.88"></path><path stroke-linecap="round" stroke-miterlimit="10" stroke-width="32" d="M192 464v-48M90.18 421.82l33.94-33.94M48 320h48"></path><path fill="none" stroke="currentColor" stroke-linejoin="round" stroke-width="32" d="M286.06 158.06L172.92 271.19a32 32 0 01-45.25 0L105 248.57a32 32 0 010-45.26L218.18 90.17M421.83 293.82L308.69 407a32 32 0 01-45.26 0l-22.62-22.63a32 32 0 010-45.26l113.13-113.17M139.6 169.98l67.88 67.89M275.36 305.75l67.89 67.88"></path> </svg></span> in the lower right corner and select `Pikpak` for offline download options

- Support: `magne`, `http`, `ed2k` links

- Also supports: X, TikTok, Facebook, TG URL links

Only Pikpak is supported for offline download. If it is not Pikpak, the following error message will be displayed:
Only Pikpak is supported for offline download. If it is not Pikpak, the following error message will be displayed, Although the offline download prompt was successfully added, an error will be prompted in the background.

- unsupported storage driver for offline download, only Pikpak is supported

![](/img/drivers/offline_download_error.png)

<br/>


## **5.115 Cloud**

v3.36.0 above versions support calling 115 Cloud offline download function in AList
<Badge text="v3.37.0" type="info" vertical="middle" /> and above versions support calling `115 Cloud` offline download function in AList


Select <span style="color: rgb(24, 144, 255);"><svg fill="none" stroke-width="0" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" class="toolbar-toggle hope-icon hope-c-XNyZK hope-c-PJLV hope-c-PJLV-ifkxHPo-css" height="1em" width="1em" style="overflow: visible;"><path fill="currentColor" d="M7 14a2 2 0 100-4 2 2 0 000 4zM14 12a2 2 0 11-4 0 2 2 0 014 0zM17 14a2 2 0 100-4 2 2 0 000 4z"></path><path fill="currentColor" fill-rule="evenodd" d="M24 12c0 6.627-5.373 12-12 12S0 18.627 0 12 5.373 0 12 0s12 5.373 12 12zm-2 0c0 5.523-4.477 10-10 10S2 17.523 2 12 6.477 2 12 2s10 4.477 10 10z" clip-rule="evenodd"></path></svg></span><span style="color: rgb(24, 144, 255);"><svg fill="currentColor" stroke-width="0" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" class="hope-icon hope-c-XNyZK hope-c-PJLV hope-c-PJLV-iipViGO-css" tips="offline_download" height="1em" width="1em" style="overflow: visible;"><path fill="none" stroke="currentColor" stroke-miterlimit="10" stroke-width="32" d="M421.83 293.82A144 144 0 00218.18 90.17M353.94 225.94a48 48 0 00-67.88-67.88"></path><path stroke-linecap="round" stroke-miterlimit="10" stroke-width="32" d="M192 464v-48M90.18 421.82l33.94-33.94M48 320h48"></path><path fill="none" stroke="currentColor" stroke-linejoin="round" stroke-width="32" d="M286.06 158.06L172.92 271.19a32 32 0 01-45.25 0L105 248.57a32 32 0 010-45.26L218.18 90.17M421.83 293.82L308.69 407a32 32 0 01-45.26 0l-22.62-22.63a32 32 0 010-45.26l113.13-113.17M139.6 169.98l67.88 67.89M275.36 305.75l67.89 67.88"></path> </svg></span> in the lower right corner and select `115 Cloud` for offline download options

- Support: `magne`, `http`, `ed2k` links

Only 115 Cloud is supported for offline download. If it is not 115 Cloud, the following error message will be displayed:
Only 115 Cloud is supported for offline download. If it is not 115 Cloud, the following error message will be displayed, Although the offline download prompt was successfully added, an error will be prompted in the background.

- unsupported storage driver for offline download, only 115 Cloud is supported

![](/img/drivers/offline_download_error.png)

- Some tips for using 115 offline downloads:
1. Out of sync problems may occur (manual refresh in the lower right corner <span style="color: rgb(24, 144, 255);"><svg fill="currentColor" stroke-width="0" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" class="hope-icon hope-c-XNyZK hope-c-PJLV hope-c-PJLV-ifkxHPo-css" tips="refresh" height="1em" width="1em" style="overflow: visible;"><path fill="none" d="M0 0h24v24H0z"></path><path d="M5.463 4.433A9.961 9.961 0 0112 2c5.523 0 10 4.477 10 10 0 2.136-.67 4.116-1.81 5.74L17 12h3A8 8 0 006.46 6.228l-.997-1.795zm13.074 15.134A9.961 9.961 0 0112 22C6.477 22 2 17.523 2 12c0-2.136.67-4.116 1.81-5.74L7 12H4a8 8 0 0013.54 5.772l.997 1.795z"></path></svg></span>)
2. Currently, when the download is successful, completed tasks in the offline list are deleted.
3. 115 Task URLs that are already in the offline list cannot be added again.

Loading

0 comments on commit 4ab934d

Please sign in to comment.