Skip to content

Commit 265c3ae

Browse files
xrgzsxrgzs
authored
docs: add cloudreve (#433)
* docs: add cloudreve * docs: add url decode note * docs: add version upload feature to Cloudreve V4 guide * docs: add cloudreve address param * docs: add cloudreve v4 password-protected shares
1 parent 04ccb8c commit 265c3ae

File tree

9 files changed

+446
-2
lines changed

9 files changed

+446
-2
lines changed

‎docs/.vuepress/public/img/drivers/cloudreve/cloudreve_get_cookie.png

161 KB
Loading

‎docs/.vuepress/public/img/drivers/cloudreve_v4/cloudreve_v4_token_local_storage.png

120 KB
Loading

‎docs/.vuepress/public/img/drivers/cloudreve_v4/cloudreve_v4_token_resp.png

70.1 KB
Loading

‎docs/guide/drivers/cloudreve.md

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
---
2+
# This is the icon of the page
3+
icon: iconfont icon-state
4+
# This control sidebar order
5+
order: 256
6+
# A page can have multiple categories
7+
category:
8+
- Guide
9+
# A page can have multiple tags
10+
tag:
11+
- Storage
12+
- Guide
13+
- "Native Rroxy"
14+
- "302"
15+
# this page is sticky in article list
16+
sticky: true
17+
# this page will appear in starred articles
18+
star: true
19+
---
20+
# Cloudreve V3
21+
22+
## Parameters
23+
24+
### Address
25+
26+
The address of the Cloudreve V3 server, such as: `https://www.example.com`. It is better to remove the slash `/` after it.
27+
28+
### Authentication
29+
30+
Cloudreve V3 supports authentication using Cookie. This means the mounting authentication methods are divided into:
31+
32+
1. `Username` + `Password`: Automatically uses the login interface to obtain Cookie, there might be issues with CAPTCHA.
33+
2. `Cookie` Only: Can be temporarily used but will expire and cannot be renewed. Parameters can be found from browser requests or Local Storage.
34+
3. [Reference](../drivers/common.html#Reference): Fill in `ref:/{mount path}` in `Remark`: Reference authentication, tokens, etc., from "Mounted Storage".
35+
36+
Steps to get cookie:
37+
38+
::: tip
39+
Only the string following cloudreve-session= is required.
40+
:::
41+
42+
43+
![cloudreve_get_cookie](/img/drivers/cloudreve/cloudreve_get_cookie.png)
44+
45+
46+
### Root Folder Path
47+
48+
Default is `/`, which can be obtained from the `?path=` in the web link. The obtained parameters may need to be [URL decoded](https://www.google.com/search?q=URL+decode).
49+
50+
### Enable Folder Size
51+
52+
Enable Cloudreve V3 server to calculate the size of each folder and generate thumbnails for each file. Enabling this feature may cause server errors or slow performance, and it is `disabled` by default.
53+
54+
### Custom UA
55+
56+
Used to customize the `User-Agent` header information used in requests. Leaving it blank will use Alist default settings.
57+
58+
## Upload
59+
60+
The supported storage policies for uploading are as follows:
61+
62+
- Local storage
63+
- Slave storage
64+
- OneDrive
65+
- S3
66+
67+
Upload storage policies can be set within Cloudreve V4 web interface by entering the corresponding folder (requires the server to be Cloudreve Pro).
68+
69+
## **The default download method used**
70+
71+
```mermaid
72+
---
73+
title: Which download method is used by default?
74+
---
75+
flowchart TB
76+
style a1 fill:#bbf,stroke:#f66,stroke-width:2px,color:#fff
77+
style a2 fill:#ff7575,stroke:#333,stroke-width:4px
78+
subgraph ide1 [ ]
79+
a1
80+
end
81+
a1[302]:::someclass====|default|a2[user equipment]
82+
classDef someclass fill:#f96
83+
c1[local proxy]-.alternative.->a2[user equipment]
84+
b1[Download proxy URL]-.alternative.->a2[user equipment]
85+
click a1 "../drivers/common.html#webdav-policy"
86+
click b1 "../drivers/common.html#webdav-policy"
87+
click c1 "../drivers/common.html#webdav-policy"
88+
```

‎docs/guide/drivers/cloudreve_v4.md

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
---
2+
# This is the icon of the page
3+
icon: iconfont icon-state
4+
# This control sidebar order
5+
order: 256
6+
# A page can have multiple categories
7+
category:
8+
- Guide
9+
# A page can have multiple tags
10+
tag:
11+
- Storage
12+
- Guide
13+
- "Native Rroxy"
14+
- "302"
15+
# this page is sticky in article list
16+
sticky: true
17+
# this page will appear in starred articles
18+
star: true
19+
---
20+
# Cloudreve V4 / Share
21+
22+
## Parameter Explanation
23+
24+
### Address
25+
26+
The address of the Cloudreve V4 server, such as: `https://www.example.com`. It is better to remove the slash `/` after it.
27+
28+
### Authentication
29+
30+
Cloudreve V4 supports authentication using Token. This means the mounting authentication methods are divided into:
31+
32+
1. `Username` + `Password`: Automatically uses the login interface to obtain Access Token and Refresh Token, there might be issues with CAPTCHA.
33+
2. `Refresh Token` Only: Automatically uses the refresh interface to renew Access Token and Refresh Token, parameters can be found from browser requests or Local Storage.
34+
3. `Access Token` Only: Can be temporarily used but will expire and cannot be renewed.
35+
4. None: Anonymous user, suitable for public sharing.
36+
5. [Reference](../drivers/common.html#reference): Fill in `ref:/{mount path}` in `Remark`: Reference authentication, tokens, etc., from "Mounted Storage".
37+
38+
Steps to get tokens:
39+
40+
:::::tabs
41+
42+
@tab From Local Storage
43+
44+
:::note
45+
There may be multiple sessions; please select the one you want to mount.
46+
:::
47+
48+
![cloudreve_v4_token_local_storage](/img/drivers/cloudreve_v4/cloudreve_v4_token_local_storage.png)
49+
50+
51+
@tab From Network
52+
53+
:::note
54+
You may need to log in anew to see this request.
55+
:::
56+
57+
![cloudreve_v4_token_resp](/img/drivers/cloudreve_v4/cloudreve_v4_token_resp.png)
58+
59+
:::::
60+
61+
62+
### Root Folder Path
63+
64+
Cloudreve V4 uses a custom URI as the path, which can be obtained from the `?path=` in the web link. The obtained parameters may need to be [URL decoded](https://www.google.com/search?q=URL+decode).
65+
66+
#### Mounting My Files
67+
68+
Default is `cloudreve://my/`, listing user files.
69+
70+
#### Mounting Share
71+
72+
Supports mounting folder-type shares, the path should be filled as: `cloudreve://{ShareID}@share/`.
73+
74+
- ShareID is the parameter after `/s/` in the share link.
75+
76+
- Currently, Cloudreve V4 does not support creating password-protected shares. However, if the data is migrated from V3, the previously created sharing password will be retained. The URI of the share link with the password (`/s/{shareID}/{sharePassword}`) is `cloudreve://{shareID}:{sharePassword}@share`.
77+
78+
### Enable Folder Size
79+
80+
Enable Cloudreve V4 server to calculate the size of each folder. Enabling this feature may cause server errors or slow performance, and it is `disabled` by default.
81+
82+
### Enable Thumbnails
83+
84+
Enable Cloudreve V4 server to generate thumbnails for each file. Enabling this feature may cause server errors or slow performance, and it is `disabled` by default.
85+
86+
### Enable Version Upload
87+
88+
Enable overwrite upload and keep the previous version, which consumes extra space. Disabled by default, delete the existing file before overwriting upload.
89+
90+
### Custom UA
91+
92+
Used to customize the `User-Agent` header information used in requests. Leaving it blank will use Alist default settings.
93+
94+
### Sorting
95+
96+
Supports changing the sorting parameters when requesting lists.
97+
98+
## Upload
99+
100+
The supported storage policies for uploading are as follows:
101+
102+
- Local storage
103+
- Slave storage
104+
- OneDrive
105+
- S3
106+
107+
Upload storage policies can be set within Cloudreve V4 web interface by entering the corresponding folder (requires the server to be Cloudreve Pro).
108+
109+
If upload permissions are enabled for shares, uploads are supported. It requires the server to check "Enhance anonymous user permissions" for the user group (requires the server to be Cloudreve Pro).
110+
111+
## **The default download method used**
112+
113+
```mermaid
114+
---
115+
title: Which download method is used by default?
116+
---
117+
flowchart TB
118+
style a1 fill:#bbf,stroke:#f66,stroke-width:2px,color:#fff
119+
style a2 fill:#ff7575,stroke:#333,stroke-width:4px
120+
subgraph ide1 [ ]
121+
a1
122+
end
123+
a1[302]:::someclass====|default|a2[user equipment]
124+
classDef someclass fill:#f96
125+
c1[local proxy]-.alternative.->a2[user equipment]
126+
b1[Download proxy URL]-.alternative.->a2[user equipment]
127+
click a1 "../drivers/common.html#webdav-policy"
128+
click b1 "../drivers/common.html#webdav-policy"
129+
click c1 "../drivers/common.html#webdav-policy"
130+
```

‎docs/guide/drivers/common.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,14 +54,17 @@ When there are multiple accounts, it is used for sorting, The smaller the more f
5454

5555
Anything you want to fill in, which is just for reminding you what this storage is
5656

57-
### **Reference authentication, tokens, etc. from `Mounted Storage`, and use the same token for multiple network disks** <Badge text="≥ 3.42.0" type="info" vertical="middle" />
57+
### **Reference** <Badge text="≥ 3.42.0" type="info" vertical="middle" />
58+
59+
Reference authentication, tokens, etc. from `Mounted Storage`, and use the same token for multiple network disks
5860

5961
Currently only the following network disks are supported:
6062

6163
- 139Yun
6264
- AliyundriveOpen
6365
- 189CloudPC
6466
- 123PanShare（ref 123Pan）
67+
- Cloudreve V3 / V4
6568

6669
In the storage settings, set the first line of `Remark` to: **ref:/mount path**
6770

‎docs/zh/guide/drivers/cloudreve.md

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
---
2+
# This is the icon of the page
3+
icon: iconfont icon-state
4+
# This control sidebar order
5+
order: 256
6+
# A page can have multiple categories
7+
category:
8+
- Guide
9+
# A page can have multiple tags
10+
tag:
11+
- Storage
12+
- Guide
13+
- "本地代理"
14+
- "302"
15+
# this page is sticky in article list
16+
sticky: true
17+
# this page will appear in starred articles
18+
star: true
19+
---
20+
# Cloudreve V3
21+
22+
## 参数说明
23+
24+
### 地址
25+
26+
Cloudreve V3 服务器的地址，如：`https://www.example.com`，最好删掉后面的斜线`/`。
27+
28+
### 鉴权
29+
30+
Cloudreve V3 使用 Cookie 进行鉴权，这意味着挂载鉴权方式分为：
31+
32+
1. `用户名`+`密码`：会自动使用登录接口获取 Cookie，存在验证码问题
33+
2. 仅 `Cookie`：参数可从浏览器请求或者本地 Cookie 中找到，有效期未知
34+
3. [引用](../drivers/common.html#引用)：`备注`填写 `ref:/{挂载路径}`，从 `已挂载的存储` 中引用认证、令牌等
35+
36+
Cookie 获取方法：
37+
38+
::: tip
39+
仅需要 `cloudreve-session=` 后面一串即可。
40+
:::
41+
42+
![cloudreve_get_cookie](/img/drivers/cloudreve/cloudreve_get_cookie.png)
43+
44+
### 根文件夹路径
45+
46+
默认为：`/`，可从网页链接的 `?path=` 中获取。获取到的参数可能需要 [URL 解码](https://www.bing.com/search?q=URL+%E8%A7%A3%E7%A0%81)。
47+
48+
### 启用缩略图和文件夹大小
49+
50+
让 Cloudreve V3 服务端统计每个文件夹的大小并为每个文件生成略缩图，启用可能会造成服务端报错、运行缓慢，默认禁用。
51+
52+
### 自定义 UA
53+
54+
用于自定义请求使用的 `User-Agent` 头部信息。留空为 Alist 默认。
55+
56+
## 上传
57+
58+
支持上传到的存储策略如下：
59+
60+
- 本机存储
61+
- 从机存储
62+
- OneDrive
63+
- S3
64+
65+
上传的存储策略请在 Cloudreve V3 网页端进入相应文件夹中进行设置（需要服务端为 Cloudreve Pro）。
66+
67+
## **默认使用的下载方式**
68+
69+
```mermaid
70+
---
71+
title: 默认使用的哪种下载方式？
72+
---
73+
flowchart TB
74+
style a1 fill:#bbf,stroke:#f66,stroke-width:2px,color:#fff
75+
style a2 fill:#ff7575,stroke:#333,stroke-width:4px
76+
subgraph ide1 [ ]
77+
a1
78+
end
79+
a1[302]:::someclass====|默认|a2[用户设备]
80+
classDef someclass fill:#f96
81+
c1[本机代理]-.备选.->a2[用户设备]
82+
b1[代理URL]-.备选.->a2[用户设备]
83+
click a1 "../drivers/common.html#webdav-策略"
84+
click b1 "../drivers/common.html#webdav-策略"
85+
click c1 "../drivers/common.html#webdav-策略"
86+
```
87+

0 commit comments

Comments
 (0)