Skip to content

Commit c13e764

Browse files
authored
Docs:update Docs (#238)
1 parent 63628b2 commit c13e764

40 files changed

+170
-99
lines changed
2.3 KB
Loading

docs/.vuepress/theme.ts

Lines changed: 33 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,7 @@ export default hopeTheme(
121121
sup: true,
122122
align: true,
123123
include: true,
124+
card: true,
124125
},
125126
components: {
126127
components: ["ArtPlayer", "BiliBili", "Badge"],
@@ -130,46 +131,46 @@ export default hopeTheme(
130131
{
131132
path: "/",
132133
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.<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>',
134+
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.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.123 Cloud disk anti-leeching problem <a href="/guide/drivers/123.html#usage-issues">Click to view</a></span>',
134135
actions: [
135-
{
136-
text: "Aliyun open",
137-
link: "/guide/drivers/aliyundrive_open",
138-
type: "primary",
139-
},
140-
{
141-
text: "GitHub",
142-
link: "https://github.com/alist-org/alist/discussions/4572",
143-
type: "primary",
144-
},
145-
{
146-
text: "Config",
147-
link: "/config/configuration",
148-
type: "primary",
149-
},
136+
// {
137+
// text: "Aliyun open",
138+
// link: "/guide/drivers/aliyundrive_open",
139+
// type: "primary",
140+
// },
141+
// {
142+
// text: "GitHub",
143+
// link: "https://github.com/alist-org/alist/discussions/4572",
144+
// type: "primary",
145+
// },
146+
// {
147+
// text: "Config",
148+
// link: "/config/configuration",
149+
// type: "primary",
150+
// },
150151
],
151152
showOnce: true,
152153
},
153154
{
154155
path: "/zh",
155156
title: '温馨提示',
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>',
157+
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.v3.20.1的版本破坏性更新<a href="https://github.com/alist-org/alist/discussions/4702">查看详细说明</a>,前往<a href="/zh/config/configuration.html#scheme">配置文档页面</a></br>5.123云盘防盗链问题<a href="/zh/guide/drivers/123.html#使用问题">点击查看</a></span>',
157158
actions: [
158-
{
159-
text: "阿里云open",
160-
link: "/zh/guide/drivers/aliyundrive_open",
161-
type: "primary",
162-
},
163-
{
164-
text: "GitHub",
165-
link: "https://github.com/alist-org/alist/discussions/4572",
166-
type: "primary",
167-
},
168-
{
169-
text: "配置",
170-
link: "/zh/config/configuration",
171-
type: "primary",
172-
},
159+
// {
160+
// text: "阿里云open",
161+
// link: "/zh/guide/drivers/aliyundrive_open",
162+
// type: "primary",
163+
// },
164+
// {
165+
// text: "GitHub",
166+
// link: "https://github.com/alist-org/alist/discussions/4572",
167+
// type: "primary",
168+
// },
169+
// {
170+
// text: "配置",
171+
// link: "/zh/config/configuration",
172+
// type: "primary",
173+
// },
173174
],
174175
showOnce: true,
175176
},

docs/config/configuration.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -40,14 +40,14 @@ After modifying the configuration file in `config.json`, you need to restart ALi
4040
"token_expires_in": 48,
4141
"database": {
4242
"type": "sqlite3",
43-
"host": "localhost",
44-
"port": 5432,
45-
"user": "postgres",
46-
"password": "securepasswd",
47-
"name": "alist",
48-
"db_file": "data/data1.db",
43+
"host": "",
44+
"port": 0,
45+
"user": "",
46+
"password": "",
47+
"name": "",
48+
"db_file": "data\\data.db",
4949
"table_prefix": "x_",
50-
"ssl_mode": "disable"
50+
"ssl_mode": ""
5151
},
5252
"scheme": {
5353
"address": "0.0.0.0",
@@ -58,19 +58,19 @@ After modifying the configuration file in `config.json`, you need to restart ALi
5858
"key_file": "",
5959
"unix_file": ""
6060
},
61-
"temp_dir": "data/temp",
61+
"temp_dir": "data\\temp",
6262
"bleve_dir": "data\\bleve",
6363
"log": {
64-
"enable": false,
65-
"name": "log/log.log",
64+
"enable": true,
65+
"name": "data\\log\\log.log",
6666
"max_size": 10,
6767
"max_backups": 5,
6868
"max_age": 28,
6969
"compress": false
7070
},
7171
"delayed_start": 0,
7272
"max_connections": 0,
73-
"tls_insecure_skip_verify": false
73+
"tls_insecure_skip_verify": true
7474
}
7575
```
7676

@@ -194,13 +194,13 @@ The scheme configuration, if you want to use https, you can set this field.
194194

195195
```json
196196
"scheme": {
197-
"address": "0.0.0.0", // The http/https address to listen on, default `0.0.0.0`
198-
"http_port": 5244, // The http port to listen on, default `5244`, if you want to disable http, set it to `-1`
199-
"https_port": -1, // The https port to listen on, default `-1`, if you want to enable https, set it to non `-1`
200-
"force_https": false, // Whether the HTTPS protocol is forcibly, if it is set to True, the user can only access the website through HTTPS
201-
"cert_file": "", // Path of cert file
202-
"key_file": "", // Path of key file
203-
"unix_file": "" // Unix socket file path to listen on, default empty, if you want to use unix socket, set it to non empty
197+
"address": "0.0.0.0", // The http/https address to listen on, default `0.0.0.0`
198+
"http_port": 5244, // The http port to listen on, default `5244`, if you want to disable http, set it to `-1`
199+
"https_port": -1, // The https port to listen on, default `-1`, if you want to enable https, set it to non `-1`
200+
"force_https": false, // Whether the HTTPS protocol is forcibly, if it is set to True, the user can only access the website through HTTPS
201+
"cert_file": "data\\cert.crt", // Path of cert file
202+
"key_file": "data\\key.key", // Path of key file
203+
"unix_file": "" // Unix socket file path to listen on, default empty, if you want to use unix socket, set it to non empty
204204
},
205205
```
206206

docs/guide/advanced/user.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,13 @@ Password is invalid for guest user.
2727

2828
### **Base path**
2929
The root path that users see when he/she log in
30+
31+
-----
32+
33+
Q: How to allow a user to see multiple folder paths?
34+
35+
A: You can create a new [alias](alias.md) storage, add all the paths you need to show the user to the alias, and then point to the newly created alias storage in the user path
36+
3037
### **Permission**
3138
- Can see hides: Can see the hides files and folders
3239
- Access without password: Can access without password

docs/guide/drivers/115.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ flowchart TB
120120
subgraph ide1 [ ]
121121
c1
122122
end
123-
c1[local proxy]:::someclass==default==>a2[user equipment]
123+
c1[local proxy]:::someclass==default===>a2[user equipment]
124124
classDef someclass fill:#f96
125125
b1[Download proxy URL]-.alternative.->a2[user equipment]
126126
click b1 "../drivers/common.html#webdav-policy"

docs/guide/drivers/123.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,14 @@ Enter the folder you want to mount, the last string of the official website URL,
3535
- It seems that the 123 API has a limited number of loads each time, so if you load hundreds of files in a folder at one time, an error may be reported
3636
- It is recommended to A useful approach is not to put too many sub-items in the same folder.
3737

38+
### Usage issues
3839

40+
- **When downloading files from the 123 network disk, skip the anti-theft link prompt**
41+
42+
This is the limitation of the 123 cloud disk side. If you use the browser to directly request the file, alist cannot do any processing. You should
43+
44+
- Request to 123 cloud disk to cancel the referer check;
45+
- Or open the `web proxy` and webdav `local proxy` in the storage and let alist help you request files, it will automatically add the referer of 123 cloud disk to prevent anti-leeching, but the **cost** is that the traffic will be transferred by the server, Of course if you are using it locally then you can ignore this.
3946

4047
### **The default download method used**
4148

docs/guide/drivers/SMB.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ flowchart TB
4444
subgraph ide1 [ ]
4545
c1
4646
end
47-
c1[local proxy]:::someclass==default==>a2[user equipment]
47+
c1[local proxy]:::someclass==default===>a2[user equipment]
4848
classDef someclass fill:#f96
4949
b1[Download proxy URL]-.alternative.->a2[user equipment]
5050
click b1 "../drivers/common.html#webdav-policy"

docs/guide/drivers/aliyundrive_open.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,11 @@ const getLimit = async ()=>{
3737
}
3838
typeof fetch !== "undefined" && getLimit()
3939
</script>
40+
::: info Aliyundrive VIP
41+
42+
**Aliyundrive VIP**[https://www.aliyundrive.com/cpx/member](https://www.aliyundrive.com/cpx/member?userCode=MzAwMDM1)
43+
44+
:::
4045

4146
:::danger Read the precautions carefully
4247

docs/guide/drivers/common.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ You can also use another machine for proxying, download the program at https://g
9999

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

102-
If you do n’t understand [**Disassembled for details**](https://anwen-anyi.github.io/index/11-durl.html)
102+
If you don’t understand, there are detailed [**video tutorial**](https://www.bilibili.com/video/BV17N411S7fg/)
103103

104104
::::
105105

docs/guide/drivers/ftp.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ flowchart TB
4545
subgraph ide1 [ ]
4646
c1
4747
end
48-
c1[local proxy]:::someclass==default==>a2[user equipment]
48+
c1[local proxy]:::someclass==default===>a2[user equipment]
4949
classDef someclass fill:#f96
5050
b1[Download proxy URL]-.alternative.->a2[user equipment]
5151
click b1 "../drivers/common.html#webdav-policy"

0 commit comments

Comments
 (0)