Skip to content

Commit f402543

Browse files
authored
update Docs (#159)
1 parent c8cf5bc commit f402543

File tree

16 files changed

+102
-17
lines changed

16 files changed

+102
-17
lines changed
408 KB
Loading
9.31 KB
Loading
35.3 KB
Loading
5.31 KB
Loading

docs/config/other.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,16 @@ star: true
2222

2323
Set Aria2 uri and Aria2 for offline download. Aria2 needs to be installed on the same server(container if use docker) as alist.
2424

25+
26+
27+
## Qbittorrent url
28+
29+
Used to customize **Qbittorrent** parameters to configure the client to use
30+
31+
The default value is: http://admin:adminadmin@localhost:8080/, you can modify it by referring to [specific instructions. ](../guide/advanced/offline-download.md#_2-qbittorrent)
32+
33+
34+
2535
### Token
2636

2737
The token that can be used to access all API.

docs/guide/advanced/github.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,4 +55,15 @@ If you want to use GitHub to log in, you first need the machine you built Alist
5555

5656
### Completely fill in the reference schematic
5757

58-
![github](/img/advanced/github.png)
58+
![github](/img/advanced/github.png)
59+
60+
61+
62+
### GitHub login Video Tutorials
63+
64+
<ArtPlayer
65+
src="https://hub.onmicrosoft.cn/public/video/weibo?uid=7821998556&cursor=4872400300415846&raw=true"
66+
poster="/img/advanced/github-login.png"
67+
/>
68+
69+
**If the video fails, you can watch it here: https://b23.tv/Fm8AkC5**

docs/guide/advanced/ipa.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,14 +32,26 @@ Recommended to use [ipa-renamer](https://github.com/Xhofe/ipa-renamer) to rename
3232

3333
- ==.ipa installation requires https and a valid certificate== , not just a package can be installed without a signature
3434

35+
:::tabs#ipa
36+
37+
@tab How to change the name of the computer version
38+
3539
<ArtPlayer
3640
src="https://hub.onmicrosoft.cn/public/video/wechat?wxv=wxv_2786278463950405640&raw=true"
3741
poster="/img/advanced/video.png"
3842
/>
3943

4044
**If the video fails, you can watch it here: https://b23.tv/oLvHHC8**
4145

46+
@tab how to change the name of the IOS 16 mobile phone
47+
48+
<ArtPlayer
49+
src="https://hub.onmicrosoft.cn/public/video/weibo?uid=7821998556&cursor=4871961534007938&raw=true"
50+
/>
51+
52+
**If the video fails, you can watch it here:https://b23.tv/GxGG8Dn**
4253

54+
:::
4355

4456

4557

docs/guide/advanced/offline-download.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,15 +47,21 @@ According to [source code] (https://github.com/alist-org/alist/blob/main/interna
4747
- **user**: admin
4848
- **password**: adminadmin
4949

50-
We fill in the above parameters into the **`qBittorrent`** client, after configuration, we go to the Alist front end to download offline (**method refer to the description at the beginning**)
50+
1. We fill in the above parameters into the **`qBittorrent`** client, after configuration, we go to the Alist front end to download offline (**method refer to the description at the beginning**)
51+
- If you are prompted after submitting the offline link: **Qbittorrent not ready**, try restarting both Alist and qBittorrent
5152

52-
- If you are prompted after submitting the offline link: **Qbittorrent not ready**, try restarting both Alist and qBittorrent
5353

54-
Default value configuration view address:
54+
2. Default value configuration view address:
5555

56-
- **https://github.com/alist-org/alist/blob/main/internal/bootstrap/data/setting.go#L159**
56+
- **https://github.com/alist-org/alist/blob/main/internal/bootstrap/data/setting.go#L159**
57+
58+
59+
- ```{ *** Value: "http://admin:adminadmin@localhost:8080/", Type: conf.TypeString, *** } ```
60+
61+
62+
3. We can also customize, instead of using the default presets
63+
- Modification location: **Alist Manage** --> **Settings** --> **Qbittorrent url** option, just follow the modification
5764

58-
- ```{ *** Value: "http://admin:adminadmin@localhost:8080/", Type: conf.TypeString, *** } ```
5965

6066
![Offline download](/img/advanced/offline-download.png)
6167

@@ -71,6 +77,10 @@ The above two methods are most likely caused by the qBittorrent software itself,
7177
- **qBittorrent** official website: **https://www.qbittorrent.org/**
7278
- **qBittorrent** GitHub: **https://github.com/c0re100/qBittorrent-Enhanced-Edition**
7379

80+
3. Because the `v2.8.3` API is used, the minimum version of qBittorrent should be `4.4.0beta2` or `4.3.8` official version
81+
4. If **qBittorrent** sets the ip where alist is located to be exempt from authentication, you can directly omit the user name and password before `@` (configured on the **qBittorrent** client side)
82+
- 3 and 4 are not mentioned in the video.
83+
7484

7585

7686
**qBittorrent** Video Tutorials

docs/guide/drivers/baidu.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ The root foler to mount, defaults to `/`, same as local storage.
4141

4242
### Add "User-Agent" usage example
4343

44-
:::: details If you don't know how to set **`"User-Agent"`** see here
44+
:::: details If you don't know how to set "User-Agent" see here
4545

4646
==The following methods are limited to Baidu super member users==
4747

docs/guide/install/reverse-proxy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ Add the reverse_proxy configuration item reverse_proxy under the Caddyfile file,
7171

7272
First create a new site, **Alist Launcher** does not matter whether it is in the site folder, and then add it as shown in the figure below.
7373

74-
- Also, if you want to use Pagoda to open **SSL(HTTPS)**, you need to add it before the reverse proxy, otherwise you cannot open SSL
74+
- ==Also, if you want to use Pagoda to open **SSL(HTTPS)**, you need to add it before the reverse proxy, otherwise you cannot open SSL==
7575
- If you have already added a reverse proxy, you can stop it first **(the one in the picture that turns on the proxy button can just turn it off)**, enable SSL and then turn on the reverse proxy
7676

7777

0 commit comments

Comments
 (0)