Skip to content
This repository was archived by the owner on Sep 24, 2025. It is now read-only.

chore: Reformat zh-CN docs #12

Closed
WenHao2130 wants to merge 2 commits into from
Closed

chore: Reformat zh-CN docs #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4d69aa7
chore: Reformat zh-CN docs
WenHao2130 Jun 12, 2025
e16c262
chore: Resolve some conflicts
WenHao2130 Jun 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/zh/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,15 +40,15 @@ features:

- title: 打包下载/批量下载
icon: iconfont icon-cache
details: 使用浏览器的 stream api 支持打包下载，无需使用服务器 / 使用Aria2进行批量下载支持文件夹
details: 使用浏览器的 stream api 支持打包下载，无需使用服务器 / 使用 Aria2 进行批量下载支持文件夹

- title: 单点登录
icon: font-icon icon fa-solid fa-repeat-1
details: 使用单点登录快速登录OpenList
details: 使用单点登录快速登录 OpenList

- title: 自动注册OpenList帐号
- title: 自动注册 OpenList 帐号
icon: fa-solid fa-file-user
details: 使用单点登录自动注册为OpenList帐号快速注册
details: 使用单点登录自动注册为 OpenList 帐号快速注册

- title: 离线下载
icon: fa-solid fa-folder-arrow-down
Expand Down
34 changes: 17 additions & 17 deletions docs/zh/faq/error.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,43 +21,43 @@ star: true

## 这个是什么？

这个是收集一些`OpenList`使用期间的一些错误码，然后如何解决（网络问题或者网盘更改API以及其它一些问题可能会无法当时解决需要人为去干预）
这个是收集一些 `OpenList` 使用期间的一些错误码，然后如何解决（网络问题或者网盘更改 API 以及其它一些问题可能会无法当时解决需要人为去干预）

<br/>

-----

<Badge text="Q" type="warning" vertical="middle" />：阿里云盘open出现 **TooManyRequests** 、**Too Many Requests**
<Badge text="Q" type="warning" vertical="middle" />：阿里云盘 open 出现 **TooManyRequests** 、**Too Many Requests**

<br/>

<Badge text="A" type="info" vertical="middle" />：[**点我查看详细说明**](../guide/drivers/aliyundrive_open.md)

-----

<Badge text="Q" type="warning" vertical="middle" />：阿里云盘open出现 **ExceedCapacityForbidden**
<Badge text="Q" type="warning" vertical="middle" />：阿里云盘 open 出现 **ExceedCapacityForbidden**

<br/>

<Badge text="A" type="info" vertical="middle" />：[**点我查看详细说明**](../guide/drivers/aliyundrive_open.md#四、)

-----

<Badge text="Q" type="warning" vertical="middle" />：Token is expired（**出现在登录OpenList账号时**）
<Badge text="Q" type="warning" vertical="middle" />：Token is expired（**出现在登录 OpenList 账号时**）

<br/>

<Badge text="A" type="info" vertical="middle" />：是指你`OpenList`登录有效期到了默认是`48`小时，可以在修改`config.json`配置文件中
<Badge text="A" type="info" vertical="middle" />：是指你 `OpenList` 登录有效期到了默认是 `48` 小时，可以在修改 `config.json` 配置文件中

- 如果你登录的时候提示登录成功然后又显示这个提示，检查你是否使用了CDN加速等给OpenList进行了缓存导致的
- 如果你登录的时候提示登录成功然后又显示这个提示，检查你是否使用了 CDN 加速等给 OpenList 进行了缓存导致的

-----

<Badge text="Q" type="warning" vertical="middle" />：Failed init storage but storage is already created: failed init storage: failed to refresh token: The input parameter refresh_token is missing. Please refer to document.

<br/>

<Badge text="A" type="info" vertical="middle" />：一般是在添加`驱动`的时候刷新令牌(token)不对，更换正确的替换了即可解决。
<Badge text="A" type="info" vertical="middle" />：一般是在添加`驱动`的时候刷新令牌 (token) 不对，更换正确的替换了即可解决。

-----

Expand Down Expand Up @@ -115,7 +115,7 @@ star: true

<br/>

<Badge text="A" type="info" vertical="middle" />：对方的`OpenList`站点不允许挂载，[**查看详细说明**](../guide/drivers/Alist%20V2%20V3.md#链接)
<Badge text="A" type="info" vertical="middle" />：对方的 `OpenList` 站点不允许挂载，[**查看详细说明**](../guide/drivers/Alist%20V2%20V3.md#链接)

-----

Expand Down Expand Up @@ -149,11 +149,11 @@ star: true

-----

<Badge text="Q" type="warning" vertical="middle" />：failed get objs: failed to list objs: NotFound.FileId:The resource file_id cannot be found. file_id:634e704cefa78f92fefd4c779f7422d820082d041（**添加阿里云盘open**）
<Badge text="Q" type="warning" vertical="middle" />：failed get objs: failed to list objs: NotFound.FileId:The resource file_id cannot be found. file_id:634e704cefa78f92fefd4c779f7422d820082d041（**添加阿里云盘 open**）

<br/>

<Badge text="A" type="info" vertical="middle" />：添加阿里云盘open存储时，`根文件夹ID`错误上述最后哪个ID就是错误的ID去获取正确的替换即可
<Badge text="A" type="info" vertical="middle" />：添加阿里云盘 open 存储时，`根文件夹 ID`错误上述最后哪个 ID 就是错误的 ID 去获取正确的替换即可

-----

Expand All @@ -169,7 +169,7 @@ star: true

<br/>

<Badge text="A" type="info" vertical="middle" />：连续登录输入6次密码错误就会锁定，重启OpenList即可重置。
<Badge text="A" type="info" vertical="middle" />：连续登录输入 6 次密码错误就会锁定，重启 OpenList 即可重置。

-----

Expand All @@ -181,27 +181,27 @@ star: true

-----

<Badge text="Q" type="warning" vertical="middle" />：failed get objs: failed to list objs: Unable to retrieve user's mysite URL（**添加onedrive_app时**）
<Badge text="Q" type="warning" vertical="middle" />：failed get objs: failed to list objs: Unable to retrieve user's mysite URL（**添加 onedrive_app 时**）

<br/>

<Badge text="A" type="info" vertical="middle" />：新建的 `OneDrive`用户账号不是实时生效，会延时生效等待几小时后试试看 [**案例**](https://github.com/alist-org/docs/discussions/189#discussioncomment-5928892)
<Badge text="A" type="info" vertical="middle" />：新建的 `OneDrive` 用户账号不是实时生效，会延时生效等待几小时后试试看 [**案例**](https://github.com/alist-org/docs/discussions/189#discussioncomment-5928892)

-----

<Badge text="Q" type="warning" vertical="middle" />：failed to start: listen tcp 0.0.0.0:5244: bind: address already in use （**启动OpenList程序时**）
<Badge text="Q" type="warning" vertical="middle" />：failed to start: listen tcp 0.0.0.0:5244: bind: address already in use （**启动 OpenList 程序时**）

<br/>

<Badge text="A" type="info" vertical="middle" />：5244端口号已经被使用，排查是否被占用(一般来说你已经启动了一个5244端口的OpenList导致的)，或者修改OpenList启动的端口号,[**如何修改**](../config/configuration.md#port)
<Badge text="A" type="info" vertical="middle" />：5244 端口号已经被使用，排查是否被占用(一般来说你已经启动了一个 5244 端口的 OpenList 导致的)，或者修改 OpenList 启动的端口号,[**如何修改**](../config/configuration.md#port)

-----

<Badge text="Q" type="warning" vertical="middle" />：**[OpenList上传文件时提示](why.md#为什么我在上传文件时得到-http-413-错误)**：Request failed with status code 413
<Badge text="Q" type="warning" vertical="middle" />：**[OpenList 上传文件时提示](why.md#为什么我在上传文件时得到 -http-413- 错误)**：Request failed with status code 413

<br/>

<Badge text="A" type="info" vertical="middle" />：Nginx配置的文件大小所限制，修改Nginx的`client_max_body_size`就可以，如果你是宝塔搭建的去宝塔页面修改[示例](https://blog.csdn.net/u012514495/article/details/127981183)
<Badge text="A" type="info" vertical="middle" />：Nginx 配置的文件大小所限制，修改 Nginx 的 `client_max_body_size` 就可以，如果你是宝塔搭建的去宝塔页面修改[示例](https://blog.csdn.net/u012514495/article/details/127981183)

-----

Expand Down
34 changes: 17 additions & 17 deletions docs/zh/faq/howto.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ star: true
使用 nginx 反向代理到 https://example.com/alist 的示例：

- 正常安装
- 将 [site_url](../config/configuration.md#site_url) 设置为 `https://example.com/alist` 或者仅`/alist`, 然后重启alist
- 将 [site_url](../config/configuration.md#site_url) 设置为 `https://example.com/alist` 或者仅`/alist`, 然后重启 alist
- 在 nginx 中添加反向代理配置

```nginx
Expand All @@ -52,19 +52,19 @@ location /alist/ {
否则，您可以要求站点所有者重置密码。

:::tip
如果你使用v3.9.0及以上版本，你需要先停止alist服务因为这个pr: https://github.com/alist-org/alist/pull/3074
如果你使用 v3.9.0 及以上版本，你需要先停止 alist 服务因为这个 pr: https://github.com/alist-org/alist/pull/3074
Copy link
Copy Markdown
Member

@jyxjjj jyxjjj Jun 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

名字没改啊

This comment was marked as off-topic.

Sign in to view

Copy link
Copy Markdown
Author

@WenHao2130 WenHao2130 Jun 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

此处似乎暂时不需要修改呢，目前 openlist 并未发布二进制文件，需要根据实际二进制文件名称修改相应文档

Copy link
Copy Markdown
Member

@cxw620 cxw620 Jun 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

此处似乎暂时不需要修改呢，目前 openlist 并未发布二进制文件，需要根据实际二进制文件名称修改相应文档

就是 openlist

:::

#### **低于v3.25.0版本**
#### **低于 v3.25.0 版本**

```bash
./alist admin
```


#### **高于v3.25.0版本**
#### **高于 v3.25.0 版本**

3.25.0以上版本将密码改成加密方式存储的hash值，无法直接反算出密码，如果忘记了密码只能通过重新 **`随机生成`** 或者 **`手动设置`**
3.25.0 以上版本将密码改成加密方式存储的 hash 值，无法直接反算出密码，如果忘记了密码只能通过重新 **`随机生成`** 或者 **`手动设置`**

```bash
# 随机生成一个密码
Expand All @@ -81,7 +81,7 @@ location /alist/ {

除了 changelog 中标注的不兼容版本，通常可以直接替换二进制文件进行更新。

对于 docker 用户，只需删除旧的容器并拉取新的docker image，然后运行它即可。
对于 docker 用户，只需删除旧的容器并拉取新的 docker image，然后运行它即可。

### **如何允许访客上传文件**

Expand All @@ -99,18 +99,18 @@ location /alist/ {
### **添加 天翼云盘客户端 存储时：提示 need img validate code: 验证码**

- 点击编辑，把刚刚看到的验证码写进配置里面点击保存
- 点击编辑，把不使用OCR 按钮打开 ^(荐)^
- 点击编辑，把不使用 OCR 按钮打开 ^(荐)^
- 或者自己进行搭建[**Ocr接口**](../config/global.md#ocr-api)
- **天翼云盘**驱动因Web端登录已更换为滑动验证码，**不再支持ocr与手动输入**，若需要验证码请使用添加`Cookie进行登录`或使用`天翼云盘客户端`驱动(^注意看是天翼云盘驱动不是天翼云盘客户端^)
- **天翼云盘**驱动因 Web 端登录已更换为滑动验证码，**不再支持ocr与手动输入**，若需要验证码请使用添加`Cookie 进行登录`或使用`天翼云盘客户端`驱动(^注意看是天翼云盘驱动不是天翼云盘客户端^)

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

诸如此类的网络问题，请自行排查解决。不要为此提出任何的issue
诸如此类的网络问题，请自行排查解决。不要为此提出任何的 issue


### **怎么添加epub阅读**

后台 ——>设置——>预览——>Iframe 预览，写在PDF后面
后台 ——>设置——>预览——>Iframe 预览，写在 PDF 后面

```html{2-5}
/*下面的这个逗号也是哦，这个注释就不要复制了，从第二行开始复制*/
Expand All @@ -120,19 +120,19 @@ location /alist/ {
}
```

3.7.x 版本及更高的版本已经支持 ".epub" 阅读
3.7.x 版本及更高的版本已经支持 ".epub" 阅读
但是需要自己手动添加(因为已经创建过数据库了 不好给你覆盖会出错)
如果是第一次安装启动（3.7.x版本及更高的版本）不用手动添加
如果设置了二级目录反代，请在[site_url](../config/configuration.md#site-url)中自行添加相应前缀，然后重启OpenList才会生效
如果是第一次安装启动（3.7.x 版本及更高的版本）不用手动添加
如果设置了二级目录反代，请在[site_url](../config/configuration.md#site-url)中自行添加相应前缀，然后重启 OpenList 才会生效

### **如何快速定位Bug**

如果发现Bug，但是`log.log`的日志不详细，可以尝试在 启动时候添加 `--debug` 参数启动
如果发现Bug，但是 `log.log` 的日志不详细，可以尝试在 启动时候添加 `--debug` 参数启动

建议在使用`--debug` 参数启动之前将 **OpenList目录下的日志文件`/log/log.log` 清空**，这样方便开发者们后续快速定位问题
建议在使用 `--debug` 参数启动之前将 **OpenList 目录下的日志文件 `/log/log.log` 清空**，这样方便开发者们后续快速定位问题

::: danger
使用`--debug`参数启动时，会有一些敏感数据 例如 **`账号密码，刷新令牌`** 等，所以如果在你发给别人之前需要先处理一下脱敏
使用 `--debug` 参数启动时，会有一些敏感数据 例如 **`账号密码，刷新令牌`** 等，所以如果在你发给别人之前需要先处理一下脱敏
:::


Expand All @@ -141,4 +141,4 @@ location /alist/ {
- **Mac**：暂时未知，可能也是可以加 `--debug` 参数启动
- **Docker**：`docker exec -it alist ./alist server --debug`

启动后拿到相关日志，如何停止? `Ctrl+c` 可以使程序停止运行（或者简单粗暴直接关闭程序）
启动后拿到相关日志，如何停止? `Ctrl+C` 可以使程序停止运行（或者简单粗暴直接关闭程序）
Loading