Skip to content

Commit

Permalink
V2文档完善更新
Browse files Browse the repository at this point in the history
  • Loading branch information
anwen-anyi committed Jul 3, 2022
1 parent e9e4f2f commit a0ef905
Show file tree
Hide file tree
Showing 13 changed files with 240 additions and 51 deletions.
49 changes: 49 additions & 0 deletions docs/changelog/v2.6.x.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
sidebar_position: 9950
---



# 题外话

若文档版本更新内容未更新,可前往[**`GitHub`**](https://github.com/alist-org/alist/releases)`Release`查看



## v2.6.1

- [`eb15bce`](https://github.com/alist-org/alist/commit/eb15bce24b2bceff0a81696b38ac85cca575adde) ci: auto generate changelog
- [`5281426`](https://github.com/alist-org/alist/commit/52814266b8c6e4ff850995bddcab1a7df7bcce46) chore: Merge pull request [#1200](https://github.com/alist-org/alist/pull/1200) from alist-org/all-contributors/add-XZB-1248
- [`f845ec0`](https://github.com/alist-org/alist/commit/f845ec05e0dab1dd2e4b472f11eba9374d17dd8f) docs: update .all-contributorsrc [skip ci]
- [`29fb02c`](https://github.com/alist-org/alist/commit/29fb02c886de272bdeb5d2bd74d5c6a993c4b90d) docs: update CONTRIBUTORS.md [skip ci]
- [`072e854`](https://github.com/alist-org/alist/commit/072e854a7196d0a67c9d7623f42dab2b4664fe32) chore: Merge pull request [#1199](https://github.com/alist-org/alist/pull/1199) from alist-org/dev
- [`cae0a5f`](https://github.com/alist-org/alist/commit/cae0a5f603355a14c9d9e1ab48b95840b2143a83) chore: Merge pull request [#1191](https://github.com/alist-org/alist/pull/1191) from XZB-1248/dev
- [`7c6d8ca`](https://github.com/alist-org/alist/commit/7c6d8ca2229e06ab69ac6199f6116f99b4b70ea8) fix(proxy): filename is urlencoded when using Safari
- [`f6be50f`](https://github.com/alist-org/alist/commit/f6be50f15a5b6e52df00ba69800e07c98387fc7d) fix(189): login and get link (close [#1182](https://github.com/alist-org/alist/issues/1182))

## v2.6.0
- ### core

- fix(sftp): infinite loop while remove file (close [#1094](https://github.com/alist-org/alist/issues/1094))
- fix(189): new resty client
- fix: don't save search files of balance account (close [#1125](https://github.com/alist-org/alist/issues/1125))
- feat: add `pdf viewer url` to settings (close [#1109](https://github.com/alist-org/alist/issues/1109))
- feat: add `m4v` to default video types (close [#1114](https://github.com/alist-org/alist/issues/1114))
- fix(189pc): delete user-agent for upload
- feat(123):add io stream upload
- fix(123,189pc,alidriver,xunlei):tempfile remove
- fix: disable pprof while not debug

### web

- fix: refresh while pagination (close [#1124](https://github.com/alist-org/alist/issues/1124))
- fix: code editor for json file (close [#1165](https://github.com/alist-org/alist/issues/1165))
- chore: dev server url
- chore: upgrade artplayer (Xhofe/alist#1134)
- chore: delete old build.sh
- feat: customize pdf viewer ([#1109](https://github.com/alist-org/alist/issues/1109))

**Full Changelog**:

- [`v2.5.2...v2.6.0`](https://github.com/alist-org/alist/compare/v2.5.2...v2.6.0)
- [alist-org/alist-web@`2.5.0...2.6.0`](https://github.com/alist-org/alist-web/compare/2.5.0...2.6.0)
30 changes: 26 additions & 4 deletions docs/common-question.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
sidebar_position: 10
---

# Alist添加使用时常见问题
# Alist常见问题



### 添加天翼云盘时:设备ID不存在,需要二次设备校验
Expand All @@ -13,9 +14,10 @@ sidebar_position: 10

由于referrer的限制,必须使用移动端token

### 视频播放不了?
### 视频播放不了?有声无画面? 有画面无声音?

检查一下是不是编码不支持,一般浏览器不支持h.265(hevc)等编码视频,ac3等编码音频,Safari不支持的更多,**建议使用软件播放**

检查一下是不是编码不支持,一般浏览器不支持h.265(hevc)等编码视频,ac3等编码音频,Safari不支持的更多,建议使用软件播放。
> 现有主流浏览器支持度:
> - Chrome(Chromium): 版本104以上将会支持h.265(hevc)PS:[目前该版本尚未正式发布](https://www.bilibili.com/read/cv16293285)
> - Microsoft Edge: 新旧内核均支持h.265(hevc),但需额外安装插件
Expand Down Expand Up @@ -95,10 +97,30 @@ docker更新请参考:https://store.heytapimage.com/cdo-portal/feedback/202112
```


### TLS handshake timeout? / read: connection reset by peer? / dns lookup failed? / connect: connection refused / context deadline exceeded (Client.Timeout exceeded while awaiting headers)?
### TLS handshake timeout? / read: connection reset by peer? / dns lookup failed? / connect: connection refused?

诸如此类的网络问题,请自行排查解决。

### 搜索相关问题

**2022年6月23日 v2.6.1 版本**

1. 搜索目前处于实验室功能,【不推荐】使用
2. 开启方式 **Alist后台 → 设置 → 后端 → enable search开关打开**
3. 搜索快捷键 【Ctrl + K】,需要先去后台开启按钮,开启方式参考第二条
4. 开启后搜索不到东西,因为需要缓存才可以搜索,需要你先去浏览一圈文件才能搜索到
5. 会搜索出来你 **加密、隐藏** 等未公开的文件,请看第一条
6. 已经修改了文件/文件夹名称 还是能搜索出来,点过去无效,缓存问题 ~ 请看第一条
7. 什么时候正式版上线,未知敬请期待...

### Windows(xp,w7,w8)等,Windows10以下的系统密码不对,显示乱码

低版本Windows(win10以下)不适配,密码为 **4m和←** 之间的八个字符。比如下图

![WindowsPassword](/img/driver/alist/WindowsPassword.png)



:::tip
如果阅读文档之后,还未解决你的问题,请优先[在Discussions中提问/讨论](https://github.com/Xhofe/alist/discussions)[提issue](https://github.com/Xhofe/alist/issues/new/choose)
:::
9 changes: 8 additions & 1 deletion docs/driver/189.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,4 +49,11 @@ sidebar_position: 5

<video controls src="https://video-direct-link.vercel.app/bili.mp4?aid=895650492&bvid=BV16A4y197De&cid=576704921" width="100%" />

**https://www.bilibili.com/video/BV16A4y197De**
**https://www.bilibili.com/video/BV16A4y197De**



### 添加天翼云盘时:设备ID不存在,需要二次设备校验

可能是触发了防控,修改密码后重新添加。

3 changes: 2 additions & 1 deletion docs/driver/baidu.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,5 @@ curl -L -X GET 'YOUR_LINK' -H 'User-Agent: pan.baidu.com'
### Download api

- official: 官方接口,非常稳定,但是对于较大文件需要修改UA且速度慢
- crack:非官方接口,无需修改UA且部分文件可能不限速,但是**可能**会不稳定
- crack:非官方接口,无需修改UA且部分文件**可能**不限速,但是**可能**会不稳定

4 changes: 2 additions & 2 deletions docs/driver/onedrive.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ sidebar_position: 4
<!-- <iframe src="//player.bilibili.com/player.html?aid=636185928&bvid=BV1Rb4y1E7NV&cid=499811348&page=1&high_quality=1&danmaku=1&as_wide=1" scrolling="no" border="0" width="100%" height="500" frameborder="no" framespacing="0" allowfullscreen="true"> </iframe> -->
<video controls src="https://video-direct-link.vercel.app/bili.mp4?aid=636185928&bvid=BV1Rb4y1E7NV&cid=499811348" width="100%" />

*https://www.bilibili.com/video/BV1Rb4y1E7NV*
[**https://www.bilibili.com/video/BV1Rb4y1E7NV**](https://www.bilibili.com/video/BV1Rb4y1E7NV)

### First

Expand All @@ -26,7 +26,7 @@ sidebar_position: 4
- 登陆后选择「注册应用程序」,输入「名称」,选择「任何组织目录中的账户和个人」(注意这里不要看位置选择而是看文字,部分人可能是中间那个选项,不要选成单一租户或者其他选项,否则会导致登陆时出现问题),输入重定向 URL 为 <https://tool.nn.ci/onedrive/callback> ,「注册」即可,然后可以得到client_id
![client_id](https://store.heytapimage.com/cdo-portal/feedback/202111/24/998aa05659a10e87b3f2161d844263f8.png)
- 注册好应用程序之后,选择「证书和密码」,点击「新客户端密码」,输入一串密码,选择时间为最长的那个,点击「添加」
(注:在添加之后输入的密码之后会消失,请记录下来 client_secret 的值)
(注:在添加之后输入的密码之后会消失,请记录下来 client_secret 的值)
![client_secret](https://store.heytapimage.com/cdo-portal/feedback/202111/24/a3c7b8fd2a6577ee62404ad054ebbe90.png)
- 选择「API 权限」,点击 「MicroSoft Graph」,在「选择权限」中输入 file,勾选 「Files.read」(注:Files.read 是只读最小权限,图中权限较大,也同样可以),点击「确定」
![api](https://store.heytapimage.com/cdo-portal/feedback/202111/24/15cf3a64994935cdda76185cc181fad1.png)
Expand Down
14 changes: 13 additions & 1 deletion docs/driver/quark.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,19 @@ sidebar_position: 20
由于夸克网盘的限制,下载必须携带cookie,所以只能使用本程序中的代理功能进行中转。(可以使用其他机器中转)
:::

**夸克网盘官网:https://pan.quark.cn/**

Cookie和根目录ID从请求中获取:
![quark](https://store.heytapimage.com/cdo-portal/feedback/202202/17/bbb76e65f7f5a6bf5e6c40c7116b0914.png)
或者根目录id也可以从地址栏获取:
![url](https://store.heytapimage.com/cdo-portal/feedback/202202/17/47aaa537753e57508ed20ac786f87386.png)
![url](https://store.heytapimage.com/cdo-portal/feedback/202202/17/47aaa537753e57508ed20ac786f87386.png)





## 视频教程

<video controls src="https://video-direct-link.vercel.app/bili.mp4?aid=342662209&bvid=BV1v94y1y7gd&cid=752422768" width="100%" />

**https://www.bilibili.com/video/BV1v94y1y7gd**
30 changes: 15 additions & 15 deletions docs/driver/thunder.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,35 +8,35 @@ sidebar_position: 24



## 推荐你看这个视频来了解如何添加:
## 下载报错临时解决方案

<video controls src="https://video-direct-link.vercel.app/bili.mp4?aid=511500007&bvid=BV1yu411z7ZF&cid=721651025" width="100%" />
**https://www.bilibili.com/video/BV1yu411z7ZF/**
> **访问xxxxxx-aliyun04-vip-lixian.xunlei.com的请求遭到拒绝**
>
> **您未授权,无法查看此网页**
>
> **HTTP ERROR 403**
1. 可以下载器手动指定ua **AndroidDownloadManager/11 (Linux; U; Android 11; M2004J7AC)**(链接不限速)

2. 或者后台设置ua为 **AndroidDownloadManager/11 (Linux; U; Android 11; M2004J7AC)** Alist添加账号里面开启代理,需要重启alist(链接限速)

**以上两个选项就是这个问题的临时解决方法**


## 纯享版-一镜到底:

<video controls src="https://video-direct-link.vercel.app/bili.mp4?aid=554110193&bvid=BV18v4y1N7AY&cid=721662144" width="100%" />
**https://www.bilibili.com/video/BV18v4y1N7AY/**
## 推荐你看这个视频来了解如何添加:

<video controls src="https://video-direct-link.vercel.app/bili.mp4?aid=511500007&bvid=BV1yu411z7ZF&cid=721651025" width="100%" />
**https://www.bilibili.com/video/BV1yu411z7ZF/**


## 下载报错临时解决方案

> **访问xxxxxx-aliyun04-vip-lixian.xunlei.com的请求遭到拒绝**
>
> **您未授权,无法查看此网页**
>
> **HTTP ERROR 403**

1. 可以下载器手动指定ua **AndroidDownloadManager/11 (Linux; U; Android 11; M2004J7AC)**(链接不限速)

2. 或者后台设置ua为 **AndroidDownloadManager/11 (Linux; U; Android 11; M2004J7AC)** Alist添加账号里面开启代理,需要重启alist(链接限速)
## 纯享版-一镜到底:

**以上两个选项就是这个问题的临时解决方法**
<video controls src="https://video-direct-link.vercel.app/bili.mp4?aid=554110193&bvid=BV18v4y1N7AY&cid=721662144" width="100%" />
**https://www.bilibili.com/video/BV18v4y1N7AY/**



Expand Down
6 changes: 5 additions & 1 deletion docs/features/encrypt.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,5 +24,9 @@ sidebar_position: 2
<summary>文档看不懂看视频</summary>
<div>
<video controls src="https://video-direct-link.vercel.app/bili.mp4?aid=724873407&bvid=BV15S4y1U7AK&cid=549586831" width="100%" />
<p><a href="https://www.bilibili.com/video/BV15S4y1U7AK" target="_blank" class="default-entry"><span>https://www.bilibili.com/video/BV15S4y1U7AK</span></a></p>
</div>
</details>
</details>

[**https://www.bilibili.com/video/BV15S4y1U7AK**](https://www.bilibili.com/video/BV15S4y1U7AK)

20 changes: 20 additions & 0 deletions docs/features/hide.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,26 @@ sidebar_position: 4

即可。



### only_shows

解释:只想显示,其他的隐藏.

比如上图所示 在 元信息`only_shows`添加 `2.jpg`其他的都会自动隐藏只显示 `2.jpg`这个文件

以前如果你要只单独显示`2.jpg`,你得手动添加除了`2.jpg`这个文件以外所有的文件名称好麻烦,现在只需要添加一个只想显示的即可

如果隐藏的就一个两个可以在原来位置写你想隐藏的就行 比如隐藏 **`动漫壁纸【手机】,blog.jpg`**哪你就在原来位置写 `动漫壁纸【手机】,blog.jpg`

注:多文件中间间隔要用 英文逗号隔开喔~



注:如果实在看不懂可以去看加密栏里面的视频.



### 前端隐藏
后台api会返回数据,只是前端不会去显示。

Expand Down
60 changes: 38 additions & 22 deletions docs/install/manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,34 @@ chmod +x alist-xxxx
```
*其中的xxxx是指不同系统/架构对应的名称,一般Linux-x86/64是alist-linux-amd64,如果你的glibc版本过低,建议下载musl版本*

### 守护进程
`vim /etc/systemd/system/alist.service`添加以下内容,其中path_alist为alist所在的路径
```ini
[Unit]
Description=alist
After=network.target

[Service]
Type=simple
WorkingDirectory=path_alist
ExecStart=path_alist/alist-xxxx -conf data/config.json
Restart=on-failure

[Install]
WantedBy=multi-user.target
```
然后`systemctl daemon-reload`,现在你就可以使用这些命令来管理程序了:
- 启动: `systemctl start alist`
- 关闭: `systemctl stop alist`
- 自启: `systemctl enable alist`
- 状态: `systemctl status alist`
- 重启: `systemctl restart alist`



----


<details>
<summary>Windows</summary>
<div>
Expand Down Expand Up @@ -55,27 +83,15 @@ WScript.quit



<details>
<summary>Windows的使用文档看不懂可以看视频,4分28秒开始</summary>
<div>
<video controls src="https://video-direct-link.vercel.app/bili.mp4?aid=427916745&bvid=BV1DG411s7j5&cid=760544575" width="100%" />
<p><a href="https://www.bilibili.com/video/BV15S4y1U7AK" target="_blank" class="default-entry"><span>https://www.bilibili.com/video/BV1DG411s7j5?t=268.1</span></a></p>
</div>
</details>

**https://www.bilibili.com/video/BV1DG411s7j5?t=268.1**



### 守护进程
`vim /etc/systemd/system/alist.service`添加以下内容,其中path_alist为alist所在的路径
```ini
[Unit]
Description=alist
After=network.target

[Service]
Type=simple
WorkingDirectory=path_alist
ExecStart=path_alist/alist-xxxx -conf data/config.json
Restart=on-failure

[Install]
WantedBy=multi-user.target
```
然后`systemctl daemon-reload`,现在你就可以使用这些命令来管理程序了:
- 启动: `systemctl start alist`
- 关闭: `systemctl stop alist`
- 自启: `systemctl enable alist`
- 状态: `systemctl status alist`
- 重启: `systemctl restart alist`
8 changes: 4 additions & 4 deletions docs/install/source-code.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ sidebar_position: 7
### 环境准备
首先需要有`git``nodejs``yarn``golang>=1.18`, `gcc`的环境

### 构建前端
clone https://github.com/Xhofe/alist-web 这个项目,执行`yarn && yarn build`,得到dist目录下的目标文件
### 拉取并构建前端
git clone https://github.com/Xhofe/alist-web 这个项目,执行`yarn && yarn build`,得到dist目录下的目标文件

### 构建后端
clone https://github.com/Xhofe/alist 这个项目,将上一步dist目录下的文件全部拷贝至项目下的public目录,然后:
### 拉取并构建后端
git clone -b v2 https://github.com/alist-org/alist 这个项目,将上一步dist目录下的文件全部拷贝至项目下的public目录,然后:
```bash
appName="alist"
builtAt="$(date +'%F %T %z')"
Expand Down
Loading

0 comments on commit a0ef905

Please sign in to comment.