Skip to content

Commit

Permalink
docs: update (#226)
Browse files Browse the repository at this point in the history
Co-authored-by: Andy Hsu <[email protected]>
Co-authored-by: Andy Hsu <[email protected]>
  • Loading branch information
3 people authored Jun 11, 2023
1 parent 88b9648 commit b6bcd2a
Show file tree
Hide file tree
Showing 52 changed files with 577 additions and 93 deletions.
Binary file added docs/.vuepress/public/img/advanced/backup.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.vuepress/public/img/advanced/balance.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.vuepress/public/img/advanced/hide-tips.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.vuepress/public/img/advanced/sqlite3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/.vuepress/theme.ts
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,7 @@ export default hopeTheme(
sub: true,
sup: true,
align: true,
include: true,
},
components: {
components: ["ArtPlayer", "BiliBili", "Badge"],
Expand Down
4 changes: 4 additions & 0 deletions docs/config/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,10 @@ star: true

### **Initial config**

::: tip
After modifying the configuration file in `config.json`, you need to restart AList to take effect
:::

```json
{
"force": false,
Expand Down
55 changes: 48 additions & 7 deletions docs/faq/error.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,15 +27,23 @@ It is some error codes during the use of `AList`, and how to solve them (network

-----

<Badge text="Q" type="warning" vertical="middle" />:**TooManyRequests****Too Many Requests**
<Badge text="Q" type="warning" vertical="middle" />:Ali cloud disk open appears **TooManyRequests****Too Many Requests**

<br/>

<Badge text="A" type="info" vertical="middle" />:[**Click me to view detailed description**](../guide/drivers/aliyundrive_open.md)

-----

<Badge text="Q" type="warning" vertical="middle" />:Token is expired(Appears when logging in to the AList account)
<Badge text="Q" type="warning" vertical="middle" />:Ali cloud disk open appears **ExceedCapacityForbidden**

<br/>

<Badge text="A" type="info" vertical="middle" />:[**Click me to view detailed description**](../guide/drivers/aliyundrive_open.md#four、)

-----

<Badge text="Q" type="warning" vertical="middle" />:Token is expired(**Appears when logging in to the AList account**

<br/>

Expand Down Expand Up @@ -71,15 +79,15 @@ It is some error codes during the use of `AList`, and how to solve them (network

-----

<Badge text="Q" type="warning" vertical="middle" />:Failed create storage in database: UNIQUE constraint failed: x_storages.mount_path (appears when mounting the driver)
<Badge text="Q" type="warning" vertical="middle" />:Failed create storage in database: UNIQUE constraint failed: x_storages.mount_path (**appears when mounting the driver**)

<br/>

<Badge text="A" type="info" vertical="middle" />:The path to mount to, it is unique and cannot be repeated

-----

<Badge text="Q" type="warning" vertical="middle" />:Key: 'Storage.MountPath' Error:Field validation for 'MountPath' failed on the 'required' tag (appears when mounting the driver)
<Badge text="Q" type="warning" vertical="middle" />:Key: 'Storage.MountPath' Error:Field validation for 'MountPath' failed on the 'required' tag (**appears when mounting the driver**)

<br/>

Expand Down Expand Up @@ -125,23 +133,23 @@ It is some error codes during the use of `AList`, and how to solve them (network

-----

<Badge text="Q" type="warning" vertical="middle" />:Search not available(appears when indexing)
<Badge text="Q" type="warning" vertical="middle" />:Search not available(**appears when indexing**

<br/>

<Badge text="A" type="info" vertical="middle" />:The `Search Index` option is not selected, and cannot be built and used. I don’t know which search index to choose? [**Click me to view**](../guide/advanced/search.md#difference-between-different-search-indexes)

-----

<Badge text="Q" type="warning" vertical="middle" />:only chinese and english, numbers and underscores are supported, and the length is no more than 50 (Appears when the baidu.photo folder is renamed)
<Badge text="Q" type="warning" vertical="middle" />:only chinese and english, numbers and underscores are supported, and the length is no more than 50 (**Appears when the baidu.photo folder is renamed**)

<br/>

<Badge text="A" type="info" vertical="middle" />:When renaming the baidu.photo folder, the maximum length is 50

-----

<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(Add Alibaba cloud disk 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(**Add Alibaba cloud disk open**

<br/>

Expand All @@ -165,4 +173,37 @@ It is some error codes during the use of `AList`, and how to solve them (network

-----

<Badge text="Q" type="warning" vertical="middle" />:Failed get storage: please add a storage first. (**When adding offline download files**

<br/>

<Badge text="A" type="info" vertical="middle" />:When adding an offline download file, you need to enter which cloud disk you want to download the offline download file to and then click on the `folder` instead of adding it on the home page [**Complete Instructions**](../guide/advanced/offline-download.md)

-----

<Badge text="Q" type="warning" vertical="middle" />:failed get objs: failed to list objs: Unable to retrieve user's mysite URL(**When adding onedrive_app**

<br/>

<Badge text="A" type="info" vertical="middle" />:The newly created `OneDrive` user account does not take effect in real time, Delay takes effect, wait for a few hours and try again [**Case**](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 (**When starting the AList program**

<br/>

<Badge text="A" type="info" vertical="middle" />:Port number 5244 is already in use, check whether it is occupied (generally you have started an AList with port 5244), or modify the port number started by AList, [**How to modify**](../config/configuration.md#port)

-----

<Badge text="Q" type="warning" vertical="middle" />:**[When AList upload file](why.md#why-do-i-get-413-http-code-when-i-upload-a-file)**:Request failed with status code 413

<br/>

<Badge text="A" type="info" vertical="middle" />:Limit the size of the files configured nginx, modify the nginx's `client_max_body_size`,If you are a pagoda to go to the pagoda page to modify [Example](https://blog.csdn.net/u012514495/article/details/127981183)

-----

That's all for the time being, if there are more, you can leave a message, or add according to the format (for uniformity and intuitiveness)

6 changes: 4 additions & 2 deletions docs/faq/howto.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,17 +91,18 @@ For network problems such as these, please troubleshoot and solve them yourself.

Background --> Settings --> Preview --> Iframe preview, written behind the PDF

```html
```html{2-5}
/*The comma below is also oh, don’t copy this comment, start copying from the second line*/
,
"epub": {
"EPUB.js":"/static/epub.js/viewer.html?url=$e_url"
}
```

Version 3.7.x and above already support ".epub" reading,
Version 3.7.x and higher already support ".epub" reading
But you need to add it manually (because the database has already been created, it is not good to overwrite it for you, and you will make mistakes)
If it is the first installation and startup (version 3.7.x and higher), no need to add it manually
If the secondary directory reverse generation is set, please add the corresponding prefix in [site_url](../config/configuration.md#site-url), and then restart AList to take effect

### **How to quickly locate bugs**

Expand All @@ -116,5 +117,6 @@ When using the `--debug` parameter to start, there will be some sensitive data s
- **Windows**`alist.exe server --debug`
- **Linux**`./alist server --debug`
- **Mac**: Temporarily unknown, maybe it is started with the `--debug` parameter
- **Docker**`docker exec -it alist ./alist server --debug`

How to stop the relevant logs after startup? `Ctrl+c` can stop the program (or simply close the program directly)
1 change: 1 addition & 0 deletions docs/guide/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ A file list program that supports multiple storage, and supports web browsing an
- [x] [Trainbit](https://trainbit.com/)
- [x] [UrlTree](../guide/drivers/urltree.md)
- [x] IPFS
- [x] [UC](https://drive.uc.cn/)

### Discussion

Expand Down
47 changes: 47 additions & 0 deletions docs/guide/advanced/backup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
# This is the icon of the page
icon: view
# This control sidebar order
order: 11
# A page can have multiple categories
category:
- Guide
# A page can have multiple tags
tag:
- Advanced
- Guide
# this page is sticky in article list
sticky: true
# this page will appear in starred articles
star: true
---

# Backup&Restore

## **Method 1-Built-in**

Use `AList` to manage `Backup/Restore` options

> Backup: Backup Alist data (==**does not include index**==)
>
> Recovery: Backup files before recovery
>
> Cover: Select coverage when recovery, and will cover the user information
![](/img/advanced/backup.png)



## **Method 2-Sqlite3**

Back up the data/`data.db` database in the` AList` directory, and wait for the new environment to replace it directly (==**contains index data**==)

If there are two files, if there are `data.db-shm` and` data.db-clothes`, they must be backup together.

![](/img/advanced/sqlite3.png)



## **Method 3-Other database**

Other, if you use `mysql, postgres` and other non ` sqlite database `, please solve it by yourself (==**include indexing data**==)
4 changes: 4 additions & 0 deletions docs/guide/advanced/balance.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,10 @@ Different network disks can be used, but the file directories must be consistent

- If the network disk mounted on the main display is inconsistent with the directory tree of the network disk mounted on the load and an error is returned after modifying the network disk mounted on the main display, you can solve it by yourself to keep the directory files of the network disk on the load consistent.

![](/img/advanced/balance.png)

The first is marked with a red box. It is the main mount, which is displayed on the front page. The remaining nine are the first load balancing on the first one.

### **how to use​**

One storage can be added normally, and the other storage can be added with the mount path of `the first storage mount path + .balance + any other content`.
Expand Down
29 changes: 28 additions & 1 deletion docs/guide/advanced/meta.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,40 @@ The configuration in the meta information is only valid for `Guest`, if you want
### **Path**

The path for this meta to take effect



### **Password**
Password required to access this path



### **Write**
Allow guest to make directory, new file and upload files.



### **Hide**
The objects to hide of this path, One regular expression (in `Golang`) per line.



### **Readme**
The Readme to render while enter this path, support markdown content or markdown link.



### **Apply to sub folder**
Apply this meta to sub folder of specific path
Apply this meta to sub folder of specific path



## :warning: Tips

> Regarding hidden, users without permissions can search for hidden folders/files, solutions
:white_check_mark: If you want to hide the folder in a folder, create a new Yuan information alone, and select the folder we want to hide,,Hidden if you want to hide everything, write directly`.*`

:x: You cannot directly fill in the meta information of the root directory `/`, and then fill in the folder we want to hide, the error case [View details](https://github.com/alist-org/alist/issues/4494)

![](/img/advanced/hide-tips.png)
6 changes: 5 additions & 1 deletion docs/guide/advanced/search.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ Follow the steps below to enable search:
2. After the index is saved, click `Build indexes` to build the index.
3. Now you can search for files by click the search block on the top right corner of the page or by using the shortcut `Ctrl + K`.

:exclamation::exclamation::exclamation: If you do not follow the above prompts, the prompt will be opened: **Search Not available**

### **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.
Expand Down Expand Up @@ -80,7 +82,7 @@ Paths to be skipped during index building, one path per line, multiple lines can
- example:

- /aaa network disk

- /bbb network disk/ccc folder

### **Automatically update the index**
Expand Down Expand Up @@ -124,3 +126,5 @@ Explanation: The directory can enter up to several layers. For example, if you h

- Why not directly open V2 V3 index construction: **https://github.com/alist-org/alist/discussions/2529**

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

5 changes: 4 additions & 1 deletion docs/guide/advanced/user.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,7 @@ The root path that users see when he/she log in
1. Are you worried that visitors can see all files? [**Click to see how to set it up here**](../../faq/why.md#how-do-i-set-it-so-that-visitors-can-only-see-the-content-after-logging-in)

2. **`Guest user is disabled, login please`**: In order to protect your Alist security, the guest access permission is closed, if you need guest access, open it yourself
- AList Manage --> users --> `guest` --> **Disable** uncheck
- AList Manage --> users --> `guest` --> **Disable** uncheck
3. Question about **`Copy/Upload`**

- If you upload (including offline download and upload) large files, or upload a lot of files (hundreds or thousands), it is not recommended to use AList to operate, please go to the corresponding network disk official website to operate directly
34 changes: 18 additions & 16 deletions docs/guide/drivers/aliyundrive_open.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ typeof fetch !== "undefined" && getLimit()
- For example, it is counted as a request when ~~saving/editing~~, and viewing files and watching video downloads is not counted.
- The number of times and time mentioned above are dynamic~
- New optimization: **will only refresh the token when the request finds that the token is expired, update restart editing if the token is still valid will not refresh.**
5. Online playback video reminder: **`ExceedCapacityForbidden`** error, the capacity exceeds restrictions, implements restrictions, needs to be expanded or deleted unnecessary file saving space to save space,[View details](#four、)

:::

Expand All @@ -57,17 +58,10 @@ Go to:**https://alist.nn.ci/tool/aliyundrive/request**

**refresh_token** can be obtained in the following two ways

:::tabs#alitoken

@tab Go to login

![token](/img/drivers/aliyun/token1.png)

@tab Scan QrCoden

![token](/img/drivers/aliyun/token2.png)

:::
<div class="image-preview">
<img src="/img/drivers/aliyun/token1.png" alt="Go to login" title="Go to login"/>
<img src="/img/drivers/aliyun/token2.png" alt="Scan QrCode" title="Scan QrCode"/>
</div>



Expand All @@ -91,7 +85,7 @@ Normal users don’t need to fill in the blank. If they apply for official autho

- Trash: Enter the cloud disk recycle bin after AList is deleted, which will occupy the cloud disk space, but it can be retrieved if it is deleted by mistake later.
- Delete: direct deletion will not stay in the recycle bin, and will not occupy cloud disk space, but if deleted by mistake later, it cannot be retrieved.
- Note: Please do not disclose the Token obtained by your Alibaba Cloud Disk Open, ==If you accidentally leak it, please immediately go to [**Other instructions¹**](#Open%20Alibaba%20Cloud%20Disk%20APP%20-->%20My%20-->%20Settings%20gear%20in%20the%20upper%20right%20corner%20-->%20Privacy%20Settings%20-->%20Authorization%20Management%20-->%20Click%20AList%20to%20view) to deauthorize, and then re-scan the code to authorize a new refresh token , at the same time, all the previous acquisitions will become invalid after the authorization is deactivated, so as to protect the security of your account==
- Note: Please do not disclose the Token obtained by your Alibaba Cloud Disk Open, ==If you accidentally leak it, please immediately go to [**Other instructions¹**](#open-alibaba-cloud-disk-app-my-settings-gear-in-the-upper-right-corner-privacy-settings-authorization-management-click-alist-to-view) to deauthorize, and then re-scan the code to authorize a new refresh token , at the same time, all the previous acquisitions will become invalid after the authorization is deactivated, so as to protect the security of your account==



Expand All @@ -105,7 +99,7 @@ If the server you deploy AList on is Aliyun ECS for Beijing area, turn on this s

## **other instructions**

one、
##### one、

> AList only obtained cloud disk users (**name avatar¹**), (**access file permission²**) and (**write file permission³**), and did not obtain mobile phone number permission
>
Expand All @@ -116,7 +110,7 @@ one、
>
> - If you don't use it, you can manually cancel the permission at any time
two、
##### two、

>By default, the built-in player of Aliyun Disk is used - **Aliyun Video Previewer**
>
Expand All @@ -127,13 +121,21 @@ two、
>- Real-time transcoding takes some time.
>- The picture quality are: LD|SD|HD|FHD|QHD
three、
##### three、

>Q: Why can’t Alibaba Cloud Disk Open see files of the Office Family Bucket type?
>
>A: Because Aliyun disk has not opened the relevant API, it is temporarily unavailable to view
Four、
##### Four、

>Q:Unable to play Alibaba Cloud disk video online, prompt: **`ExceedCapacityForbidden`** error
>
>A:**User capacity exceeded**, playback restricted, need to expand or delete unnecessary files to free up space,The prompts of the Alist and Alibaba Cloud Drive APP are as shown below
>
><img src="/img/drivers/aliyun/error.png" style="zoom:70%;" />
##### five、

>Q: How to load subtitles?
>
Expand Down
Loading

0 comments on commit b6bcd2a

Please sign in to comment.