Skip to content

Commit 2a9c1f2

Browse files
authored
Docs:add Dropbox Docs and update other Docs (#234)
1 parent c831306 commit 2a9c1f2

32 files changed

+600
-63
lines changed
Loading
Loading
Loading
Loading
Loading

docs/.vuepress/theme.ts

+13-3
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ export default hopeTheme(
130130
{
131131
path: "/",
132132
title: 'Kind tips',
133-
content: '<span style="color:rgb(255, 0, 0);font-weight:bold;">Please check the reminder content carefully</span></br></br>1.The original API https://api.nn.ci is blocked by SNI </br>2.Alibaba Cloud Plate and applications using this API are all affected. For specific solutions, please check the two options below.</span>',
133+
content: '<span style="color:rgb(255, 0, 0);font-weight:bold;">Please check the reminder content carefully</span></br></br>1.The original API https://api.nn.ci is blocked by SNI </br>2.Alibaba Cloud Plate and applications using this API are all affected. For specific solutions, please check the two options below.<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.New HTTPS port can be monitored separately.For details <a href="/config/configuration.html">check the configuration document page</a></span>',
134134
actions: [
135135
{
136136
text: "Aliyun open",
@@ -142,24 +142,34 @@ export default hopeTheme(
142142
link: "https://github.com/alist-org/alist/discussions/4572",
143143
type: "primary",
144144
},
145+
{
146+
text: "Config",
147+
link: "/config/configuration",
148+
type: "primary",
149+
},
145150
],
146151
showOnce: true,
147152
},
148153
{
149154
path: "/zh",
150155
title: '温馨提示',
151-
content: '<span style="color:rgb(255, 0, 0);font-weight:bold;">请仔细查看弹窗提示内容</span></br></br>1.原API https://api.nn.ci被sni阻断</br>2.阿里云盘以及其他使用此API的都受影响,具体解决办法请查看下方两个选项二选一查看</span>',
156+
content: '<span style="color:rgb(255, 0, 0);font-weight:bold;">请仔细查看弹窗提示内容</span></br></br>1.原API https://api.nn.ci被sni阻断</br>2.阿里云盘以及其他使用此API的都受影响,具体解决办法请查看下方两个选项二选一查看</br>3.<a href="/zh/guide/drivers/139.html">移动云盘</a>和<a href="/zh/guide/drivers/189.html">天翼云</a>分别有改动详情请自行查看文档</br>4.新增HTTPS端口,可单独监听详情查看<a href="/zh/config/configuration.html">配置文档页面</a></span>',
152157
actions: [
153158
{
154159
text: "阿里云open",
155-
link: "/guide/drivers/aliyundrive_open",
160+
link: "/zh/guide/drivers/aliyundrive_open",
156161
type: "primary",
157162
},
158163
{
159164
text: "GitHub",
160165
link: "https://github.com/alist-org/alist/discussions/4572",
161166
type: "primary",
162167
},
168+
{
169+
text: "配置",
170+
link: "/zh/config/configuration",
171+
type: "primary",
172+
},
163173
],
164174
showOnce: true,
165175
},

docs/config/configuration.md

+48-15
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,13 @@ star: true
2222

2323
::: tip
2424
After modifying the configuration file in `config.json`, you need to restart AList to take effect
25+
26+
- Windows/Mac:`data/config.json` in the same level folder as AList
27+
- Linux:One-click Script /opt/alist/data/config.json, manually install /xx-path/`data/config.json`
28+
- Docker:Enter the docker container, `data/config.json`
29+
- openwrt:If you use `Luci-APP-Alist`, please modify on the webpage,other Please find the AList execution file, the same level directory `data/config.json`
30+
- Other:Find the `data/config.json` in AList executing files
31+
2532
:::
2633

2734
```json
@@ -82,10 +89,13 @@ The address to listen on, default `0.0.0.0`
8289

8390
The port to listen on, default `5244`
8491

85-
**https_port**
92+
93+
### **https_port**
8694

8795
HTTPS port,default 5245
8896

97+
- You need to open the https in [`Scheme`](#scheme) to enable it.If you use Nginx reverse proxy and open HTTPS, this is not related to this
98+
8999
### **site_url**
90100

91101
The url of your `alist` site, such as `https://pan.nn.ci`.This address will be used in some places in the program, If you do not set this field, Some features may not work properly, such as:
@@ -140,15 +150,15 @@ The database configuration, the default is `sqlite3`, you can also use `mysql` o
140150

141151
```json
142152
"database": {
143-
"type": "sqlite3", //database type
144-
"host": "", //database host
145-
"port": 0, //database port
146-
"user": "", //database account
147-
"password": "", //database password
148-
"name": "", //database name
149-
"db_file": "data\\data.db", //Database location, used by sqlite3
150-
"table_prefix": "x_", //database table name prefix
151-
"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
153+
"type": "sqlite3", //database type
154+
"host": "", //database host
155+
"port": 0, //database port
156+
"user": "", //database account
157+
"password": "", //database password
158+
"name": "", //database name
159+
"db_file": "data\\data.db", //Database location, used by sqlite3
160+
"table_prefix": "x_", //database table name prefix
161+
"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
152162
},
153163
```
154164

@@ -197,11 +207,11 @@ The scheme configuration, if you want to use https, you can set this field.
197207

198208
```json
199209
"scheme": {
200-
"disable_http": false, //Whether the HTTP protocol is forbidden
201-
"https": true, //Enable https, the default is false
202-
"force_https": false, //Whether the HTTPS protocol is forcibly, if it is set to True, the user can only access the website through HTTPS
203-
"cert_file": "data\\public.crt", //Path selection file
204-
"key_file": "data\\key.key" //Path selection file
210+
"disable_http": false, //Whether the HTTP protocol is forbidden
211+
"https": true, //Enable https, the default is false
212+
"force_https": false, //Whether the HTTPS protocol is forcibly, if it is set to True, the user can only access the website through HTTPS
213+
"cert_file": "data\\public.crt", //Path selection file
214+
"key_file": "data\\key.key" //Path selection file
205215
},
206216
```
207217

@@ -213,10 +223,33 @@ The temporary directory, default `data/temp`
213223
temp_dir is a temporary folder exclusive to alist. In order to avoid program interruption and generate garbage files, it will be cleared every time it starts, so please do not manually put any content in this folder, and do not use this folder and its subfolders when using docker Folders are mapped to folders in use.
214224
:::
215225

226+
### **bleve_dir**
227+
228+
When you use **`bleve`** indexes, the location of the data storage
229+
216230
### **log**
217231

218232
The log configuration, if you want to setup the log level, you can set this field.
219233

234+
```json
235+
"log": {
236+
"enable": true, //Whether to turn on the log record function, the default is to open the status true
237+
"name": "data\\log\\log.log", //The path and name of the log file
238+
"max_size": 10, //the maximum size of a single log file, in MB. After reaching the specified size, the file will be automatically split.
239+
"max_backups": 5, //the number of log backups to keep. Old backups will be deleted automatically when the limit is exceeded.
240+
"max_age": 28, //The maximum number of days preserved in the log file, the log file that exceeds the number of days will be deleted
241+
"compress": false //Whether to enable log file compression functions. After compression, the file size can be reduced, but you need to decompress when viewing, and the default is to close the state false
242+
},
243+
```
244+
245+
### **delayed_start**
246+
247+
**Unit: s** (V3.19.0 new function)
248+
249+
Whether to delay start, generally this function is often used in Alist to start the self -startup option
250+
251+
Because sometimes the network connection is slow, the driver that needs to be connected after the Alist is launched is too fast, so that it cannot be opened normally.
252+
220253
### **max_connections**
221254

222255
The maximum number of connections (concurrent) at the same time, the default is 0, that is, unlimited.

docs/faq/howto.md

+1
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,7 @@ It may be that the risk detection system has been triggered. Please changing the
8282
- Click Edit, write the verification code you just saw into the configuration and click Save
8383
- Click Edit and turn on the Do not use OCR button
8484
- Or build it yourself [**Ocr interface**](../config/global.md#ocr-api)
85+
- **189 Cloud** Driver has been replaced with sliding verification code because web login has been replaced.**No longer supports OCR and manual input**, if the verification code needs to be used, please use the addition of `Cookie to log in` or use the `189 Cloud PC` Driver, ^Note_that_it_is_189_Cloud_driver_is_not_189_Cloud_PC^
8586

8687
### **TLS handshake timeout? / read: connection reset by peer? / dns lookup failed? / connect: connection refused / Client.Timeout exceeded while awaiting headers? / no such host?**
8788

docs/guide/README.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,8 @@ A file list program that supports multiple storage, and supports web browsing an
4141
- [x] Teambition([China](https://www.teambition.com/)[International](https://us.teambition.com/)
4242
- [x] [mediatrack](https://www.mediatrack.cn/)
4343
- [x] [139yun](https://yun.139.com/) (Personal, Family)
44+
- [x] [Wopan](https://pan.wo.cn)
45+
- [x] [MoPan](https://mopan.sc.189.cn/mopan/#/downloadPc)
4446
- [x] [YandexDisk](https://disk.yandex.com/)
4547
- [x] [BaiduNetdisk](https://pan.baidu.com/) / [share](./drivers/baidu_share.md)
4648
- [x] [Quark](https://pan.quark.cn/)
@@ -51,7 +53,7 @@ A file list program that supports multiple storage, and supports web browsing an
5153
- [x] [Mega.nz](https://mega.nz)
5254
- [x] [Baidu photo](https://photo.baidu.com/)
5355
- [x] [TeraBox](https://www.terabox.com/)
54-
- [x] Alist v2/v3
56+
- [x] [AList v2/v3](../guide/drivers/Alist%20V2%20V3.md)
5557
- [x] SMB
5658
- [x] [alias](../guide/advanced/alias.md)
5759
- [x] [115](https://115.com/)
@@ -61,6 +63,7 @@ A file list program that supports multiple storage, and supports web browsing an
6163
- [x] [UrlTree](../guide/drivers/urltree.md)
6264
- [x] IPFS
6365
- [x] [UC](https://drive.uc.cn/)
66+
- [x] [Dropbox](https://www.dropbox.com)
6467

6568
### Discussion
6669

docs/guide/advanced/backup.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Use `AList` to manage `Backup/Restore` options
2626
>
2727
> Recovery: Backup files before recovery
2828
>
29-
> Cover: Select coverage when recovery, and will cover the user information
29+
> Override: Select override when recovery, and will override the user information
3030
3131
![](/img/advanced/backup.png)
3232

docs/guide/drivers/123.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
# This is the icon of the page
33
icon: state
44
# This control sidebar order
5-
order: 8
5+
order: 9
66
# A page can have multiple categories
77
category:
88
- Guide

docs/guide/drivers/139.md

+8-2
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,12 @@ Cloud disk address:**https://yun.139.com/**
2525

2626
- :warning: The alist version must be greater than `v3.18.0` to use this tutorial (excluding v3.18.0)
2727

28+
:::tip
29+
30+
Update the method of authentication, please get `Authorization` to fill in
31+
32+
:::
33+
2834

2935

3036
## **root folder ID**
@@ -67,8 +73,6 @@ Pay attention to the keywords, use it below to get **`authorization`**
6773
- Personal Cloud:**getDisk**
6874
- Family Cloud:**queryContentList**
6975

70-
71-
7276
### **Personal cloud:**
7377

7478
<div class="image-preview">
@@ -77,6 +81,8 @@ Pay attention to the keywords, use it below to get **`authorization`**
7781
</div>
7882

7983

84+
Note: Family cloud does not support renames, movement, copying and uploading.
85+
8086
### **Family cloud:**
8187

8288
Note: Family cloud does not support renames, movement, copying and uploading.

docs/guide/drivers/189.md

+28-2
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,27 @@ star: true
1818

1919
# 189Cloud
2020

21+
:::tip
2122

23+
The web -side login has been replaced with sliding verification code, **no longer supports OCR and manual input**. If the verification code needs to be used, please use the add `Cookie` to log in
24+
25+
:::
2226

2327
## **Personal Cloud**
2428

2529
### **username**
2630
the phone number used to log in
31+
32+
33+
2734
### **password**
35+
2836
password for login
37+
38+
39+
2940
### **Root folder ID**
41+
3042
The string at the end of the official website url, such as:
3143
- https://cloud.189.cn/web/main/file/folder/-11 -> `-11`
3244
- https://cloud.189.cn/web/main/file/folder/71398114617385472 -> `71398114617385472`
@@ -36,19 +48,33 @@ The string at the end of the official website url, such as:
3648

3749
## **Family Cloud**
3850

39-
Use a computer browser, open the developer tool (F12), switch the emulation device and select the mobile device
51+
(Alone 189 CloudPC Plate Client Drive) Use a computer browser, open the developer tool (F12), switch the emulation device and select the mobile device
4052

4153
Open https://h5.cloud.189.cn/main.html#/family, enter the folder you want to mount, you can see the request in the network, and then find the required parameters:
4254

4355
![189](/img/drivers/189/189-1.png)
4456

57+
58+
59+
### **AList fill in examples:**
60+
61+
#### **189 Cloud**
62+
63+
Fill in the account^1^and password^2^,Then click one request in the request, just bring `Cookies`, click on one at will Then fill in,Cookie expires time is unknown
64+
65+
![189](/img/drivers/189/189-0.png)
66+
67+
#### **189 CloudPC**
68+
4569
![189](/img/drivers/189/189-2.png)
4670

4771
Video reference: **https://www.bilibili.com/video/BV16A4y197De**
4872

73+
74+
4975
## **suggestion**
5076

51-
It is recommended to use the Tianyi cloud disk client first, [**Notes click to view.**](../../faq/howto.md#when-adding-Tianyi-cloud-disk-client-storage-prompt-need-img-validate-code-verification-code)
77+
It is recommended to use the Tianyi cloud disk client first, [**Notes click to view.**](../../faq/howto.md#when-adding-tianyi-cloud-disk-client-storage-prompt-need-img-validate-code-verification-code)
5278

5379

5480

docs/guide/drivers/baidu.md

+15-3
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,21 @@ Or use the proxy function in this program to transfer.
3333
The root foler to mount, defaults to `/`, same as local storage.
3434

3535
### **Download api**
36-
- official: The official interface, very stable, but for larger files, UA needs to be modified and the speed is slow
37-
- ~~crack: unofficial interface, no need to modify UA and some files may not limit the speed, but **maybe** unstable~~
38-
- ==crack: Unofficial Interface== Seems to be Harmonized? [**Click here for details to view FAQs**](../../faq/why.md#baidu-cloud-disk-unofficial-download-error-appears-hit-black-userlist-hit-illegal-dlna)
36+
- official: The official interface, very stable, but for larger files, UA needs to be modified and the speed is slow (SVIP speed fast)
37+
- crack: unofficial interface,You must modify the UA and some files may not have a speed limit, but it will be unstable (not guaranteed 100%availability) Need to use a version greater than `3.19.0`
38+
- ==Need to change the UA to`netdisk`==,Modification method refer to [add-user-agent-user-example](#add-user-agent-usage-example)
39+
- Or turn on the Web proxy, you do not need to modify the UA (you need a large broadband to use it stably)
40+
- 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
41+
- This is not a mistake, this is a limit, please do not panic.
42+
43+
```json{3}
44+
{
45+
error_code: 31119,
46+
error_msg: "hit black userlist , hit illeage dlna",
47+
request_id: 541111111111111140
48+
}
49+
# This is not a mistake, this is a limit, please do not panic.
50+
```
3951

4052

4153

docs/guide/drivers/baidu_share.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ We can't break those limits from Baidu and you should follow the official laws.
7575

7676

7777

78-
<!-- @include: baidu.md{42-93} -->
78+
<!-- @include: baidu.md{54-105} -->
7979

8080

8181

docs/guide/drivers/common.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -92,14 +92,14 @@ The workers code can be found at https://github.com/alist-org/alist-proxy/blob/m
9292

9393
- When mounting the configuration in the Alist background, fill in the **download proxy URL** at the end of the link without `/`
9494

95-
If you do n’t understand [**Disassembled for details**](https://anwen-nyi.github.io/index/11-durl.html)
95+
If you do n’t understand [**Disassembled for details**](https://anwen-anyi.github.io/index/11-durl.html)
9696

9797
@tab Universal Binary
9898
You can also use another machine for proxying, download the program at https://github.com/alist-org/alist-proxy/releases
9999

100100
`./alist-proxy -help` to see how to use it.
101101

102-
If you do n’t understand [**Disassembled for details**](https://anwen-nyi.github.io/index/11-durl.html)
102+
If you do n’t understand [**Disassembled for details**](https://anwen-anyi.github.io/index/11-durl.html)
103103

104104
::::
105105

0 commit comments

Comments
 (0)