You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/config/configuration.md
+78-14Lines changed: 78 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,7 +18,7 @@ sticky: true
18
18
star: true
19
19
---
20
20
21
-
### Initial config
21
+
### **Initial config**
22
22
23
23
```json
24
24
{
@@ -62,19 +62,19 @@ star: true
62
62
63
63
## Field Description
64
64
65
-
### force
65
+
### **force**
66
66
67
67
The program will preferentially read the configuration from the environment variable, set `force` to `true` to force the program to read the configuration file.
68
68
69
-
### address
69
+
### **address**
70
70
71
71
The address to listen on, default `0.0.0.0`
72
72
73
-
### port
73
+
### **port**
74
74
75
75
The port to listen on, default `5244`
76
76
77
-
### site_url
77
+
### **site_url**
78
78
79
79
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:
80
80
- thumbnail of `LocalStorage`
@@ -83,7 +83,18 @@ The url of your `alist` site, such as `https://pan.nn.ci`.This address will be u
83
83
- Reverse proxy to sub directory
84
84
- ...
85
85
86
-
### cdn
86
+
Do not carry `/` at the end when filling in the link, otherwise it cannot be used or other problems
87
+
88
+
- Do not carry `/` at the end of the URL link, correct example:heavy_check_mark: :`https://pan.nn.ci`, wrong example: `https://pan.nn.ci/`:x:,Otherwise the following functions will not be available
89
+
90
+
```json
91
+
# Correct way of writing:
92
+
"site_url": "https://pan.nn.ci",
93
+
#Wrong way of writing:
94
+
"site_url": "https://pan.nn.ci/",
95
+
```
96
+
97
+
### **cdn**
87
98
88
99
The CDN address, if you want to use CDN, you can set this field, the `$version` will be replaced with the real version of `alist-web`
89
100
This is dynamic and changeable. Existing dist resources are hosted on both npm and GitHub, and their locations are:
@@ -102,19 +113,72 @@ So you can use any npm or github cdn as the path, for example:
102
113
103
114
Also you can keep it empty to use local dist.
104
115
105
-
### jwt_secret
116
+
### **jwt_secret**
106
117
107
118
The secret used to sign the JWT token, random generated first time start.
108
119
109
-
### token_expires_in
120
+
### **token_expires_in**
110
121
111
122
User login expiration time, unit: `hours`.
112
123
113
-
### database
124
+
### **database**
114
125
115
126
The database configuration, the default is `sqlite3`, you can also use `mysql` or `postgres`.
116
127
117
-
### scheme
128
+
- If you do not use `MySQL` or `postgres`, the configuration file database options do not need to be modified
129
+
130
+
```json
131
+
"database": {
132
+
"type": "sqlite3", //database type
133
+
"host": "", //database host
134
+
"port": 0, //database port
135
+
"user": "", //database account
136
+
"password": "", //database password
137
+
"name": "", //database name
138
+
"db_file": "data\\data.db", //Database location, used by sqlite3
139
+
"table_prefix": "x_", //database table name prefix
140
+
"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
141
+
},
142
+
```
143
+
144
+
:::: details Expand to view `ssl_mode` parameter options
145
+
146
+
If you don’t know how to fill in, fill in the default blank, no need to modify, if you can’t use it if you don’t fill it in, do your own research, and you can’t provide much effective help
147
+
148
+
-----
149
+
150
+
In MySQL, the `ssl_mode` parameter is used to specify the authentication mode of the SSL connection. Here are a few common options:
151
+
152
+
-`DISABLED`: Disable SSL connections.
153
+
-`PREFERRED`: If the server has SSL enabled, use an SSL connection; otherwise use a normal connection.
154
+
-`REQUIRED`: Must use SSL connection, if the server does not support SSL connection, the connection will fail.
155
+
-`VERIFY_CA`: Must use SSL connection and verify the authenticity of the server certificate.
156
+
-`VERIFY_IDENTITY`: must use an SSL connection and verify the authenticity of the server certificate and that the name matches the connecting hostname.
157
+
158
+
MySQL 5.x and 8.x are also different. If you use the free/fee database provided by the service provider, the service provider will have documentation. You must know the database you deploy yourself.
159
+
160
+
-----
161
+
162
+
In PostgreSQL, the `ssl_mode` parameter is used to specify how the client uses SSL connections. Here are a few common options:
163
+
164
+
-`disable`: Disable SSL connections.
165
+
-`allow`: SSL connections are allowed, but not required.
166
+
-`prefer`: If the server has SSL enabled, use an SSL connection; otherwise use a normal connection.
167
+
-`require`: Must use SSL connection, if the server does not support SSL connection, the connection will fail.
168
+
-`verify-ca`: Must use SSL connection and verify the authenticity of the server certificate.
169
+
-`verify-full`: MUST connect using SSL and verify the authenticity and name of the server certificate matches the connected hostname.
170
+
171
+
----
172
+
173
+
::: right
174
+
175
+
:warning::warning:**The above parameters are from ChatGPT, the authenticity/practicability/accuracy has not been verified**:warning::warning:
176
+
177
+
:::
178
+
179
+
::::
180
+
181
+
### **scheme**
118
182
119
183
The scheme configuration, if you want to use https, you can set this field.
120
184
@@ -128,25 +192,25 @@ The scheme configuration, if you want to use https, you can set this field.
128
192
},
129
193
```
130
194
131
-
### temp_dir
195
+
### **temp_dir**
132
196
133
197
The temporary directory, default `data/temp`
134
198
135
199
::: danger
136
200
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.
137
201
:::
138
202
139
-
### log
203
+
### **log**
140
204
141
205
The log configuration, if you want to setup the log level, you can set this field.
142
206
143
-
### max_connections
207
+
### **max_connections**
144
208
145
209
The maximum number of connections (concurrent) at the same time, the default is 0, that is, unlimited.
146
210
147
211
- 10 or 20 is recommended for general equipment such as n1
148
212
- Use scenarios (for example, if the picture mode is turned on, the device will crash if the concurrency is not very good)
149
213
150
-
### tls_insecure_skip_verify
214
+
### **tls_insecure_skip_verify**
151
215
152
216
Whether to examine the SSL certificate, if there is a problem with the certificate of the website used after opening (such as not including the intermediate certificate, certificate expiration, certificate forgery, etc.), the service will not be available,Close this option, please try to run the program in a safe network environment
Copy file name to clipboardExpand all lines: docs/config/global.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,51 +18,51 @@ star: true
18
18
19
19
# Global settings
20
20
21
-
### Hide files
21
+
### **Hide files**
22
22
23
23
Match files hidden by regular expressions(`javascript`). If you don't understand, don't fill in them randomly. Wrong regular expressions will cause the front-end page to crash. One per line. By default, there is an example expression that hides README.md in all directories.
24
24
25
25
It's not really hiding. It still exists in the list returned by the api, it just doesn't show up in the frontend list. So if you want to really hide, add a [meta](../guide/advanced/meta.md) record instead.
26
26
27
-
### Package download
27
+
### **Package download**
28
28
29
29
Whether to enable package download, default is true.
30
30
31
-
### Customize head
31
+
### **Customize head**
32
32
33
33
Any content you want which are automatically placed at the beginning of the head of the web page
34
34
35
-
### Customize body
35
+
### **Customize body**
36
36
37
37
Any content you want which are automatically placed at the end of the body of the web page
38
38
39
-
### Link expiration
39
+
### **Link expiration**
40
40
41
41
The expiration time of the direct link, in hours. If it equals 0, it will not expire. Default is 0.
42
42
::: warning
43
43
Only the straight chain of the path with the password added will have an expiration time, otherwise it will not expire.Because the expiration time is added to the sign query parameter, and the path without adding the password will not check the sign.
44
44
:::
45
45
46
-
### Privacy regs
46
+
### **Privacy regs**
47
47
48
48
What you don't want to show in the error message, One regular expression (in `Golang`) per line. The matched content will be replaced with * of the corresponding length.
49
49
50
-
### Ocr api
50
+
### **Ocr api**
51
51
52
52
Used to identify verification codes. You can deploy yourself: https://hub.docker.com/r/xhofe/ddddocr_server. The default ocr api is deployed on the [koyeb](https://app.koyeb.com/)(No availability guarantee), which is not recommended to use in production environment.
53
53
54
54
55
-
### Sign all
55
+
### **Sign all**
56
56
57
57
Add signatures to the direct link of all files (whether with password or not) That is https://xxxx.com/d/xx? ==**sign=vUQ5KFXnwMseKnIUXGRcfoG3cEHzKFBiPGp1NriMDXA=:0**==
58
58
59
59
If you need to close it, you can close it yourself, but you need to pay attention to security issues. After closing the signature, if the site can be accessed by the public network, the password may be bypassed to access private files.
60
60
61
-
## Forward direct link params
61
+
## **Forward direct link params**
62
62
63
63
You can check it out yourself：**https://github.com/alist-org/alist/issues/3123**
64
64
65
-
### Filename char mapping
65
+
### **Filename char mapping**
66
66
67
67
Mainly to map some special characters so that Alist can work normally
Copy file name to clipboardExpand all lines: docs/config/other.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,26 +18,26 @@ star: true
18
18
19
19
# Other settings
20
20
21
-
### Aria2
21
+
### **Aria2**
22
22
23
23
Set Aria2 uri and Aria2 for offline download. Aria2 needs to be installed on the same server(container if use docker) as alist.
24
24
25
25
26
26
27
-
## Qbittorrent url
27
+
## **Qbittorrent url**
28
28
29
29
Used to customize **Qbittorrent** parameters to configure the client to use
30
30
31
31
The default value is: http://admin:adminadmin@localhost:8080/, you can modify it by referring to [specific instructions. ](../guide/advanced/offline-download.md#_2-qbittorrent)
32
32
33
33
34
34
35
-
### Token
35
+
### **Token**
36
36
37
37
The token that can be used to access all API.
38
38
39
39
40
40
41
-
### other
41
+
### **other**
42
42
43
43
When using it, I found that there are two Aria2, but what is the difference? [**Click to view the detailed description**](../faq/why.md#what-is-the-difference-between-the-two-aria2)
0 commit comments