Skip to content

Commit 6bf53b1

Browse files
authored
docs: update storage and API documentation (#461)
* docs: add GuangYaPan mount guide * docs: update session and permission APIs * docs: update settings references * docs: refresh storage driver behavior notes * docs: add more storage driver guides * chore: update package lock metadata
1 parent eea6e89 commit 6bf53b1

82 files changed

Lines changed: 3171 additions & 117 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
125 KB
Loading
201 KB
Loading
195 KB
Loading
41.6 KB
Loading
206 KB
Loading

docs/config/global.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,12 @@ star: true
1818

1919
# Global settings
2020

21+
:::tip
22+
Supported version:
23+
24+
- Device-session limit, eviction policy, and TTL settings: `>= v3.52.0`
25+
:::
26+
2127
### **Hide files**
2228

2329
Match files hidden by regular expressions(`javascript`). If you don't understand, don't fill in them randomly. Wrong regular expressions `/\/README.md/i` will cause the front-end page to crash. One per line. By default, there is an example expression that hides README.md in all directories.
@@ -140,4 +146,30 @@ In the background `Settings`-->`Global`-->Open `Webauthn login enabled`, go back
140146

141147
- On the login page, click the login button on the far right, enter our user name, click login, and then unlock the required `Webauthn` verification method to log in
142148
- Adding `Webauthn` requires a secure origin and can only be used on `https` or `localhost`
143-
- Unsafe sources, such as: http, 192.168.x.x, 127.0.0.1, or directly use the server IP, etc. These places cannot be used
149+
- Unsafe sources, such as: http, 192.168.x.x, 127.0.0.1, or directly use the server IP, etc. These places cannot be used
150+
151+
<br/>
152+
153+
## **Max devices**
154+
155+
Global limit for active device sessions.
156+
157+
- `0` means unlimited
158+
- It is enforced when users log in with device sessions
159+
160+
<br/>
161+
162+
## **Device evict policy**
163+
164+
What to do when a new login would exceed `Max devices`.
165+
166+
- `deny`: reject the new login
167+
- `evict_oldest`: invalidate the oldest active device session first
168+
169+
<br/>
170+
171+
## **Device session ttl**
172+
173+
How long to keep stale device-session records, in seconds.
174+
175+
- It is used for automatic cleanup of inactive / expired device-session records

docs/config/other.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,12 @@ star: true
1818

1919
# Other settings
2020

21+
:::tip
22+
Supported version:
23+
24+
- Manually setting the admin token in UI/API: `>= v3.56.0`
25+
:::
26+
2127
### **Aria2**
2228

2329
Set Aria2 uri and Aria2 for offline download. Aria2 needs to be installed on the same server(container if use docker) as alist.
@@ -54,6 +60,9 @@ Allow the use of offline download tools such as 115/PikPak/Thunder in any storag
5460

5561
The token that can be used to access all API.
5662

63+
- In `Manage -> Settings -> Other`, you can copy it, set a fixed value manually, or reset it to a random value.
64+
- After changing it, remember to update scripts, proxy programs, or automation that still use the old token.
65+
5766
<br/>
5867

5968

@@ -68,4 +77,4 @@ The token that can be used to access all API.
6877

6978
2. Opening method, `Toggle Checkbox` in the lower right corner--> select list file/folder--> `Download` at the bottom--> `send to Aria2`
7079

71-
3. But it is recommended not to download too much at one time. For example, downloading thousands of folders and tens of thousands of files at one time may cause AList to crash
80+
3. But it is recommended not to download too much at one time. For example, downloading thousands of folders and tens of thousands of files at one time may cause AList to crash

docs/config/preview.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,12 @@ star: true
1818

1919
# Preview settings
2020

21+
:::tip
22+
Supported version:
23+
24+
- Global `Thumbnail size` setting for local thumbnails: `>= v3.58.0`
25+
:::
26+
2127
### **Text types**
2228

2329
The extensions of the files you want to preview as text, split by `,`, such as `txt,md,go,tsx`.
@@ -121,6 +127,14 @@ Whether to automatically play audio files.
121127

122128
Whether to automatically play video files.
123129

130+
### **Thumbnail size**
131+
132+
Thumbnail width in pixels. Height is scaled proportionally.
133+
134+
- Current default: `144`
135+
- The current backend uses this for thumbnails generated by the Local driver
136+
- Use a positive integer
137+
124138
### **Preview by default when opening archives**
125139

126140
After turning on this option, compressed package format files will be previewed by default (as shown in the figure below), which will consume some server traffic, but will not download them all, If you want to turn off the preferred preview of the compressed format, this option is turned off, and the preference is the download mode

docs/config/site.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,12 @@ star: true
1818

1919
# Site settings
2020

21+
:::tip
22+
Supported version:
23+
24+
- Current paginated list settings and default page size `50`: `>= v3.58.0`
25+
:::
26+
2127
### **Version**
2228

2329
The version of the `alist`, readonly.
@@ -72,7 +78,7 @@ If you think the `x` button in the upper right corner is in the way, you can use
7278

7379
### **Pagination type**
7480

75-
- All: All files will be displayed at once.
81+
- All: Legacy raw setting value. Use it carefully for very large directories.
7682
- Pagination: Show a `Paginator` at the bottom of the page.
7783
- Load more: Show a `Load more` button at the bottom of the page.
7884
- Auto load more: Automatically load more files when scrolling to the bottom of the page.
@@ -81,7 +87,11 @@ If you think the `x` button in the upper right corner is in the way, you can use
8187

8288
### **Default page size**
8389

84-
The default page size of the `alist` if `Pagination type` doesn't set to `All`, such as `20`.
90+
The default page size of the `alist` for paginated directory listing.
91+
92+
- Current site default: `50`
93+
- `/api/fs/list` still has its own backend default `200` when `per_page <= 0`
94+
- Backend maximum `per_page`: `500`
8595

8696

8797

docs/guide/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,17 @@ A file list program that supports multiple storage, and supports web browsing an
7676
- [x] [LenovoNasShare](https://pc.lenovo.com.cn)
7777
- [x] [GitHub API](../guide/drivers/github.md) / [GitHub Release](../guide/drivers/github_releases.md)
7878
- [x] [Misskey](https://misskey-hub.net/cn/docs/for-users/features/drive/)
79+
- [x] [Chunker](../guide/drivers/Chunker.md)
80+
- [x] [FTPS](../guide/drivers/ftps.md)
81+
- [x] [Gofile](../guide/drivers/gofile.md)
82+
- [x] [Streamtape](../guide/drivers/streamtape.md)
83+
- [x] [STRM](../guide/drivers/strm.md)
84+
- [x] [WuKongNetdisk](../guide/drivers/wukongnetdisk.md)
85+
- [x] [Doubao New](../guide/drivers/doubao_new.md)
86+
- [x] [Gitee](../guide/drivers/gitee.md)
87+
- [x] [BitQiu](../guide/drivers/bitqiu.md)
88+
- [x] [ProtonDrive](../guide/drivers/protondrive.md)
89+
- [x] [pCloud](../guide/drivers/pcloud.md)
7990

8091
### Discussion
8192

0 commit comments

Comments
 (0)