Docs: update (#268)

* update * fix error
AlistGo · Sep 9, 2023 · d095473 · d095473
1 parent 77edcf8
commit d095473
Show file tree

Hide file tree

Showing 22 changed files with 221 additions and 16 deletions.
diff --git a/docs/.vuepress/public/img/advanced/sqlite-mysql.png b/docs/.vuepress/public/img/advanced/sqlite-mysql.png
diff --git a/docs/.vuepress/public/img/drivers/aliyun/vip2.png b/docs/.vuepress/public/img/drivers/aliyun/vip2.png
diff --git a/docs/.vuepress/public/img/drivers/dropbox/dropbox-2-2.png b/docs/.vuepress/public/img/drivers/dropbox/dropbox-2-2.png
diff --git a/docs/.vuepress/public/img/drivers/dropbox/dropbox-2.png b/docs/.vuepress/public/img/drivers/dropbox/dropbox-2.png
diff --git a/docs/.vuepress/theme.ts b/docs/.vuepress/theme.ts
@@ -20,8 +20,6 @@ export default hopeTheme(
     // iconAssets: "iconfont",
     iconAssets: [
       "iconfont",
-      "https://npm.onmicrosoft.cn/[email protected]/css/fontawesome.min.css",
-      "https://npm.onmicrosoft.cn/[email protected]/css/all.min.css",
       "https://npm.elemecdn.com/[email protected]/css/fontawesome.min.css",
       "https://npm.elemecdn.com/[email protected]/css/all.min.css",
     ],

diff --git a/docs/README.md b/docs/README.md
@@ -47,7 +47,7 @@ features:
     details: Use single sign-on to quickly log in to AList
 
   - title: Automatic registration of AList account
-    icon: fa-sharp fa-solid fa-webhook
+    icon: fa-solid fa-file-user
     details: Use single sign-on to automatically register as an AList account to quickly register
 
   - title: offline download

diff --git a/docs/guide/advanced/ipa.md b/docs/guide/advanced/ipa.md
@@ -59,7 +59,7 @@ Recommended to use [ipa-renamer](https://github.com/Xhofe/ipa-renamer) to rename
 - **Installation demo environment**: IOS15.4.1 iPhone12PM, personal certificate, HTTPS
 
 <ArtPlayer 
-  src="https://hub.onmicrosoft.cn/public/video/weibo?uid=7821998556&cursor=4870951244144255&raw=true" 
+  src="https://hub.onmicrosoft.cn/public/video/weibo?uid=7821998556&cursor=4870951244144255&raw=true&no_cache=false" 
 />
 
 

diff --git a/docs/guide/advanced/search.md b/docs/guide/advanced/search.md
@@ -30,6 +30,10 @@ star: true
 
 :::
 
+<br/>
+
+
+
 ### **Difference between different search indexes**
 
 - `database`: Search by database, which is using the existing data.db. It will create a new table, record the parent directory, name, and size of every object, but the search does not split words which means that match whether the keywords you enter appear in the name of object. In general, if you don't have a specific search requirement, we recommend you choose it.
@@ -59,13 +63,21 @@ Full-text search: It will not search in the text of all files, don't get it wron
 
 :::
 
+<br/>
+
+
+
 ### **Search tips**
 
 - If you want to search for a specific folder, you must choose `database` as the search index;
 - If you choose `database` as the search index and the type of your database is `sqlite3`, we suggest that you don't make any changes in the admin page while building the index, as sqlite3 does not support concurrent writes and can cause `database-lock` issues;
 - If you choose `bleve` as the search index, and if you want to search for new files or if you don't want to search for deleted files, the index needs to be completely rebuilt to take effect because `bleve` does not support incremental updates;
 - But for `database`, it supports incremental updates, so you can search for new files or deleted files just by access the modified folder (and click `refresh` icon if cached) without rebuilding the index, which is much more convenient than `bleve`.
 
+<br/>
+
+
+
 ### **Ignore paths**
 
 Paths to be skipped during index building, one path per line, multiple lines can be filled
@@ -76,6 +88,10 @@ Paths to be skipped during index building, one path per line, multiple lines can
    - /bbb network disk/ccc folder
 
 
+<br/>
+
+
+
 ### **Update index**
 
    - (formerly: the path to update the index)
@@ -88,6 +104,10 @@ Paths to be skipped during index building, one path per line, multiple lines can
 
       - /bbb network disk/ccc folder
 
+<br/>
+
+
+
    ### **Automatically update the index**
 
    :warning: **`The default is off, and the index will not be built automatically`**
@@ -111,6 +131,10 @@ Paths to be skipped during index building, one path per line, multiple lines can
    - [**Automatically update index**](#automatically-update-the-index): suitable for users who build indexes for all files
    - [**Update Index**](#update-index): Suitable for **not** to build indexes for all files, but there are files that need to be built, manually build indexes to avoid all being indexed
 
+<br/>
+
+
+
 ### **Maximum index depth**
 
 default 20.
@@ -131,3 +155,36 @@ Explanation: The directory can enter up to several layers. For example, if you h
 
 - After building an index, users without permissions can search for hidden file/folder solutions [click to view](meta.md#tips)
 
+<br/>
+
+
+
+### **The database file is very large, what should I do if it is still the same after clearing the index?**
+
+Normal users do not modify the database options. They use the `sqlite` database to build indexes, which will cause the database file to be particularly large
+
+- -Data files, `Data` folders in the same directory in Alist program,`data.db，data.db-shm，data.db-wal`
+
+After turning on the constructive index, the more the number you build, the larger the files. Finally, you accidentally occupy the machine's hard disk, and then click the clear index button. What should I do if the file is still as big?
+
+- This is caused by the cache of `sqlite`, there are two solutions
+
+  1. We use commands or tools to connect to `sqlite` database, input：**`VACUUM;`**
+
+  ```sqlite
+  VACUUM;
+  ```
+
+  2. After using the command to clean up, we replace it with `mysql` database before constructing indexes
+     - Sqlite replaced with mysql database tutorial：**[BV1iV4y1T7kh](https://www.bilibili.com/video/BV1iV4y1T7kh)**
+
+Comparison after cleaning the command: The picture above shows before cleaning up, and the following figure shows that after cleaning, you can execute several commands several times if there is no effect.
+
+![](/img/advanced/sqlite-mysql.png)
+
+-----
+
+`data.db, data.db-shm, data.db-wal` when backup, when backup，`data.db-shm，data.db-wal`Do these two files need backup？
+
+- In the backup, stop the program first, and then backup. You only need to backup the `data.db` database file. The other two do not need to backup
+- It may be after you stop the program`data.db-shm，data.db-wal`will automatically disappear, don't worry
diff --git a/docs/guide/drivers/115.md b/docs/guide/drivers/115.md
@@ -28,6 +28,8 @@ Due to the limitation of 115 Cloud, the download must carry cookies, so only the
 
 Open the official website of 115 Cloud and click the string behind the url when you click into the folder you want to set, such as <https://115.com/?cid=249163533602609229&offset=0&tab=&mode=wangpan>, which is `249163533602609229`
 
+<br/>
+
 ## **Login by QRCode**
 
 <script setup lang="ts">
@@ -104,10 +106,24 @@ style="outline:none;padding:12px;background:#70c6be;border:none;border-radius:8p
 
 </div>
 
+<br/>
+
 ## **Login by Cookie**
 
 The `cookie` is obtained from the request.
 
+<br/>
+
+## **Rapid upload**
+
+- **v.3.27.0** version Enhanced Rapid upload: You can directly upload files with `Alibaba Cloud Disk Open` by copying
+
+     - The premise is to upload the file from 115 Rapid upload to Alibaba Cloud Disk Open, the file already exists in Alibaba Cloud Disk Open, otherwise it is a normal copy task.
+
+If you want to upload files using Miaochuan, it is recommended to build an AList locally on your home computer and add a `local storage` and `115 cloud disk` to copy Miaochuan to save resources.
+
+<br/>
+
 ### **The default download method used**
 
 ```mermaid

diff --git a/docs/guide/drivers/Crypt.md b/docs/guide/drivers/Crypt.md
@@ -157,14 +157,24 @@ It can be treated as the second password if you don't understand it
 
 ### **Encrypted suffix**
 
-The default is `.bin`, the custom must start with` .`, such as .abc .aaa .Psd.
+Advanced options,The default is `.bin`, the custom must start with` .`, such as .abc .aaa .Psd.
 
 If the file name is encrypted, the encryption suffix `will not be used
 
 <br/>
 
 
 
+### **Filename encoding**
+
+Advanced options, non -professionals, please do not modify it. The default is **`base64`**, but the options other than **`base64`** are not tested. If you encounter problems, you need to solve it yourself.
+
+-Dy reference [#5109](https://github.com/alist-org/alist/issues/5109)，[#5080](https://github.com/alist-org/alist/issues/5080)
+
+<br/>
+
+
+
 ## **Advanced usage**
 
 Advanced usage is only applicable to those who know about **`rclone`**

diff --git a/docs/guide/drivers/aliyundrive_open.md b/docs/guide/drivers/aliyundrive_open.md
@@ -41,7 +41,9 @@ typeof fetch !== "undefined" && getLimit()
 
 **Aliyundrive VIP**：[https://www.aliyundrive.com/cpx/member](https://www.aliyundrive.com/cpx/member?userCode=MzAwMDM1&disableNav=YES)
 
-- <i class="fa-solid fa-lightbulb fa-bounce" style="color: orange;"></i> Click the link to get [**Coupon**](https://www.aliyundrive.com/cpx/member?userCode=MzAwMDM1&disableNav=YES), which is cheaper than buying directly on Alibaba Cloud Disk~
+- <i class="fa-solid fa-lightbulb fa-bounce" style="color: orange;"></i> Click the link to get [**Coupon**](https://www.aliyundrive.com/cpx/member?userCode=MzAwMDM1&disableNav=YES), which is cheaper than buying directly on Alibaba Cloud Disk~ `20T`Large -capacity package, sale in a limited time~
+
+<img src="/img/drivers/aliyun/vip2.png" alt="vip2" style="zoom:20%;" />
 
 :::
 
@@ -116,6 +118,13 @@ Rapid upload calculates the `sha1` value of the file (should be correct), you do
 
 - The interface provided by the official API of Alibaba Cloud Disk is used, check :point_right: [**Rapid upload logic**](https://www.yuque.com/aliyundrive/zpfszx/ezlzok#y7lyH)
 
+-----
+
+- **v.3.27.0** version enhanced Rapid upload: you can directly transfer files with `115 network disk` by copying
+  - The premise is that the file to be transferred from the Alibaba Cloud disk to 115 in seconds, 115 already exists, otherwise it is a normal copy task.
+
+If you want to upload files using Second Transmission, it is recommended to build an AList locally on your home computer and add a `Local Storage` and `Alibaba Cloud Disk` to copy Second Transmission to save resources.
+
 <br/>
 
 ## **Remove way**

diff --git a/docs/guide/drivers/dropbox.md b/docs/guide/drivers/dropbox.md
@@ -27,20 +27,25 @@ Dropbox Official：https://www.dropbox.com/
 Go to：**https://alist.nn.ci/tool/dropbox/request.html**
 
 - There are two ways, one is provided directly using AList, and the other is to create a new application by yourself
-  - The method of getting as follows (Recommend the first type^{left}^)
+  - The method of getting as follows (Recommend the first type^{right}^Because the AList provided can no longer create new users)
+  - When using the self-built `client ID` and `secret key` on the right, remember to authorize^{the_third_picture}^
 
 <div class="image-preview">  
     <img src="/img/drivers/dropbox/dropbox-1.png" alt="Use AList default to get token" title="Use AList default to get token"/>
     <img src="/img/drivers/dropbox/dropbox-2.png" alt="Create your own new application to obtain the client to get token" title="Create your own new application to obtain the client to get token"/>
+    <img src="/img/drivers/dropbox/dropbox-2-2.png" alt="Create your own new application to obtain the client to get token" title="Create your own new application to obtain the client to get token"/>
 </div>
 
 
+
 - If you use your own new applications, you need to fill in the `client id` and the `client secret key`
 
 - The method is shown in the right side of the example above(Create an application link：**https://www.dropbox.com/developers/apps**)
 
 - Redirect URLs：**https://alist.nn.ci/tool/dropbox/callback**
 
+Reference link: [**Click to view**](https://github.com/alist-org/alist/commit/cfee536b96f38e5ba3f3575fab4e89f6c0e1bc5b#commitcomment-119688700)
+
 
 
 ## **Root folder file_id**

diff --git a/docs/guide/drivers/quark.md b/docs/guide/drivers/quark.md
@@ -31,8 +31,6 @@ Or the root directory id can also be obtained from the address bar:
 
 ![url](/img/drivers/quark-rootid.png)
 
-
-
 ### **The default download method used**
 
 

diff --git a/docs/zh/README.md b/docs/zh/README.md
@@ -47,7 +47,7 @@ features:
     details: 使用单点登录快速登录AList
 
   - title: 自动注册AList帐号
-    icon: fa-sharp fa-solid fa-webhook
+    icon: fa-solid fa-file-user
     details: 使用单点登录自动注册为AList帐号快速注册
 
   - title: 离线下载

diff --git a/docs/zh/guide/advanced/ipa.md b/docs/zh/guide/advanced/ipa.md
@@ -61,8 +61,8 @@ star: true
 
 - **安装演示使用环境**： IOS15.4.1 iPhone12PM，个人证书，HTTPS
 
-<ArtPlayer 
-  src="https://hub.onmicrosoft.cn/public/video/weibo?uid=7821998556&cursor=4870951244144255&raw=true" 
+<ArtPlayer
+  src="https://hub.onmicrosoft.cn/public/video/weibo?uid=7821998556&cursor=4870951244144255&raw=true&no_cache=false" 
 />
 
 

diff --git a/docs/zh/guide/advanced/search.md b/docs/zh/guide/advanced/search.md
@@ -30,6 +30,10 @@ star: true
 
 :::
 
+<br/>
+
+
+
 ### **不同搜索索引之间的差异**
 
 - `数据库`:按数据库搜索，它使用现有的 data.db。它将创建一个新表，记录父目录、名称和每个对象的大小，但搜索不拆分单词，这意味着匹配您输入的关键字是否出现在对象的名称中。一般来说，如果您没有特定的搜索要求，我们建议您选择它。
@@ -59,6 +63,8 @@ star: true
 
 :::
 
+<br/>
+
 
 
 ### **搜索提示**
@@ -68,6 +74,10 @@ star: true
 - 如果你选择`bleve`作为搜索索引，如果你想搜索新文件或不想搜索已删除的文件，索引需要完全重建才能生效，因为`bleve`不支持增量更新;
 - 但对于`数据库`，它支持增量更新，所以你可以搜索新的文件或删除的文件，只需访问修改的文件夹(并单击'刷新'图标，如果缓存)，无需重建索引，这比`bleve`方便得多。
 
+<br/>
+
+
+
 ### **忽略路径**
 
 构建索引期间跳过填写的路径，一行一个路径，可多行填写
@@ -76,6 +86,10 @@ star: true
   - /aaa网盘
   - /bbb网盘/ccc文件夹
 
+<br/>
+
+
+
 ### **更新索引**
 
 - (原：要更新索引的路径)
@@ -88,6 +102,8 @@ star: true
 
   - /bbb网盘/ccc文件夹
 
+<br/>
+
 
 
 ### **自动更新索引**
@@ -113,6 +129,8 @@ star: true
 - [**自动更新索引**](#自动更新索引) ：适合将所有文件都构建索引的用户
 - [**更新索引**](#更新索引) ：适合 **不** 将所有文件都构建索引，但是有文件需要构建，自己手动去构建索引避免所有的都被构建索引
 
+<br/>
+
 
 
 ### **最大索引深度**
@@ -123,6 +141,8 @@ star: true
 
 说明：目录最多进几层，例如你有一个文件夹深度多达30层文件夹，设置为20，只构建前20层，剩下的10层不进行构建。
 
+<br/>
+
 
 
 ### :warning: **使用注意事项**
@@ -137,3 +157,37 @@ star: true
 
 - 为什么不直接开放V2 V3索引构建： **https://github.com/alist-org/alist/discussions/2529**
 - 构建索引后，没有权限的用户可以搜索到隐藏的文件/文件夹解决方案[点击查看](meta.md#tips)
+
+<br/>
+
+
+
+### **数据库文件很大，清空索引后还是一样大怎么办?**
+
+正常用户都是没有修改数据库选项使用的是 `sqlite` 数据库来构建索引的，就会导致数据库文件特别大
+
+- 数据库文件在AList同级目录下的`data`文件夹，`data.db，data.db-shm，data.db-wal`
+
+开启构建索引后，你构建的数量越多文件越大，最后不小心把机器的硬盘占满了，然后就点击了清除索引按钮，文件还是一样大这怎么办？
+
+- 这是因为`sqlite`的缓存导致的(不知道对不对),我们后面有两种解决方案
+
+  1. 我们使用命令或者工具连接上`sqlite`数据库，输入：**`VACUUM;`**
+
+  ```sqlite
+  VACUUM;
+  ```
+
+  1. 在使用命令清理后我们更换为`MySQL`数据库后再来构建索引
+     - Sqlite如何更换为MySQL数据库教程：**[BV1iV4y1T7kh](https://www.bilibili.com/video/BV1iV4y1T7kh)**
+
+使用命令清理前和使用命令清理后对比：上图为清理前，下图为清理后，如果没效果可以多执行几次命令。
+
+![](/img/advanced/sqlite-mysql.png)
+
+-----
+
+`data.db，data.db-shm，data.db-wal`三个文件在备份时，`data.db-shm，data.db-wal`这两个文件是否需要备份
+
+- 建议在备份时，先将程序停止，再进行备份，到时候可以只单独备份`data.db`数据库文件，另外两个可以不进行备份
+- 有可能在你停止程序后`data.db-shm，data.db-wal`这两个文件会自动消失，也不用担心