Skip to content

Commit c78f72b

Browse files
authored
fix typo & add unix permission (#241)
1 parent 619f32e commit c78f72b

File tree

2 files changed

+26
-22
lines changed

2 files changed

+26
-22
lines changed

docs/config/configuration.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,11 @@ star: true
2323
::: tip
2424
After modifying the configuration file in `config.json`, you need to restart AList to take effect
2525

26-
- Windows/Mac`data/config.json` in the same level folder as AList
27-
- LinuxOne-click Script /opt/alist/data/config.json, manually install /xx-path/`data/config.json`
28-
- DockerEnter the docker container, `data/config.json`
29-
- openwrtIf 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-
- OtherFind the `data/config.json` in AList executing files
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
3131

3232
:::
3333

@@ -56,7 +56,8 @@ After modifying the configuration file in `config.json`, you need to restart ALi
5656
"force_https": false,
5757
"cert_file": "",
5858
"key_file": "",
59-
"unix_file": ""
59+
"unix_file": "",
60+
"unix_file_perm": ""
6061
},
6162
"temp_dir": "data\\temp",
6263
"bleve_dir": "data\\bleve",
@@ -151,7 +152,7 @@ The database configuration, the default is `sqlite3`, you can also use `mysql` o
151152

152153
:::: details Expand to view `ssl_mode` parameter options
153154

154-
If you dont know how to fill in, fill in the default blank, no need to modify, if you cant use it if you dont fill it in, do your own research, and you cant provide much effective help
155+
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
155156

156157
---
157158

@@ -200,7 +201,8 @@ The scheme configuration, if you want to use https, you can set this field.
200201
"force_https": false, // Whether the HTTPS protocol is forcibly, if it is set to True, the user can only access the website through HTTPS
201202
"cert_file": "data\\cert.crt", // Path of cert file
202203
"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
204+
"unix_file": "", // Unix socket file path to listen on, default empty, if you want to use unix socket, set it to non empty
205+
"unix_file_perm": "" // Unix socket file permission, set to the appropriate permissions
204206
},
205207
```
206208

docs/zh/config/configuration.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ star: true
2626
- Windows/Mac:和 AList 同级文件夹內的 `data/config.json`
2727
- Linux:一键脚本路径,、/opt/alist/`data/config.json`,手动安装 /xx 路径/`data/config.json`
2828
- Docker:进入 Docker 容器内`data/config.json`
29-
- openwrt:如果使用的是`luci-app-alist`,请在网页修改,其他自行找到 AList 执行文件同级目录`data/config.json`
30-
- 其他:找到 AList 同级文件夹內的`data/config.json`
29+
- openwrt:如果使用的是 `luci-app-alist`,请在网页修改,其他自行找到 AList 执行文件同级目录`data/config.json`
30+
- 其他:找到 AList 同级文件夹內的 `data/config.json`
3131

3232
:::
3333

@@ -56,7 +56,8 @@ star: true
5656
"force_https": false,
5757
"cert_file": "",
5858
"key_file": "",
59-
"unix_file": ""
59+
"unix_file": "",
60+
"unix_file_perm": ""
6061
},
6162
"temp_dir": "data\\temp",
6263
"bleve_dir": "data\\bleve",
@@ -82,7 +83,7 @@ star: true
8283

8384
### **site_url**
8485

85-
你的网站 URL,比如`https://pan.nn.ci`,这个地址会在程序中的某些地方使用,如果不设置这个字段,一些功能可能无法正常工作,比如
86+
你的网站 URL,比如 `https://pan.nn.ci`,这个地址会在程序中的某些地方使用,如果不设置这个字段,一些功能可能无法正常工作,比如
8687

8788
- 本地存储的缩略图
8889
- 开启 web 代理后的预览
@@ -133,7 +134,7 @@ CDN 地址,如果要使用 CDN,可以设置该字段,`$version` 会被替
133134

134135
数据库配置,默认是 `sqlite3`,也可以使用 `mysql` 或者 `postgres`
135136

136-
- 如果不使用`MySQL`或者`postgres`,配置文件数据库选项不用修改
137+
- 如果不使用 `MySQL` 或者 `postgres`,配置文件数据库选项不用修改
137138

138139
```json
139140
"database": {
@@ -149,13 +150,13 @@ CDN 地址,如果要使用 CDN,可以设置该字段,`$version` 会被替
149150
},
150151
```
151152

152-
:::: details 展开查看`ssl_mode`参数选项
153+
:::: details 展开查看 `ssl_mode` 参数选项
153154

154155
如果不知道如何填,默认空白即可,不用修改,不填不能用的话自行研究,无法提供太多有效的帮助
155156

156157
---
157158

158-
在 MySQL 中,`ssl_mode`参数是用于指定 SSL 连接的验证模式。以下是几种常见的选项:
159+
在 MySQL 中,`ssl_mode` 参数是用于指定 SSL 连接的验证模式。以下是几种常见的选项:
159160

160161
- `DISABLED`: 禁用 SSL 连接。
161162
- `PREFERRED`: 如果服务器启用了 SSL,则使用 SSL 连接;否则使用普通连接。
@@ -167,7 +168,7 @@ MySQL 5.x 和 8.x 也不一样。如果使用服务商提供的免费/收费数
167168

168169
---
169170

170-
在 PostgreSQL 中,`ssl_mode`参数用于指定客户端如何使用 SSL 连接。以下是几种常见的选项:
171+
在 PostgreSQL 中,`ssl_mode` 参数用于指定客户端如何使用 SSL 连接。以下是几种常见的选项:
171172

172173
- `disable`: 禁用 SSL 连接。
173174
- `allow`: 允许使用 SSL 连接,但不需要。
@@ -194,13 +195,14 @@ MySQL 5.x 和 8.x 也不一样。如果使用服务商提供的免费/收费数
194195

195196
```json
196197
"scheme": {
197-
"address": "0.0.0.0", // 要监听的http/https地址,默认为 0.0.0.0
198-
"http_port": 5244, // 监听的http端口,默认的5244”,如果你想禁用http,将其设置为'-1'
199-
"https_port": -1, // https端口监听,默认的'-1',如果你想启用https,将其设置为非'-1'
200-
"force_https": false, // 是否强制使用HTTPS协议,如果设置为true,则用户只能通过HTTPS访问该网站
198+
"address": "0.0.0.0", // 要监听的 http/https 地址,默认为 0.0.0.0
199+
"http_port": 5244, // 监听的 http 端口,默认的 '5244',如果你想禁用 http,将其设置为 '-1'
200+
"https_port": -1, // https 端口监听,默认的 '-1',如果你想启用 https,将其设置为非 '-1'
201+
"force_https": false, // 是否强制使用 HTTPS 协议,如果设置为 true ,则用户只能通过 HTTPS 访问该网站
201202
"cert_file": "data\\cert.crt", // 证书文件路径
202203
"key_file": "data\\key.key", // 证书密钥文件路径
203-
"unix_file": "" // Unix监听套接字文件路径,默认的空的,如果你想使用Unix socket,将其设置为非空
204+
"unix_file": "", // Unix 监听套接字文件路径,默认的空的,如果你想使用 Unix socket,将其设置为非空
205+
"unix_file_perm": "" // Unix 监听套接字文件,设置为合适的权限
204206
},
205207
```
206208

@@ -224,7 +226,7 @@ temp_dir 为 alist 独占的临时文件夹,为避免程序中断产生垃圾
224226
"log": {
225227
"enable": true, //开启日志记录功能,默认为开启状态 true
226228
"name": "data\\log\\log.log", //日志文件的路径和名称
227-
"max_size": 10, //单个日志文件的最大大小,单位为MB。达到指定大小后会自动切分文件
229+
"max_size": 10, //单个日志文件的最大大小,单位为 MB。达到指定大小后会自动切分文件
228230
"max_backups": 5, //保留的日志备份数量,超过数量会自动删除旧的备份
229231
"max_age": 28, //日志文件保存的最大天数,超过天数的日志文件会被删除
230232
"compress": false //是否启用日志文件压缩功能。压缩后可以减小文件大小,但查看时需要解压缩,默认为关闭状态 false

0 commit comments

Comments
 (0)