Skip to content

docs: add cloudreve #433

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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.
88 changes: 88 additions & 0 deletions docs/guide/drivers/cloudreve.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
---
# This is the icon of the page
icon: iconfont icon-state
# This control sidebar order
order: 256
# A page can have multiple categories
category:
- Guide
# A page can have multiple tags
tag:
- Storage
- Guide
- "Native Rroxy"
- "302"
# this page is sticky in article list
sticky: true
# this page will appear in starred articles
star: true
---
# Cloudreve V3

## Parameters

### Address

The address of the Cloudreve V3 server, such as: `https://www.example.com`. It is better to remove the slash `/` after it.

### Authentication

Cloudreve V3 supports authentication using Cookie. This means the mounting authentication methods are divided into:

1. `Username` + `Password`: Automatically uses the login interface to obtain Cookie, there might be issues with CAPTCHA.
2. `Cookie` Only: Can be temporarily used but will expire and cannot be renewed. Parameters can be found from browser requests or Local Storage.
3. [Reference](../drivers/common.html#Reference): Fill in `ref:/{mount path}` in `Remark`: Reference authentication, tokens, etc., from "Mounted Storage".

Steps to get cookie:

::: tip
Only the string following cloudreve-session= is required.
:::


![cloudreve_get_cookie](/img/drivers/cloudreve/cloudreve_get_cookie.png)


### Root Folder Path

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).

### Enable Folder Size

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.

### Custom UA

Used to customize the `User-Agent` header information used in requests. Leaving it blank will use Alist default settings.

## Upload

The supported storage policies for uploading are as follows:

- Local storage
- Slave storage
- OneDrive
- S3

Upload storage policies can be set within Cloudreve V4 web interface by entering the corresponding folder (requires the server to be Cloudreve Pro).

## **The default download method used**

```mermaid
---
title: Which download method is used by default?
---
flowchart TB
style a1 fill:#bbf,stroke:#f66,stroke-width:2px,color:#fff
style a2 fill:#ff7575,stroke:#333,stroke-width:4px
subgraph ide1 [ ]
a1
end
a1[302]:::someclass====|default|a2[user equipment]
classDef someclass fill:#f96
c1[local proxy]-.alternative.->a2[user equipment]
b1[Download proxy URL]-.alternative.->a2[user equipment]
click a1 "../drivers/common.html#webdav-policy"
click b1 "../drivers/common.html#webdav-policy"
click c1 "../drivers/common.html#webdav-policy"
```
130 changes: 130 additions & 0 deletions docs/guide/drivers/cloudreve_v4.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,130 @@
---
# This is the icon of the page
icon: iconfont icon-state
# This control sidebar order
order: 256
# A page can have multiple categories
category:
- Guide
# A page can have multiple tags
tag:
- Storage
- Guide
- "Native Rroxy"
- "302"
# this page is sticky in article list
sticky: true
# this page will appear in starred articles
star: true
---
# Cloudreve V4 / Share

## Parameter Explanation

### Address

The address of the Cloudreve V4 server, such as: `https://www.example.com`. It is better to remove the slash `/` after it.

### Authentication

Cloudreve V4 supports authentication using Token. This means the mounting authentication methods are divided into:

1. `Username` + `Password`: Automatically uses the login interface to obtain Access Token and Refresh Token, there might be issues with CAPTCHA.
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.
3. `Access Token` Only: Can be temporarily used but will expire and cannot be renewed.
4. None: Anonymous user, suitable for public sharing.
5. [Reference](../drivers/common.html#reference): Fill in `ref:/{mount path}` in `Remark`: Reference authentication, tokens, etc., from "Mounted Storage".

Steps to get tokens:

:::::tabs

@tab From Local Storage

:::note
There may be multiple sessions; please select the one you want to mount.
:::

![cloudreve_v4_token_local_storage](/img/drivers/cloudreve_v4/cloudreve_v4_token_local_storage.png)


@tab From Network

:::note
You may need to log in anew to see this request.
:::

![cloudreve_v4_token_resp](/img/drivers/cloudreve_v4/cloudreve_v4_token_resp.png)

:::::


### Root Folder Path

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).

#### Mounting My Files

Default is `cloudreve://my/`, listing user files.

#### Mounting Share

Supports mounting folder-type shares, the path should be filled as: `cloudreve://{ShareID}@share/`.

- ShareID is the parameter after `/s/` in the share link.

- 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`.

### Enable Folder Size

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.

### Enable Thumbnails

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.

### Enable Version Upload

Enable overwrite upload and keep the previous version, which consumes extra space. Disabled by default, delete the existing file before overwriting upload.

### Custom UA

Used to customize the `User-Agent` header information used in requests. Leaving it blank will use Alist default settings.

### Sorting

Supports changing the sorting parameters when requesting lists.

## Upload

The supported storage policies for uploading are as follows:

- Local storage
- Slave storage
- OneDrive
- S3

Upload storage policies can be set within Cloudreve V4 web interface by entering the corresponding folder (requires the server to be Cloudreve Pro).

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).

## **The default download method used**

```mermaid
---
title: Which download method is used by default?
---
flowchart TB
style a1 fill:#bbf,stroke:#f66,stroke-width:2px,color:#fff
style a2 fill:#ff7575,stroke:#333,stroke-width:4px
subgraph ide1 [ ]
a1
end
a1[302]:::someclass====|default|a2[user equipment]
classDef someclass fill:#f96
c1[local proxy]-.alternative.->a2[user equipment]
b1[Download proxy URL]-.alternative.->a2[user equipment]
click a1 "../drivers/common.html#webdav-policy"
click b1 "../drivers/common.html#webdav-policy"
click c1 "../drivers/common.html#webdav-policy"
```
5 changes: 4 additions & 1 deletion docs/guide/drivers/common.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,14 +54,17 @@ When there are multiple accounts, it is used for sorting, The smaller the more f

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

### **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" />
### **Reference** <Badge text="≥ 3.42.0" type="info" vertical="middle" />

Reference authentication, tokens, etc. from `Mounted Storage`, and use the same token for multiple network disks

Currently only the following network disks are supported:

- 139Yun
- AliyundriveOpen
- 189CloudPC
- 123PanShare(ref 123Pan)
- Cloudreve V3 / V4

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

Expand Down
87 changes: 87 additions & 0 deletions docs/zh/guide/drivers/cloudreve.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
---
# This is the icon of the page
icon: iconfont icon-state
# This control sidebar order
order: 256
# A page can have multiple categories
category:
- Guide
# A page can have multiple tags
tag:
- Storage
- Guide
- "本地代理"
- "302"
# this page is sticky in article list
sticky: true
# this page will appear in starred articles
star: true
---
# Cloudreve V3

## 参数说明

### 地址

Cloudreve V3 服务器的地址,如:`https://www.example.com`,最好删掉后面的斜线`/`。

### 鉴权

Cloudreve V3 使用 Cookie 进行鉴权,这意味着挂载鉴权方式分为:

1. `用户名`+`密码`:会自动使用登录接口获取 Cookie,存在验证码问题
2. 仅 `Cookie`:参数可从浏览器请求或者本地 Cookie 中找到,有效期未知
3. [引用](../drivers/common.html#引用):`备注`填写 `ref:/{挂载路径}`,从 `已挂载的存储` 中引用认证、令牌等

Cookie 获取方法:

::: tip
仅需要 `cloudreve-session=` 后面一串即可。
:::

![cloudreve_get_cookie](/img/drivers/cloudreve/cloudreve_get_cookie.png)

### 根文件夹路径

默认为:`/`,可从网页链接的 `?path=` 中获取。获取到的参数可能需要 [URL 解码](https://www.bing.com/search?q=URL+%E8%A7%A3%E7%A0%81)。

### 启用缩略图和文件夹大小

让 Cloudreve V3 服务端统计每个文件夹的大小并为每个文件生成略缩图,启用可能会造成服务端报错、运行缓慢,默认禁用。

### 自定义 UA

用于自定义请求使用的 `User-Agent` 头部信息。留空为 Alist 默认。

## 上传

支持上传到的存储策略如下:

- 本机存储
- 从机存储
- OneDrive
- S3

上传的存储策略请在 Cloudreve V3 网页端进入相应文件夹中进行设置(需要服务端为 Cloudreve Pro)。

## **默认使用的下载方式**

```mermaid
---
title: 默认使用的哪种下载方式?
---
flowchart TB
style a1 fill:#bbf,stroke:#f66,stroke-width:2px,color:#fff
style a2 fill:#ff7575,stroke:#333,stroke-width:4px
subgraph ide1 [ ]
a1
end
a1[302]:::someclass====|默认|a2[用户设备]
classDef someclass fill:#f96
c1[本机代理]-.备选.->a2[用户设备]
b1[代理URL]-.备选.->a2[用户设备]
click a1 "../drivers/common.html#webdav-策略"
click b1 "../drivers/common.html#webdav-策略"
click c1 "../drivers/common.html#webdav-策略"
```

Loading