Skip to content

Commit d095473

Browse files
authored
Docs: update (#268)
* update * fix error
1 parent 77edcf8 commit d095473

File tree

22 files changed

+221
-16
lines changed

22 files changed

+221
-16
lines changed
10.4 KB
Loading
189 KB
Loading
73.5 KB
Loading
125 KB
Loading

docs/.vuepress/theme.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,6 @@ export default hopeTheme(
2020
// iconAssets: "iconfont",
2121
iconAssets: [
2222
"iconfont",
23-
"https://npm.onmicrosoft.cn/[email protected]/css/fontawesome.min.css",
24-
"https://npm.onmicrosoft.cn/[email protected]/css/all.min.css",
2523
"https://npm.elemecdn.com/[email protected]/css/fontawesome.min.css",
2624
"https://npm.elemecdn.com/[email protected]/css/all.min.css",
2725
],

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ features:
4747
details: Use single sign-on to quickly log in to AList
4848

4949
- title: Automatic registration of AList account
50-
icon: fa-sharp fa-solid fa-webhook
50+
icon: fa-solid fa-file-user
5151
details: Use single sign-on to automatically register as an AList account to quickly register
5252

5353
- title: offline download

docs/guide/advanced/ipa.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Recommended to use [ipa-renamer](https://github.com/Xhofe/ipa-renamer) to rename
5959
- **Installation demo environment**: IOS15.4.1 iPhone12PM, personal certificate, HTTPS
6060

6161
<ArtPlayer
62-
src="https://hub.onmicrosoft.cn/public/video/weibo?uid=7821998556&cursor=4870951244144255&raw=true"
62+
src="https://hub.onmicrosoft.cn/public/video/weibo?uid=7821998556&cursor=4870951244144255&raw=true&no_cache=false"
6363
/>
6464

6565

docs/guide/advanced/search.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,10 @@ star: true
3030

3131
:::
3232

33+
<br/>
34+
35+
36+
3337
### **Difference between different search indexes**
3438

3539
- `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
5963

6064
:::
6165

66+
<br/>
67+
68+
69+
6270
### **Search tips**
6371

6472
- If you want to search for a specific folder, you must choose `database` as the search index;
6573
- 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;
6674
- 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;
6775
- 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`.
6876

77+
<br/>
78+
79+
80+
6981
### **Ignore paths**
7082

7183
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
7688
- /bbb network disk/ccc folder
7789

7890

91+
<br/>
92+
93+
94+
7995
### **Update index**
8096

8197
- (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
88104

89105
- /bbb network disk/ccc folder
90106

107+
<br/>
108+
109+
110+
91111
### **Automatically update the index**
92112

93113
: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
111131
- [**Automatically update index**](#automatically-update-the-index): suitable for users who build indexes for all files
112132
- [**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
113133

134+
<br/>
135+
136+
137+
114138
### **Maximum index depth**
115139

116140
default 20.
@@ -131,3 +155,36 @@ Explanation: The directory can enter up to several layers. For example, if you h
131155

132156
- After building an index, users without permissions can search for hidden file/folder solutions [click to view](meta.md#tips)
133157

158+
<br/>
159+
160+
161+
162+
### **The database file is very large, what should I do if it is still the same after clearing the index?**
163+
164+
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
165+
166+
- -Data files, `Data` folders in the same directory in Alist program,`data.db,data.db-shm,data.db-wal`
167+
168+
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?
169+
170+
- This is caused by the cache of `sqlite`, there are two solutions
171+
172+
1. We use commands or tools to connect to `sqlite` database, input:**`VACUUM;`**
173+
174+
```sqlite
175+
VACUUM;
176+
```
177+
178+
2. After using the command to clean up, we replace it with `mysql` database before constructing indexes
179+
- Sqlite replaced with mysql database tutorial:**[BV1iV4y1T7kh](https://www.bilibili.com/video/BV1iV4y1T7kh)**
180+
181+
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.
182+
183+
![](/img/advanced/sqlite-mysql.png)
184+
185+
-----
186+
187+
`data.db, data.db-shm, data.db-wal` when backup, when backup,`data.db-shm,data.db-wal`Do these two files need backup?
188+
189+
- 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
190+
- It may be after you stop the program`data.db-shm,data.db-wal`will automatically disappear, don't worry

docs/guide/drivers/115.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@ Due to the limitation of 115 Cloud, the download must carry cookies, so only the
2828

2929
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`
3030

31+
<br/>
32+
3133
## **Login by QRCode**
3234

3335
<script setup lang="ts">
@@ -104,10 +106,24 @@ style="outline:none;padding:12px;background:#70c6be;border:none;border-radius:8p
104106

105107
</div>
106108

109+
<br/>
110+
107111
## **Login by Cookie**
108112

109113
The `cookie` is obtained from the request.
110114

115+
<br/>
116+
117+
## **Rapid upload**
118+
119+
- **v.3.27.0** version Enhanced Rapid upload: You can directly upload files with `Alibaba Cloud Disk Open` by copying
120+
121+
- 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.
122+
123+
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.
124+
125+
<br/>
126+
111127
### **The default download method used**
112128

113129
```mermaid

docs/guide/drivers/Crypt.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -157,14 +157,24 @@ It can be treated as the second password if you don't understand it
157157

158158
### **Encrypted suffix**
159159

160-
The default is `.bin`, the custom must start with` .`, such as .abc .aaa .Psd.
160+
Advanced options,The default is `.bin`, the custom must start with` .`, such as .abc .aaa .Psd.
161161

162162
If the file name is encrypted, the encryption suffix `will not be used
163163

164164
<br/>
165165

166166

167167

168+
### **Filename encoding**
169+
170+
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.
171+
172+
-Dy reference [#5109](https://github.com/alist-org/alist/issues/5109)[#5080](https://github.com/alist-org/alist/issues/5080)
173+
174+
<br/>
175+
176+
177+
168178
## **Advanced usage**
169179

170180
Advanced usage is only applicable to those who know about **`rclone`**

0 commit comments

Comments
 (0)