From d14b3af588be2989adc4390d5be7a6587ed05233 Mon Sep 17 00:00:00 2001
From: lk29 <12291632+lk29@users.noreply.github.com>
Date: Wed, 1 Mar 2023 02:37:42 +0500
Subject: [PATCH 01/27] add README.ENG.md

---
 README.ENG.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)
 create mode 100644 README.ENG.md

diff --git a/README.ENG.md b/README.ENG.md
new file mode 100644
index 0000000..c028259
--- /dev/null
+++ b/README.ENG.md
@@ -0,0 +1,28 @@
+---
+description: At present, the document is still being improved!
+---
+
+# welcome
+
+## What is Cloudreve?
+
+Cloudreve allows you to quickly build a public and private network disk system. Cloudreve supports different cloud storage platforms at the bottom layer, and users do not need to care about the physical storage method in actual use. You can use Cloudreve to build a personal network disk, a file sharing system, or a public cloud system for large and small groups.
+
+## feedback
+
+If you find any defects during use, or have new requirements proposals, please check the previous documents, [issue](https://github.com/cloudreve/Cloudreve/issues), [discussion community]( https://forum.cloudreve.org/) mentioned.
+
+If you suspect a bug or a feature proposal, please create an [issue](https://github.com/cloudreve/Cloudreve/issues) to track the problem;
+
+If you have questions about daily use, please go to [Discussion Community](https://forum.cloudreve.org/) to create a new topic and describe the problem you encounter in detail.
+
+## connect
+
+You can join the following groups to communicate with other users who are using Cloudreve:
+
+* [Telegram group](https://t.me/cloudreve\_official)
+* [QQ group](https://qm.qq.com/cgi-bin/qm/qr?k=pjwJ2pi\_V4LN\_JdPZk\_HMwJv\_x8zuCPX\&jump\_from=webapi)
+
+Or contact the developer:
+
+&#x20;Email: [abslant.liu@gmail.com](mailto:abslant.liu@gmail.com)

From 038a10f274575bd71327135fd024e38df1ebff75 Mon Sep 17 00:00:00 2001
From: lk29 <12291632+lk29@users.noreply.github.com>
Date: Wed, 1 Mar 2023 02:41:23 +0500
Subject: [PATCH 02/27] add link README.ENG.md

---
 README.md | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/README.md b/README.md
index 5035c23..4bd9e8f 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,8 @@
 description: 目前文档仍在陆续完善中！
 ---
 
+![ENGLISH version](README.ENG.md)
+
 # 欢迎
 
 ## Cloudreve 是什么？

From 8273b415ac41fcd97c2a14e4cb8f4b1166e29a17 Mon Sep 17 00:00:00 2001
From: lk29 <12291632+lk29@users.noreply.github.com>
Date: Wed, 1 Mar 2023 02:57:09 +0500
Subject: [PATCH 03/27] Create  db-script.ENG.md

---
 manage/db-script.ENG.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)
 create mode 100644 manage/db-script.ENG.md

diff --git a/manage/db-script.ENG.md b/manage/db-script.ENG.md
new file mode 100644
index 0000000..ee0f21a
--- /dev/null
+++ b/manage/db-script.ENG.md
@@ -0,0 +1,23 @@
+# database script
+
+Cloudreve has built-in some commonly used database scripts, which can be used for daily maintenance, version upgrade and other operations. You can add the command line parameter `--database-script <script name>` to execute individual scripts at startup.
+
+### Calibrate user capacity
+
+If the user's used space is inconsistent with the actual one due to system failure or manual operation of database records, you can run the following database script, and Cloudreve will recalibrate the capacity usage of all registered users.
+
+```text
+./cloudreve --database-script CalibrateUserStorage
+```
+
+### Upgrade Donation Edition
+
+{% page-ref page="update/update-from-os.md" %}
+
+### Reset admin password
+
+The following database script can reset the password of the initial administrator (that is, the user with UID 1). The new password will be output in the command line log, please save it.
+
+```text
+./cloudreve --database-script ResetAdminPassword
+```

From 620326f5d9a7e38c69c4ec8339fdb426d26fb5ef Mon Sep 17 00:00:00 2001
From: lk29 <12291632+lk29@users.noreply.github.com>
Date: Wed, 1 Mar 2023 02:58:27 +0500
Subject: [PATCH 04/27] Create README.ENG.md

---
 manage/update/README.ENG.md | 1 +
 1 file changed, 1 insertion(+)
 create mode 100644 manage/update/README.ENG.md

diff --git a/manage/update/README.ENG.md b/manage/update/README.ENG.md
new file mode 100644
index 0000000..cf65b81
--- /dev/null
+++ b/manage/update/README.ENG.md
@@ -0,0 +1 @@
+# upgrade

From 99751019403e86733f6e59dd27f28d2478b95eaf Mon Sep 17 00:00:00 2001
From: lk29 <12291632+lk29@users.noreply.github.com>
Date: Wed, 1 Mar 2023 02:59:33 +0500
Subject: [PATCH 05/27] Create upgrade.ENG.md

---
 manage/update/upgrade.ENG.md | 61 ++++++++++++++++++++++++++++++++++++
 1 file changed, 61 insertions(+)
 create mode 100644 manage/update/upgrade.ENG.md

diff --git a/manage/update/upgrade.ENG.md b/manage/update/upgrade.ENG.md
new file mode 100644
index 0000000..39b6972
--- /dev/null
+++ b/manage/update/upgrade.ENG.md
@@ -0,0 +1,61 @@
+# Upgrade from 2.x.x
+
+Due to large changes in the data table structure, upgrading from V2 to V3 requires manual execution of the database upgrade assistant. Please be sure to backup the V2 website data before upgrading to avoid data loss.
+
+## Upgrade Compatibility
+
+After upgrading from V2 to V3, the following data will be lost:
+
+* Offline download records
+* Timing task setting
+* User two-step verification settings
+
+## Check items before upgrading
+
+Before upgrading, please check carefully according to the following list to ensure that all items are met and known before performing subsequent upgrade operations.
+
+* Make sure that the specific version number of Cloudreve V2 is `2.0.0-Alpha1`, you can see the version number in Admin Panel - About;
+* The V3 version does not support the S3 storage policy for the time being. If you are using the S3 storage policy, please delete the storage policy and its subordinate files after backing up or transferring the files;
+* If you are using a remote storage policy, please delete the storage policy and its subordinate files after backing up or transferring the files, because upgrading the remote storage policy is not currently supported;
+* Back up V2 website files and databases;
+* If you are using OneDrive task queue, please stop it first;
+* Stop the set Crontab timing task;
+* You already know how to build the V3 version, and the process of configuring and using MySQL, which will be used later, and will not be described in this article.
+
+## Start upgrading
+
+### Build the V3 version
+
+Refer to the following page to start V3 under the V2 version Cloudreve website directory:
+
+{% page-ref page="../../getting-started/install.md" %}
+
+Refer to the following page to specify the V3 version to use the MySQL database in the configuration file. Please pay attention to specifying a database with a different V2 version, or use the data table prefix to distinguish it from the V2 version:
+
+{% page-ref page="../../getting-started/config.md" %}
+
+Restart V3 to let Cloudreve initialize the V3 version of the data table. After the initialization is complete, please do not perform any operations.
+
+### Run the upgrade assistant
+
+Download `upgrade_from_2.0.0-Alpha1.zip` from [Release 3.0.0](https://github.com/cloudreve/Cloudreve/releases/tag/3.0.0) page \(Pro users please download `upgrade_from_2.0.0 -Alpha1-pro.zip`\), decompress and cover to V2 root directory.
+
+On the command line, switch the working directory to the V2 root directory and start the upgrade assistant:
+
+```bash
+# Switch to the V2 root directory
+cd /home/www/cloudreve.org
+
+# start upgrading
+php upgrade run
+```
+
+According to the prompt, enter the database information of the V3 version, and the database upgrade will start after the input is completed.
+
+### Subsequent operations
+
+After the upgrade assistant is executed, you can use the V3 version. Under the V2 website directory, please pay attention to keep the `public` directory. There are data such as user avatars and local policy files of the V2 version in this directory, which will still be used by the V3 version. Other files can be deleted as appropriate.
+
+### Operation after upgrade failure
+
+If there is an exception during the upgrade process and you need to try again, please restore the backup V2 version database, delete the V3 version data table and restart the V3 main program, and then start the upgrade assistant. Thumbnail and avatar file upgrade error warnings may appear during the upgrade process again, which can be ignored.

From 9aa7179f6f1eb35dc2057c6aa38b2a51df80a546 Mon Sep 17 00:00:00 2001
From: lk29 <12291632+lk29@users.noreply.github.com>
Date: Wed, 1 Mar 2023 03:00:16 +0500
Subject: [PATCH 06/27] Create update-from-os.ENG.md

---
 manage/update/update-from-os.ENG.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)
 create mode 100644 manage/update/update-from-os.ENG.md

diff --git a/manage/update/update-from-os.ENG.md b/manage/update/update-from-os.ENG.md
new file mode 100644
index 0000000..8cd23ba
--- /dev/null
+++ b/manage/update/update-from-os.ENG.md
@@ -0,0 +1,25 @@
+# Upgrade to the donation version
+
+If you previously used the community edition of Cloudreve, after obtaining the donation edition, you can upgrade to the donation edition while preserving your data.
+
+### Replace the main program
+
+Back up all data, upload and replace the donor moderator program and authorization files to the original community version directory.
+
+### Execute the upgrade script
+
+Using Cloudreve's command-line arguments, run the upgrade database script:
+
+{% tabs %}
+{% tab title="Linux" %}
+```
+./cloudreve --database-script OSSToPro
+```
+{% endtab %}
+
+{% tab title="Windows" %}
+```
+cloudreve.exe --database-script OSSToPro
+```
+{% endtab %}
+{% endtabs %}

From 0185ae7fda52214a73843aa49e40284f41ebc1ec Mon Sep 17 00:00:00 2001
From: lk29 <12291632+lk29@users.noreply.github.com>
Date: Wed, 1 Mar 2023 03:01:09 +0500
Subject: [PATCH 07/27] Create cong-3.x.x-sheng-ji.ENG.md

---
 manage/update/cong-3.x.x-sheng-ji.ENG.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)
 create mode 100644 manage/update/cong-3.x.x-sheng-ji.ENG.md

diff --git a/manage/update/cong-3.x.x-sheng-ji.ENG.md b/manage/update/cong-3.x.x-sheng-ji.ENG.md
new file mode 100644
index 0000000..5f2e0bd
--- /dev/null
+++ b/manage/update/cong-3.x.x-sheng-ji.ENG.md
@@ -0,0 +1,15 @@
+# Upgrade from 3.x.x
+
+The upgrade steps in the V3 version are relatively simple, and the overall process is as follows:
+
+1. Back up the database;
+2. Download or build the latest version of Cloudreve;
+3. Stop the running Cloudreve;
+4. Replace the old version of Cloudreve main program with the new version;
+5. Start Cloudreve;
+6. Clear the browser cache;
+7. If you are using Cloudreve slave mode, please also replace the Cloudreve of the slave node with the same version.
+
+{% hint style="info" %}
+If you used self-built front-end static resource files in the old version, please rebuild with the corresponding front-end warehouse code of the new version.
+{% endhint %}

From 979a6e0c7a8f9d074b34b7cb5fafa0a323276b51 Mon Sep 17 00:00:00 2001
From: lk29 <12291632+lk29@users.noreply.github.com>
Date: Wed, 1 Mar 2023 03:02:23 +0500
Subject: [PATCH 08/27] Create SUMMARY.ENG.md

---
 SUMMARY.ENG.md | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)
 create mode 100644 SUMMARY.ENG.md

diff --git a/SUMMARY.ENG.md b/SUMMARY.ENG.md
new file mode 100644
index 0000000..1f00c6a
--- /dev/null
+++ b/SUMMARY.ENG.md
@@ -0,0 +1,31 @@
+# Table of contents
+
+* [Welcome](README.md)
+
+## Getting Started <a href="#getting-started" id="getting-started"></a>
+
+* [Quick start](getting-started/install.md)
+* [configuration file](getting-started/config.md)
+* [Build](getting-started/build.md)
+
+## Use <a href="#use" id="use"></a>
+
+* [Storage Policy](use/policy/README.md)
+   * [Compare](use/policy/compare.md)
+   * [S3 compatible](use/policy/s3.md)
+* [WebDAV](use/webdav.md)
+* [Offline download](use/aria2.md)
+* [Custom front end](use/zi-ding-yi-qian-duan.md)
+* [Extended Documentation Preview/Edit](use/wopi.md)
+* [Contribution version related](use/pro/README.md)
+   * [Introduction](use/pro/jie-shao.md)
+   * [iOS client bulk authorization](use/pro/vo-l.md)
+   * [Custom payment channel](use/pro/pay.md)
+
+## Maintain <a href="#manage" id="manage"></a>
+
+* [Database script](manage/db-script.md)
+* [Update](manage/update/README.md)
+   * [upgrade from 3.x.x](manage/update/cong-3.x.x-sheng-ji.md)
+   * [upgrade from 2.x.x](manage/update/upgrade.md)
+   * [Upgrade to Contribution Version](manage/update/update-from-os.md)

From 6de2ab2e88de9ea3ccb6d9223e8a58312a9d41e3 Mon Sep 17 00:00:00 2001
From: lk29 <12291632+lk29@users.noreply.github.com>
Date: Wed, 1 Mar 2023 03:03:24 +0500
Subject: [PATCH 09/27] Update SUMMARY.ENG.md

---
 SUMMARY.ENG.md | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/SUMMARY.ENG.md b/SUMMARY.ENG.md
index 1f00c6a..56bae20 100644
--- a/SUMMARY.ENG.md
+++ b/SUMMARY.ENG.md
@@ -24,8 +24,8 @@
 
 ## Maintain <a href="#manage" id="manage"></a>
 
-* [Database script](manage/db-script.md)
-* [Update](manage/update/README.md)
-   * [upgrade from 3.x.x](manage/update/cong-3.x.x-sheng-ji.md)
-   * [upgrade from 2.x.x](manage/update/upgrade.md)
-   * [Upgrade to Contribution Version](manage/update/update-from-os.md)
+* [Database script](manage/db-script.ENG.md)
+* [Update](manage/update/README.ENG.md)
+   * [upgrade from 3.x.x](manage/update/cong-3.x.x-sheng-ji.ENG.md)
+   * [upgrade from 2.x.x](manage/update/upgrade.ENG.md)
+   * [Upgrade to Contribution Version](manage/update/update-from-os.ENG.md)

From fa6d8d918221bc0365fcbf6bd17e831d8a190d6c Mon Sep 17 00:00:00 2001
From: lk29 <12291632+lk29@users.noreply.github.com>
Date: Wed, 1 Mar 2023 03:04:14 +0500
Subject: [PATCH 10/27] Update SUMMARY.ENG.md

---
 SUMMARY.ENG.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/SUMMARY.ENG.md b/SUMMARY.ENG.md
index 56bae20..fe97d06 100644
--- a/SUMMARY.ENG.md
+++ b/SUMMARY.ENG.md
@@ -1,6 +1,6 @@
 # Table of contents
 
-* [Welcome](README.md)
+* [Welcome](README.ENG.md)
 
 ## Getting Started <a href="#getting-started" id="getting-started"></a>
 

From 3a8828b8282d23cfed2b55614fa3752a15cccb19 Mon Sep 17 00:00:00 2001
From: lk29 <12291632+lk29@users.noreply.github.com>
Date: Wed, 1 Mar 2023 03:05:50 +0500
Subject: [PATCH 11/27] Create zi-ding-yi-qian-duan.ENG.md

---
 use/zi-ding-yi-qian-duan.ENG.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)
 create mode 100644 use/zi-ding-yi-qian-duan.ENG.md

diff --git a/use/zi-ding-yi-qian-duan.ENG.md b/use/zi-ding-yi-qian-duan.ENG.md
new file mode 100644
index 0000000..d5debc0
--- /dev/null
+++ b/use/zi-ding-yi-qian-duan.ENG.md
@@ -0,0 +1,19 @@
+# Custom front end
+
+By default, Cloudreve will use built-in static resource files, including HTML documents, JS scripts, CSS, image resources, etc. If you need to use your own personalized and modified static resources, please rename the `build` directory compiled by [front-end warehouse](https://github.com/cloudreve/frontend) to `statics` and place it in Cloudreve In the same level directory, it will take effect after restarting Cloudreve.
+
+For the construction process of the front-end warehouse, please refer to the following chapters:
+
+{% page-ref page="../getting-started/build.md" %}
+
+{% hint style="warning" %}
+Please use the same version of the front-end warehouse as the main program of Cloudreve to build. You can find the corresponding version of the front-end warehouse in the `assets` submodule of the main Cloudreve warehouse you are using.
+
+The front-end resources of the Pro version and the community version cannot be used interchangeably.
+{% endhint %}
+
+You can add the `eject` command line parameter when starting Cloudreve to extract the built-in static resources to the `statics` directory:
+
+```bash
+./cloudreve -eject
+```

From a21936b4d60de3726f11c65bf05d2d7af92f31ee Mon Sep 17 00:00:00 2001
From: lk29 <12291632+lk29@users.noreply.github.com>
Date: Wed, 1 Mar 2023 03:08:47 +0500
Subject: [PATCH 12/27] Create wopi.ENG.md

---
 use/wopi.ENG.md | 86 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 86 insertions(+)
 create mode 100644 use/wopi.ENG.md

diff --git a/use/wopi.ENG.md b/use/wopi.ENG.md
new file mode 100644
index 0000000..fb7ea2c
--- /dev/null
+++ b/use/wopi.ENG.md
@@ -0,0 +1,86 @@
+# Extended document preview/editing
+
+Cloudreve automatically selects the previewer by the file's extension. Cloudreve has built-in previewers for multiple file formats, including video, audio, code, text, Office documents, and more. Among them, the Office document previewer provides high scalability. You can change the default document preview service address in Background - Preferences - Image and Preview - File Preview. You can also replace the Office document previewer with a more powerful preview/editor by enabling WOPI integration, and define the file extensions that can be previewed/edited. This article will introduce the deployment and docking methods of three services that support the WOPI protocol. You can also extend Cloudreve's preview editing capabilities (not limited to Office documents) by implementing your own WOPI client.
+
+## Collabora Online (LibreOffice Online)
+
+Deploy Collabora Online using Docker ([Official Documentation](https://sdk.collaboraonline.com/docs/installation/CODE\_Docker\_image.html#code-docker-image)):
+
+```sh
+docker pull collaboration/code
+
+docker run -t -d -p 127.0.0.1:9980:9980 \
+            -e "aliasgroup1=<Cloudreve address allowed to use this service, including explicit port>" \
+            -e "username=<panel administrator username>" \
+            -e "password=<panel administrator password>" \
+            --name code --restart always collaborate/code
+```
+
+Take the official demo site as an example:
+
+```sh
+docker run -t -d -p 127.0.0.1:9980:9980 \
+            -e "aliasgroup1=https://demo.cloudreve.org:443" \
+            -e "username=<panel administrator username>" \
+            -e "password=<panel administrator password>" \
+            --name code --restart always collaborate/code
+```
+
+After the Container starts, configure Nginx or other web server reverse proxy `https://127.0.0.1:9980`, please refer to [Proxy settings](https://sdk.collaboraonline.com/docs/installation/Proxy\_settings. html), to ensure that the reversed service can be accessed by your end users, you can manually visit `<your service host>/hosting/discovery` to confirm whether the expected XML response is returned.
+
+Enable `Use WOPI` in Background - Parameter Settings - Image and Preview - File Preview - WOPI Client and fill in `<your service host>/hosting/discovery` in `WOPI Discovery Endpoint`. After saving, you can test document preview and editing in the foreground:
+
+<figure><img src="../.gitbook/assets/screenshot 2023-02-10 11.17.52.png" alt=""><figcaption></figcaption></figure>
+
+##OnlyOffice
+
+OnlyOffice supports the WOPI protocol after version 6.4, please refer to the official documentation to deploy your [OnlyOffice](https://helpcenter.onlyoffice.com/) instance. It is recommended to use [Docker-DocumentServer](https://github.com/ONLYOFFICE/Docker-DocumentServer) for quick deployment.
+
+Refer to [Official Documentation](https://helpcenter.onlyoffice.com/installation/docs-developer-configuring.aspx#WOPI) to configure OnlyOffice to enable WOPI function. If using Docker, it can be enabled by specifying `WOPI_ENABLED` as `true` when creating the Contianer:
+
+```sh
+docker run -i -t -d -p 8080:80 -e WOPI_ENABLED=true onlyoffice/documentserver
+```
+
+You can manually visit `<your OnlyOffice host>/hosting/discovery` to confirm that the expected XML response is returned.
+
+Enable `Use WOPI` in Background - Parameter Settings - Image and Preview - File Preview - WOPI Client and fill in `<your service host>/hosting/discovery` in `WOPI Discovery Endpoint`. After saving, you can test document preview and editing in the foreground:
+
+<figure><img src="../.gitbook/assets/screenshot 2023-02-10 11.49.56.png" alt=""><figcaption></figcaption></figure>
+
+{% hint style="warning" %}
+OnlyOffice does not support filtering the source of WOPI requests. If you have public use requirements, please check whether the `wopisrc` parameter in the preview page request is the expected Cloudreve site through an external application firewall.
+{% endhint %}
+
+## Office Online Server (On-Prem)
+
+[Office Online Server](https://learn.microsoft.com/en-us/officeonlineserver/office-online-server) is a privately deployable Office online document service launched by Microsoft. Please refer to [Official Documentation](https://learn.microsoft.com/en-us/officeonlineserver/deploy-office-online-server) to deploy on your Windows Server.
+
+You can manually visit `<your OnlyOffice host>/hosting/discovery` to confirm that the expected XML response is returned.
+
+Enable `Use WOPI` in Background - Parameter Settings - Image and Preview - File Preview - WOPI Client and fill in `<your service host>/hosting/discovery` in `WOPI Discovery Endpoint`. After saving, you can test document preview and editing in the foreground:
+
+<figure><img src="../.gitbook/assets/IMG_8653 (1).PNG" alt=""><figcaption></figcaption></figure>
+
+{% hint style="warning" %}
+Office Online Server does not support filtering the source of WOPI requests. If you have public use requirements, please check whether the `wopisrc` parameter in the preview page request is the expected Cloudreve site through an external application firewall.
+{% endhint %}
+
+## WOPI protocol
+
+The Web Application Open Platform Interface (WOPI) protocol is a protocol for integrating web document editors, which you can find in [Microsoft's documentation](https://learn.microsoft.com/en-us/microsoft-365/cloud -storage-partner-program/online/) to read the detailed protocol definition. Cloudreve can be connected to the document processing service that implements the WOPI protocol to expand the existing document preview and editing capabilities.
+
+### Compatibility
+
+Cloudreve's implementation of WOPI REST methods is shown in the table below:
+
+| Method          | Support                         |
+| --------------- | -----------                     |
+| CheckFileInfo   | ✅                              |
+| GetFile         | ✅                              |
+| Lock            | ⚠️ (callable but has no effect) |
+| RefreshLock     | ⚠️ (callable but has no effect) |
+| Unlock          | ⚠️ (callable but has no effect) |
+| PutFile         | ✅                              |
+| PutRelativeFile | ❌                              |
+| RenameFile      | ✅                              |

From 3dde5842723a47ea2fddfdedc0f6552652bcc736 Mon Sep 17 00:00:00 2001
From: lk29 <12291632+lk29@users.noreply.github.com>
Date: Wed, 1 Mar 2023 03:10:13 +0500
Subject: [PATCH 13/27] Create webdav.ENG.md

---
 use/webdav.ENG.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)
 create mode 100644 use/webdav.ENG.md

diff --git a/use/webdav.ENG.md b/use/webdav.ENG.md
new file mode 100644
index 0000000..dbf8007
--- /dev/null
+++ b/use/webdav.ENG.md
@@ -0,0 +1,25 @@
+#WebDAV
+
+WebDAV is a file transfer protocol based on the HTTP protocol. Nowadays, many third-party file managers, video players and other products support accessing files in Cloudreve through the WebDAV protocol. You can use this to achieve cross-platform file sharing and synchronization.
+
+To use WebDAV, please go to the background management panel to enable WebDAV permission for the corresponding user group. The account used by WebDAV and the Cloudreve account **do not interoperate** and need to be created separately. Go to the foreground Navigate to the left - WebDAV - Create New Account Create account information for WebDAV use. After the creation is complete, the system will automatically generate a password for this account. When using WebDAV, please use the registered email address as the account name, and the password is the password generated by the above system.
+
+When creating a WebDAV account, you can specify a relative root directory for this account, and this account can only access directories and files under the specified relative root directory through WebDAV. For the donation version, users can also mount different storage strategies for different directories. When uploading new files under WebDAV, the storage strategy mounted for the directory will be used first.
+
+## Common client instructions
+
+### Use Windows Explorer (not recommended)
+
+{% hint style="info" %}
+Before using this method, make sure your Cloudreve site has HTTPS enabled. If you need to add it under a non-HTTPS protocol, you need to modify the registry `\HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\WebClient\Parameters` to change the value of `BasicAuthLevel` to `2`.
+{% endhint %}
+
+Right-click on the blank space of "This PC" and select "Add a network location":
+
+![](<../.gitbook/assets/image (1) (1) (1).png>)
+
+Enter the WebDAV connection address of the site. The general format is `https://your domain name/dav`. After filling, enter your Cloudreve account and the account password generated by the system.
+
+Known issue: After restarting, the added WebDAV mount cannot be accessed, and the account password needs to be re-entered. This is because Windows no longer supports storing WebDAV account and password information under BasicAuth ([Related instructions](https://docs.microsoft.com/en-us/troubleshoot/windows-client/networking/cannot-automatically-reconnect-dav -share)). Cloudreve will replace the WebDAV authentication method in subsequent versions to improve this problem.
+
+****

From beb9260caef163c209648d98af07944f2ccd5c8b Mon Sep 17 00:00:00 2001
From: lk29 <12291632+lk29@users.noreply.github.com>
Date: Wed, 1 Mar 2023 03:11:03 +0500
Subject: [PATCH 14/27] Create aria2.ENG.md

---
 use/aria2.ENG.md | 106 +++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 106 insertions(+)
 create mode 100644 use/aria2.ENG.md

diff --git a/use/aria2.ENG.md b/use/aria2.ENG.md
new file mode 100644
index 0000000..3a69cb5
--- /dev/null
+++ b/use/aria2.ENG.md
@@ -0,0 +1,106 @@
+# Download offline
+
+Cloudreve's offline download core is powered by [Aria2](https://aria2.github.io). After correctly configuring and enabling the offline download function, users can create magnet link, HTTP, and torrent download tasks, which will be added to user files after the download is completed by the server.
+
+For the cloud storage strategy, after the offline download task is completed, Cloudreve will transfer the downloaded files to the cloud storage end, and the user cannot download and manage the downloaded files before the transfer is completed. Users can view the progress of the dump task in the foreground task queue.
+
+Cloudreve supports "slave offline download", you can offload offline download tasks to multiple servers to avoid these tasks occupying too much host resources. Each node responsible for handling offline download tasks needs to run a set of Cloudreve and Aria2 instances. You can configure and add new nodes by following the node addition wizard in the admin panel. The slave offline download node is essentially the same as the node used for the slave storage policy, and you can use the slave Cloudreve instance as a storage node and an offline download node at the same time. If you do not need slave nodes to handle offline download tasks, but only want the current host Cloudreve to handle offline downloads, you only need to edit the host node and configure Aria2 related information. Offline download tasks created by users will be assigned to all available offline download nodes in turn.
+
+## Enable offline download
+
+### Aria2 RPC configuration
+
+The installation and startup process of Aria2 is beyond the scope of this article. You need to start Aria2 on the same machine as Cloudreve.
+
+{% hint style="info" %}
+It is recommended that in the daily startup process, start Aria2 first, and then start Cloudreve, so that Cloudreve can subscribe to Aria2 for event notifications, and the download status changes can be processed in a more timely manner. Of course, if there is no such process, Cloudreve will also track the task status through polling.
+{% endhint %}
+
+When starting Aria2, you need to enable the RPC service in its configuration file and set the RPC Secret for subsequent use.
+
+```bash
+# Enable RPC service
+enable-rpc=true
+# RPC listening port
+rpc-listen-port=6800
+# RPC authorization token, can be set by yourself
+rpc-secret=<your token>
+```
+
+### Connect to Cloudreve
+
+Go to Cloudreve's management panel-offline download node-add/edit node-offline download, fill in the information according to the guidelines and test whether it can communicate with Aria2 normally.
+
+The explanation of the important parameter items is as follows:
+
+**RPC server address**
+
+The address of the Aria2 RPC server can generally be filled in as `http://127.0.0.1:6800/`. Where `6800` is the listening port specified in the Aria2 configuration file above. You can use WebSocket communication, fill in here as `ws://127.0.0.1:6800/`.
+
+**RPC Secret**
+
+The RPC authorization token you set up in the Aria2 configuration file above.
+
+**Temporary download directory**
+
+Cloudreve will specify Aria2 to download files to this directory. After the download is complete, Cloudreve will copy to the specified storage policy and delete the files. This directory **must be an absolute path**, otherwise Cloudreve will not find the file after the task download is complete. The absolute path specified under Windows should carry a drive letter, such as `G:\www\downloads`.
+
+**Status refresh interval (seconds)**
+
+Specifies the interval at which, for each job, Cloudreve polls Aria2 to update the job status. The task progress that the user sees in the foreground will not be updated in real time, but will be automatically refreshed according to the interval set here.
+
+**Global Task Parameters**
+
+Specify the additional parameters that Cloudreve carries when creating the Aria2 download task here. If Aria2 is not shared with other services, you can also specify these parameters in the Aria2 configuration file. For specific available parameters, please refer to [Official Documentation](https://aria2.github.io/manual/en/html/aria2c.html#options), fill in here in JSON format. Incorrect formatting may prevent task creation. The following is an example of filling in, specifying the maximum number of parallel tasks and the list of Tracker servers:
+
+```javascript
+{
+"max-concurrent-downloads": 10,
+"bt-tracker": [
+"udp://tracker.coppersurfer.tk:6969/announce",
+"udp://tracker.opentrackr.org:1337/announce",
+"udp://tracker.leechers-paradise.org:6969/announce"
+]
+}
+```
+
+You can also specify specific parameters for each user group in the user group configuration, such as limiting the maximum download speed and so on. The specific format is consistent with the above and will not be repeated.
+
+### User Group Permissions
+
+For the user group that you want to allow the offline download function, please enable the offline download permission on the user group edit page.
+
+## common problem
+
+#### When testing the Aria2 connection, it prompts `Unable to request RPC service, Post "XXX": dial tcp XXX connect: connection refused`
+
+The RPC address filled in is wrong, and the connection cannot be made. Check whether the address is wrong, whether Aria2 is started, and whether the port is consistent with that specified in the Aria2 configuration file.
+
+#### When testing Aria2 connection, it prompts `Unable to request RPC service, invalid character '<' looking for beginning of value`
+
+The RPC address filled in is wrong and you can connect, but it is not the RPC service of Aria2. Please check whether the address is wrong and the port is correct. The reason for this error is generally that the RPC address is filled in as the address of a Web service.
+
+#### The task status in the Cloudreve task list is not updated/not updated in time
+
+Cloudreve will periodically poll the task status, and the status will not be updated in real time after the task is created, please wait patiently. You can also adjust the update frequency in Admin Panel - Parameter Settings - Offline Download - Status Refresh Interval (seconds).
+
+#### BT download too slow/no speed
+
+Download tasks are handled by Aria2 and cannot be optimized by Cloudreve. One possible solution is to add Tracker servers manually. You can specify Tracker in Aria2 configuration file:
+
+```bash
+bt-tracker=udp://tracker.coppersurfer.tk:6969/announce,http://tracker.internetwarriors.net:1337/announce,udp://tracker.opentrackr.org:1337/announce
+```
+
+The Tracker list specified above is just an example, and you need to fill it in according to the actual situation. You can use the [trackerslist](https://github.com/ngosang/trackerslist) project for a daily updated list of the best trackers.
+
+#### After the BT task progress is 100%, the task is still in the "in progress" list for a long time without being processed
+
+By default, Aria2 will seed the downloaded BT tasks. After the seeding is completed, Cloudreve will consider it as completed and perform subsequent processing. You can specify the seeding share rate or seeding time in the Aria2 configuration file, when either condition is met, the seeding will stop:
+
+```bash
+# Seed share rate, 0 means always seed, default: 1.0
+seed-ratio=1.0
+# If the seeding time is greater than 30 minutes, stop seeding
+seed-time=30
+```

From b6f27fbadfd6c3ebc26c8f9a272b81001e713d66 Mon Sep 17 00:00:00 2001
From: lk29 <12291632+lk29@users.noreply.github.com>
Date: Wed, 1 Mar 2023 03:12:21 +0500
Subject: [PATCH 15/27] Create README.ENG.md

---
 use/policy/README.ENG.md | 5 +++++
 1 file changed, 5 insertions(+)
 create mode 100644 use/policy/README.ENG.md

diff --git a/use/policy/README.ENG.md b/use/policy/README.ENG.md
new file mode 100644
index 0000000..eaefd47
--- /dev/null
+++ b/use/policy/README.ENG.md
@@ -0,0 +1,5 @@
+# storage policy
+
+Storage policies define storage platforms, uploads, and functional restrictions for files. A user group is bound to a storage policy, and users under this user group will share the same storage policy. In the Pro version, you can specify multiple storage policies for a single user group, and users can switch storage policies freely.
+
+In Cloudreve's file system, each file has its corresponding storage policy recorded, and users can own and manage files with multiple storage policies at the same time. After switching the storage policy of the user group, the uploaded files will not be affected.

From c59cccaabdbdf015ce2f17ea90eb6000c8b2c7ab Mon Sep 17 00:00:00 2001
From: lk29 <12291632+lk29@users.noreply.github.com>
Date: Wed, 1 Mar 2023 03:29:00 +0500
Subject: [PATCH 16/27] Create compare.ENG.md

---
 use/policy/compare.ENG.md | 51 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 51 insertions(+)
 create mode 100644 use/policy/compare.ENG.md

diff --git a/use/policy/compare.ENG.md b/use/policy/compare.ENG.md
new file mode 100644
index 0000000..8216d29
--- /dev/null
+++ b/use/policy/compare.ENG.md
@@ -0,0 +1,51 @@
+# Compared
+
+Transit Cloudreve supports a variety of underlying storage strategies, but due to various factors such as API restrictions, Cloudreve does not support each strategy at the same level. This chapter will list the specific support differences between different storage strategies in detail.
+
+## Basic comparison
+
+
+
+|           |       Local          |       Slave          |         Qiniu        |          OSS         |          COS         |Shoot the clouds again |       OneDrive       | S3                   |
+| --------- | :------------------: | :------------------: | :------------------: | :------------------: | :------------------: | :------------------: | :------------------: | -------------------- |
+| upload     | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: |
+| Multipart upload      | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: |          :x:         |          :x:         | :white\_check\_mark: | :white\_check\_mark: |
+| download        | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: |
+| copy        | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: |
+| move        | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: |
+| normal preview      | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: |
+| Office preview| :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: |
+| delete        | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: |
+| thumbnail       | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :x:                  |
+| Download package      | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: |
+| real file name download   | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: |          :x:         | :white\_check\_mark: |
+| theoretical maximum file    |          Unlimited          |          Unlimited          |          Unlimited          |          Unlimited          |         5 GB         |        150 GB        |        250 GB        | Unlimited                   |
+| Public network access requirements    |           None          |           None          |          Required          |          Required          |          Required          |          Required          |          Required          | Required                   |
+| available for public use   | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: |       subject to ToS       | :x:                  |
+
+## Advanced Features
+
+|           |       Local          |       Slave          |         Qiniu        |          OSS         |          COS         |Shoot the clouds again |       OneDrive       | S3                   |
+| -------- | :------------------: | :------------------: | :------------------: | :------------------: | :------------------: | :------------------: | :------------------: | -------------------- |
+| offline download     | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: |
+| download speed limit     | :white\_check\_mark: | :white\_check\_mark: |          :x:         | :white\_check\_mark: | :white\_check\_mark: |          :x:         |          :x:         | :x:                  |
+| Transit direct chain is permanently effective | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: |
+| The original straight chain is permanently valid | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: |          :x:         | :white\_check\_mark: |
+| unzip      | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: |
+| compression       | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: |
+|          |                      |                      |                      |                      |                      |                      |                      |                      |
+
+## traffic path
+
+|           |       Local          |       Slave          |         Qiniu        |          OSS         |          COS         |Shoot the clouds again |       OneDrive       | S3                   |
+| ----------- | -------------------- | -------------------- | -------------------- | -------------------- | -------------------- | -------------------- | -------------------- | -------------------- |
+| Web Upload Client Direct | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: |
+| download direct        | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: |
+| Package download/compress/decompress| direct pass                   | transit                   | transit                   | transit                   | transit                   | transit                   | transit                   | transit                   |
+| offline download        | direct pass                   | transit                   | transit                   | transit                   | transit                   | transit                   | transit                   | transit                   |
+| Text Editor        | direct pass                   | transit                   | transit                   | transit                   | transit                   | transit                   | transit                   | transit                   |
+| WebDAV upload direct | :white\_check\_mark: | :x:                  | :x:                  | :x:                  | :x:                  | :x:                  | :x:                  | :x:                  |
+| WebDAV download direct | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: |
+
+
+

From 567b0f7652fbb2224b45d7688a2e3510f7092625 Mon Sep 17 00:00:00 2001
From: lk29 <12291632+lk29@users.noreply.github.com>
Date: Wed, 1 Mar 2023 03:30:32 +0500
Subject: [PATCH 17/27] Create s3.ENG.md

---
 use/policy/s3.ENG.md | 94 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 94 insertions(+)
 create mode 100644 use/policy/s3.ENG.md

diff --git a/use/policy/s3.ENG.md b/use/policy/s3.ENG.md
new file mode 100644
index 0000000..e64297d
--- /dev/null
+++ b/use/policy/s3.ENG.md
@@ -0,0 +1,94 @@
+# S3 compatible
+
+Through the AWS S3 storage policy, you can use Cloudreve to connect to all storage platforms compatible with the AWS S3 protocol. This article will introduce [Backblaze B2](https://www.backblaze.com/b2/cloud-storage.html) and [Cloudflare R2](https://www.cloudflare.com/products/r2/) two platforms docking method.
+
+{% hint style="warning" %}
+S3 storage policies are only available for personal use or for use by trusted groups. Due to the lack of a unified callback mechanism, users can skip Cloudreve's records and upload files to storage buckets.
+{% endhint %}
+
+## S3 API compatibility requirements
+
+Cloudreve utilizes the following S3 APIs, please make sure your storage platform is compatible and implements the following APIs.
+
+### Bucket Level
+
+* [PutBucketCors](https://docs.aws.amazon.com/AmazonS3/latest/API/API\_PutBucketCors.html) is optional and is used to assist in configuring CORS policies. If this API is not implemented, you can also configure it manually .
+
+### Object Level
+
+* [ListObjects](https://docs.aws.amazon.com/AmazonS3/latest/API/API\_ListObjects.html) Optional, used to import external files in the background.
+* [CreateMultipartUpload](https://docs.aws.amazon.com/AmazonS3/latest/API/API\_CreateMultipartUpload.html)
+* [CompleteMultipartUpload](https://docs.aws.amazon.com/AmazonS3/latest/API/API\_CompleteMultipartUpload.html)
+* [AbortMultipartUpload](https://docs.aws.amazon.com/AmazonS3/latest/API/API\_AbortMultipartUpload.html)
+* [UploadPart](https://docs.aws.amazon.com/AmazonS3/latest/API/API\_UploadPart.html)
+* [GetObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API\_GetObject.html)
+* [DeleteObjects](https://docs.aws.amazon.com/AmazonS3/latest/API/API\_DeleteObjects.html)
+* [HeadObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API\_HeadObject.html)
+
+## Backblaze B2
+
+Go to [Backblaze B2](https://www.backblaze.com/b2/cloud-storage.html) to create an account, click "Create a Bucket" to create a Bucket. You can choose Public or Private Bucket according to your needs. Private Bucket is recommended to improve security. After naming the bucket, keep other parameters as default, and click Create Bucket.
+
+<img src="../../.gitbook/assets/image (4).png" alt="" data-size="original">
+
+Add the AWS S3 storage policy in the Cloudreve management panel, and fill in the Bucket name you created. According to the Bucket type, if it is Private, please select "Block All Public Access", and if Public, please select "Allow Public Read". Find the Endpoint of the Bucket on the B2 management panel, add `https://` to its head, and add the Bucket name to the end to fill in Cloudreve:
+
+<figure><img src="../../.gitbook/assets/image (6).png" alt=""><figcaption></figcaption></figure>
+
+Fill in the region to which the Bucket belongs in Cloudreve, which can be judged by the Endpoint. For example, the area code of Endpoint `s3.us-west-004.backblazeb2.com` is `us-west-004`. You cannot find the corresponding region in the drop-down menu provided by Cloudreve, just fill in the region code directly.
+
+Click "Add a New Application Key" in Account -> App Keys on the B2 panel, fill in the name of any Key, select the Bucket you just created, and keep other parameters as default:
+
+![](<../../.gitbook/assets/image (1).png>)
+
+After creation, fill `keyID` into `AccessKey`; `applicationKey` into `SecretKey`:
+
+<figure><img src="../../.gitbook/assets/image (7).png" alt=""><figcaption></figcaption></figure>
+
+Continue to fill in the storage policy configuration, and when you get to step 5, click Let Cloudreve help you create a CORS policy:
+
+<figure><img src="../../.gitbook/assets/image (2).png" alt=""><figcaption></figcaption></figure>
+
+At this point, you can bind and use the newly created B2 storage policy.
+
+## Cloudflare R2
+
+### Option 1: Private Bucket
+
+Go to [Cloudflare R2](https://www.cloudflare.com/products/r2/) to purchase a package to activate R2 service. After the Bucket is created, add the AWS S3 storage policy in the Cloudreve management panel and fill in the name of the created Bucket, select the Bucket type as "block all public access", and fill in the Endpoint address provided by Cloudflare (**Bucket name that needs to be removed from the end Manually delete **), the Endpoint format is selected as "mandatory path format":
+
+<figure><img src="../../.gitbook/assets/image (11).png" alt=""><figcaption></figcaption></figure>
+
+
+
+Fill in `auto` in the fifth Bucket area code:
+
+![](<../../.gitbook/assets/image (5).png>)
+
+Go to the home page of the R2 service panel, go to "Manage R2 API Tokens" to create a set of API Tokens, select permission to allow editing, and set the validity period of the certificate according to the requirements:
+
+<figure><img src="../../.gitbook/assets/image (10).png" alt=""><figcaption></figcaption></figure>
+
+{% hint style="info" %}
+After the API Token expires, please generate a new Token and fill it in the corresponding storage policy of Cloudreve.
+{% endhint %}
+
+Fill the AccessKey and SecretKey into Cloudreve after creation:
+
+<figure><img src="../../.gitbook/assets/image (8).png" alt=""><figcaption></figcaption></figure>
+
+Continue to fill in the storage policy configuration, and when you get to step 5, click Let Cloudreve help you create a CORS policy:
+
+<figure><img src="../../.gitbook/assets/image (2).png" alt=""><figcaption></figcaption></figure>
+
+At this point, you can bind and use the newly created R2 storage policy.
+
+### Choice 2: Public Bucket
+
+If you need to use a public Bucket, the configuration process is roughly the same as [#xuan-ze-1private-bucket](s3.md#xuan-ze-1private-bucket "mention"), where the additional operations are:
+
+Enable Public Access in the R2 Bucket settings, and then fill in the storage policy information in Cloudreve. Among them, the Bucket type is selected as "Allow public reading"; the Endpoint format is selected as "Host name first"; select "Use CDN" and fill in the Public Bucket URL just obtained (don't forget to remove the `https` at the beginning):
+
+<figure><img src="../../.gitbook/assets/image (11) (1).png" alt=""><figcaption></figcaption></figure>
+
+Other configurations should be consistent with those of the Public Bucket.

From 9aa6a2960bbafd25845103f4ee1d6e8e58058767 Mon Sep 17 00:00:00 2001
From: lk29 <12291632+lk29@users.noreply.github.com>
Date: Wed, 1 Mar 2023 03:31:50 +0500
Subject: [PATCH 18/27] Create README.ENG.md

---
 use/pro/README.ENG.md | 1 +
 1 file changed, 1 insertion(+)
 create mode 100644 use/pro/README.ENG.md

diff --git a/use/pro/README.ENG.md b/use/pro/README.ENG.md
new file mode 100644
index 0000000..432b2b4
--- /dev/null
+++ b/use/pro/README.ENG.md
@@ -0,0 +1 @@
+# Donation version related

From c7f17e1e3ea702476e697f1d1a084dd2b4ff5bd3 Mon Sep 17 00:00:00 2001
From: lk29 <12291632+lk29@users.noreply.github.com>
Date: Wed, 1 Mar 2023 03:32:34 +0500
Subject: [PATCH 19/27] Create jie-shao.ENG.md

---
 use/pro/jie-shao.ENG.md | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)
 create mode 100644 use/pro/jie-shao.ENG.md

diff --git a/use/pro/jie-shao.ENG.md b/use/pro/jie-shao.ENG.md
new file mode 100644
index 0000000..1eb86e7
--- /dev/null
+++ b/use/pro/jie-shao.ENG.md
@@ -0,0 +1,31 @@
+# introduce
+
+You can choose to sponsor the development of Cloudreve in return for a feature-enhanced version of Cloudreve Pro.
+
+The current exclusive features of the Pro version are as follows, and you can experience them at the [Official Demo Site](https://demo.cloudreve.org).
+
+* Bind multiple storage policies for the same user group, and users can switch freely
+   * Support for transferring files between storage policies
+* Users can bind different storage strategies for different directories, seamlessly switch storage strategies
+* Capacity pack purchase
+* User purchases
+* Point recharge
+* Activation code (redemption user group, capacity pack, points)
+* Create a share for downloading with credits
+* Third-party payment docking (PAYJS, Alipay face-to-face payment)
+* QQ Internet login
+* Save other users to share to their own network disk
+* Bind different storage strategies for different directories under WebDAV
+* Share reports and handle them
+* Specify the initial file for newly registered users
+* Site announcement module
+* Register email suffix whitelist/blacklist
+* Additional client volume authorization can be purchased
+* Set different available offline download nodes for different user groups
+* (continuously updated...)
+
+[Detailed graphic introduction and frequently asked questions>>](https://forum.cloudreve.org/d/1587)
+
+The current limited-time discount price of the donation version is ￥399, which supports the authorization of multiple domain names with the same root domain, such as www.abc.com, pan.abc.com.
+
+Sponsorship page: [https://pro.cloudreve.org/Buy](https://pro.cloudreve.org/Buy)

From 36ec3e6735b22bb149ba391dc96f5f93409fb81d Mon Sep 17 00:00:00 2001
From: lk29 <12291632+lk29@users.noreply.github.com>
Date: Wed, 1 Mar 2023 03:35:13 +0500
Subject: [PATCH 20/27] Create pay.ENG.md

---
 use/pro/pay.ENG.md | 144 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 144 insertions(+)
 create mode 100644 use/pro/pay.ENG.md

diff --git a/use/pro/pay.ENG.md b/use/pro/pay.ENG.md
new file mode 100644
index 0000000..1e95e00
--- /dev/null
+++ b/use/pro/pay.ENG.md
@@ -0,0 +1,144 @@
+# Custom payment channel
+
+In addition to the payment platforms already supported by Cloudreve, you can also connect to your own payment platform by implementing Cloudreve's payment interface, or bridge other third-party platforms.
+
+The custom payment interface you implement requires an independent HTTP service and provides:
+
+* Expose an API endpoint to handle Cloudreve's order creation request and return the payment page URL;
+* After the customer completes the payment, send an HTTP request to the specified URL to notify Cloudreve that the payment is complete.
+
+## Payment interface definition
+
+Implement your payment interface according to the specifications in this chapter, deploy the interface and ensure that it can communicate with Cloudreve.
+
+### Create Order
+
+{% swagger method="post" path="" baseUrl="<your payment interface>" summary="When a new order is created, Cloudreve sends a request to your payment interface." expanded="true" %}
+{% swagger-description %}
+
+{% endswagger-description %}
+
+{% swagger-parameter in="header" required="false" name="Authorization" type="String" %}
+Use the
+
+`communication key`
+
+The computed signature, see the subsection "Verifying Request Signatures" for details
+{% endswagger-parameter %}
+
+{% swagger-parameter in="header" name="X-Cr-Cloudreve-Version" type="String" %}
+Version of Cloudreve main program
+{% endswagger-parameter %}
+
+{% swagger-parameter in="header" name="X-Cr-Site-Id" type="String" %}
+Cloudreve's site ID, which can be used to distinguish between different sites
+{% endswagger-parameter %}
+
+{% swagger-parameter in="header" name="X-Cr-Site-Url" type="String" %}
+Cloudreve's site URL
+{% endswagger-parameter %}
+
+{% swagger-parameter in="body" name="name" type="String" required="true" %}
+order title
+{% endswagger-parameter %}
+
+{% swagger-parameter in="body" name="order_no" type="String" required="true" %}
+order number
+{% endswagger-parameter %}
+
+{% swagger-parameter in="body" name="notify_url" type="String" required="true" %}
+The callback notification URL of successful payment, please refer to the subsequent "Payment Successful Callback" section for details. Please save this for later use.
+{% endswagger-parameter %}
+
+{% swagger-parameter in="body" name="amount" type="String" required="true" %}
+The total amount of the order, unit: cent
+{% endswagger-parameter %}
+
+{% swagger-response status="200: OK" description="When the order was created successfully" %}
+```javascript
+{
+     // Successful responses are fixed at 0
+     "code": 0,
+     // The URL of the payment cashier page will be generated as a QR code by default and displayed to the user, and the user can also choose to directly
+     // open this URL
+     "data": "https://examplepayment.com/checkout/26544743"
+}
+```
+{% endswagger-response %}
+
+{% swagger-response status="200: OK" description="When order creation failed" %}
+```javascript
+{
+     // Any non-zero code indicates that the order creation failed
+     "code": 500,
+     // detailed description of the error
+     "error": "Failed to create a payment."
+}
+```
+{% endswagger-response %}
+{% endswagger %}
+
+Request example:
+
+```http
+POST /order/create
+Host: examplepayment.com
+Authorization: Bearer Vep6hl1x8fiQLasEauMEUqxFKyEqSXb9D_BBQpOiTd8=:1676027218
+X-Cr-Site-Url: https://demo.cloudreve.org
+X-Cr-Site-Id: b7de8bba-8f86-40fe-8171-c2625b6c4a61
+X-Cr-Cloudreve-Version: 3.6.2
+
+{
+    "name":"Cloudreve - 10 GB Capacity Pack",
+    "order_no": "20230209190648343421",
+    "notify_url": "http://demo.cloudreve.org/api/v3/callback/custom/20230209190648343421/363f8866-6d0a-4dbf-a560-0c17de2eb7f9?sign=F-AdeTf7cR1uwmV1dqJ1kN_POGivKk_awMRP%ZUCD8%30hA737D8%"
+    "amount": 100
+}
+```
+
+#### Verify request signature
+
+You can set the `communication key` in the Cloudreve backend, and Cloudreve’s request to create an order will be encrypted with this key and placed in the `Authorization` header. You can verify this signature through the following algorithm:
+
+1. Take out the part after `Bearer` from the `Authorization` value, use `:` to split the string, the second part is the timestamp when the signature expires, and verify that it is greater than the current timestamp. Write the part before `:` as `SIGNATURE`;
+2. Refer to [getSignContent](https://github.com/cloudreve/Cloudreve/blob/b441d884f61d59da86d861b14d1302ec25bbea40/pkg/auth/auth.go#L71) to encode the request body and header, and use the HMAC algorithm to encode the encoded content and expire Timestamp calculation signature: [Sign](https://github.com/cloudreve/Cloudreve/blob/b441d884f61d59da86d861b14d1302ec25bbea40/pkg/auth/auth.go#L71);
+3. Check whether the signed content is consistent with `SIGNATURE`.
+
+### Payment success callback
+
+When the user completes the payment, you need to send a GET request to the `notify_url` specified when the order was created to notify Cloudreve that the user has completed the payment. If the callback request fails, retry with an exponential backoff interval, unless an error message and code are explicitly returned in the response.
+
+{% swagger method="get" path="" baseUrl="<notify_url>" summary="After the user completes the payment, send a request to `notify_url` associated with the order to notify Cloudreve that the payment is successful." %}
+{% swagger-description %}
+
+{% endswagger-description %}
+
+{% swagger-response status="200: OK" description="The request was successful" %}
+```javascript
+{
+     "code": 0
+}
+```
+{% endswagger-response %}
+
+{% swagger-response status="200: OK" description="Order processing failed" %}
+```javascript
+{
+     // Any non-zero code indicates that the order creation failed
+     "code": 500,
+     // detailed description of the error
+     "error": "Failed to fulfill a payment."
+}
+```
+{% endswagger-response %}
+{% endswagger %}
+
+## Add payment interface
+
+After implementing and deploying the payment interface, please open and fill in the interface address in Cloudreve Background - Value-added Services - Custom Payment Channel.
+
+## Third-party implementation
+
+| Payment Platform | License | Documentation |
+| ---- | ----- | -------------------------------------- -------------------------------------------------- ------ |
+| Easy Payment | Open Source | [https://github.com/topjohncian/cloudreve-epay](https://github.com/topjohncian/cloudreve-epay) |

From 6b4e17b2be81314840ddd260415e090e5a4baeea Mon Sep 17 00:00:00 2001
From: lk29 <12291632+lk29@users.noreply.github.com>
Date: Wed, 1 Mar 2023 03:36:32 +0500
Subject: [PATCH 21/27] Create vo-l.ENG.md

---
 use/pro/vo-l.ENG.md | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)
 create mode 100644 use/pro/vo-l.ENG.md

diff --git a/use/pro/vo-l.ENG.md b/use/pro/vo-l.ENG.md
new file mode 100644
index 0000000..749e092
--- /dev/null
+++ b/use/pro/vo-l.ENG.md
@@ -0,0 +1,31 @@
+# iOS client batch authorization
+
+### About Site Volume Licensing (VOL)
+
+By default, [Cloudreve iOS client](https://cloudreve.org/ios) is charged for end-user subscription, after which users can connect to all Cloudreve-bound sites. Site volume authorization allows Cloudreve site administrators to unlock iOS client access for end users. After purchasing a site volume license for your site, end users can use the iOS free connection to bind your Cloudreve site without a subscription.
+
+### price
+
+Each root domain name: ￥398 / $63.9 (subject to the final price at the time of purchase), the authorization is permanently valid.
+
+### Authorization conditions
+
+* The root domain name has purchased [Cloudreve Pro](https://cloudreve.org/pro) authorization;
+* Cloudreve Pro version >= 3.6.0;
+* Cloudreve iOS client version >= 1.3.0
+
+### Purchase method
+
+1. Log in to [Cloudreve Pro Authorization Management Panel](https://cloudreve.org/login), find the root domain name that needs to unlock VOL, and click Purchase Authorization:
+
+<figure><img src="../../.gitbook/assets/1671010630-778154-snipaste-2022-12-14-16-15-04.png" alt=""><figcaption></figcaption ></figure>
+
+2. After payment and purchase, go to your Cloudreve management panel, and synchronize authorization in Parameter Settings - Site Information - Mobile Client:
+
+<figure><img src="../../.gitbook/assets/1671011290-213143-snipaste-2022-12-14-17-47-40.png" alt=""><figcaption></figcaption ></figure>
+
+### Precautions
+
+* The root domain name authorized by VOL follows the root domain name authorized by Pro. After modification, the authorization needs to be re-synchronized in the Cloudreve management panel.
+* VOL is a decentralized verification and cannot be refunded after purchase, please understand!
+* VOL authorization can only unlock your Cloudreve site, and non-subscribers may need to pay to subscribe to the iOS client when connecting to other sites.

From f7ebd48879c9edec78ae4d7c5dee7d81454d6f2c Mon Sep 17 00:00:00 2001
From: lk29 <12291632+lk29@users.noreply.github.com>
Date: Wed, 1 Mar 2023 03:38:30 +0500
Subject: [PATCH 22/27] Update SUMMARY.ENG.md

---
 SUMMARY.ENG.md | 22 +++++++++++-----------
 1 file changed, 11 insertions(+), 11 deletions(-)

diff --git a/SUMMARY.ENG.md b/SUMMARY.ENG.md
index fe97d06..aa4853f 100644
--- a/SUMMARY.ENG.md
+++ b/SUMMARY.ENG.md
@@ -10,17 +10,17 @@
 
 ## Use <a href="#use" id="use"></a>
 
-* [Storage Policy](use/policy/README.md)
-   * [Compare](use/policy/compare.md)
-   * [S3 compatible](use/policy/s3.md)
-* [WebDAV](use/webdav.md)
-* [Offline download](use/aria2.md)
-* [Custom front end](use/zi-ding-yi-qian-duan.md)
-* [Extended Documentation Preview/Edit](use/wopi.md)
-* [Contribution version related](use/pro/README.md)
-   * [Introduction](use/pro/jie-shao.md)
-   * [iOS client bulk authorization](use/pro/vo-l.md)
-   * [Custom payment channel](use/pro/pay.md)
+* [Storage Policy](use/policy/README.ENG.md)
+   * [Compare](use/policy/compare.ENG.md)
+   * [S3 compatible](use/policy/s3.ENG.md)
+* [WebDAV](use/webdav.ENG.md)
+* [Offline download](use/aria2.ENG.md)
+* [Custom front end](use/zi-ding-yi-qian-duan.ENG.md)
+* [Extended Documentation Preview/Edit](use/wopi.ENG.md)
+* [Contribution version related](use/pro/README.ENG.md)
+   * [Introduction](use/pro/jie-shao.ENG.md)
+   * [iOS client bulk authorization](use/pro/vo-l.ENG.md)
+   * [Custom payment channel](use/pro/pay.ENG.md)
 
 ## Maintain <a href="#manage" id="manage"></a>
 

From e4dc02e9653e364e4a937281cc2eb4957d8afe7d Mon Sep 17 00:00:00 2001
From: lk29 <12291632+lk29@users.noreply.github.com>
Date: Wed, 1 Mar 2023 05:15:18 +0500
Subject: [PATCH 23/27] Create install.ENG.md

---
 getting-started/install.ENG.md | 404 +++++++++++++++++++++++++++++++++
 1 file changed, 404 insertions(+)
 create mode 100644 getting-started/install.ENG.md

diff --git a/getting-started/install.ENG.md b/getting-started/install.ENG.md
new file mode 100644
index 0000000..722bb77
--- /dev/null
+++ b/getting-started/install.ENG.md
@@ -0,0 +1,404 @@
+# quick start
+
+## Get Cloudreve
+
+You can get the main program that has been built and packaged on the [GitHub Release](https://github.com/cloudreve/Cloudreve/releases) page. Each version provides the main program available under the common system architecture, and the naming rule is `cloudreve_version number_operating system_CPU architecture.tar.gz`. For example, to deploy version 3.0.0 on an ordinary 64-bit Linux system, you should download `cloudreve_3.0.0_linux_amd64.tar.gz`.
+
+If you want to experience the latest features, you can download the development version built after each commit in [GitHub Actions](https://github.com/cloudreve/Cloudreve/actions). Note that the development version is not stable, cannot be used for production use, and is not guaranteed to be fully usable.
+
+If you want to build from source yourself, see the following sections:
+
+{% content-ref url="build.md" %}
+[build.md](build.md)
+{% endcontent-ref %}
+
+## Start Cloudreve
+
+{% tabs %}
+{% tab title="Linux" %}
+Under Linux, just decompress and execute the main program directly:
+
+```bash
+#Unzip the obtained main program
+tar -zxvf cloudreve_VERSION_OS_ARCH.tar.gz
+
+# Give execute permission
+chmod +x ./cloudreve
+
+# start Cloudreve
+./cloudreve
+```
+
+{% endtab %}
+
+{% tab title="Windows" %}
+Under Windows, directly decompress the obtained zip archive and start `cloudreve.exe`.
+{% endtab %}
+{% endtabs %}
+
+When Cloudreve starts for the first time, it will create an initial administrator account. Please keep the administrator password safe, this password will only appear when it is started for the first time. If you forget the initial administrator password, you need to delete `cloudreve.db` in the same directory and restart the main program to initialize a new administrator account.
+
+Cloudreve listens on `5212` port by default. You can access `http://serverIP:5212` in your browser to enter Cloudreve.
+
+After the above steps are completed, the simplest deployment is completed. You may need some more specific configurations to make Cloudreve work better. Please refer to the configuration process below for specific procedures.
+
+## Optional deployment process
+
+### reverse proxy
+
+In the scenario of self-use or small-scale use, you can use Cloudreve's built-in web server. But if you need to use HTTPS, or need to coexist with other web services on the server, you may need to use the mainstream web server reverse proxy Cloudreve to get richer extensions.
+
+You need to create a new virtual host in the web server, complete the required configurations (such as enabling HTTPS), and then add anti-generation rules to the website configuration file:
+
+{% tabs %}
+{% tab title="NGINX" %}
+In the `server` field of the website add:
+
+```
+location / {
+     proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+     proxy_set_header Host $http_host;
+     proxy_redirect off;
+     proxy_pass http://127.0.0.1:5212;
+
+     # If you want to use the local storage strategy, please delete the comment on the next line and change the size to the theoretical maximum file size
+     # client_max_body_size 20000m;
+}
+```
+
+{% endtab %}
+
+{% tab title="Apache" %}
+Add the anti-generation configuration item `ProxyPass` under the `VirtualHost` field, for example:
+
+```markup
+<VirtualHost *:80>
+     ServerName myapp.example.com
+     ServerAdmin webmaster@example.com
+     DocumentRoot /www/myapp/public
+
+     # The following are the key parts
+     AllowEncodedSlashes NoDecode
+     ProxyPass "/" "http://127.0.0.1:5212/" nocanon
+
+</VirtualHost>
+```
+
+{% endtab %}
+
+{% tab title="IIS" %}
+
+#### 1. Install IIS URL Rewrite and ARR modules
+
+- URL Rewrite: [Click to download](https://www.iis.net/downloads/microsoft/url-rewrite#additionalDownloads)
+- ARR: [Click to download](https://www.iis.net/downloads/microsoft/application-request-routing#additionalDownloads)
+
+If it is already installed, please skip this step.
+
+#### 2. Enable and configure ARR
+
+Open IIS, enter **Application Request Routing Cache** on the home page, then enter **Server Proxy Settings...** on the right, check **Enable proxy** on the top, and uncheck the ** below Reverse rewrite host in response headers**. Click Apply on the right to save the changes.
+
+Enter **Configuration Editor** at the bottom of the home page, go to `system.webServer/proxy` node, adjust **preserveHostHeader** to **True** and click Apply on the right to save the changes.
+
+If you do not uncheck the reverse rewrite host header, the Cloudreve API will not be able to return the correct address, resulting in the inability to preview pictures and videos.
+
+#### 3. Configure anti-generation rules
+
+This is the content of the `web.config` file, just place it in the root directory of the target website. This example includes two rules and one restriction:
+
+- HTTP to HTTPS redirect (mandatory HTTPS, you need to configure SSL before you can use it, please delete this rule if you don’t use it)
+- Rerwite (reverse generation)
+- `60000000` in `requestLimits` is the transfer file size limit, the unit is byte, if you want to use the local storage strategy, please change the size to the theoretical maximum file size
+
+```xml
+<?xml version="1.0" encoding="UTF-8"?>
+<configuration>
+     <system. webServer>
+         <rewrite>
+             <rules>
+                 <rule name="HTTP to HTTPS redirect" stopProcessing="true">
+                     <match url=".*" />
+                     <conditions logicalGrouping="MatchAll" trackAllCaptures="false">
+                         <add input="{HTTPS}" pattern="off" />
+                     </conditions>
+                     <action type="Redirect" url="https://{HTTP_HOST}/{R:0}" redirectType="Permanent" />
+                 </rule>
+                 <rule name="Rerwite" stopProcessing="true">
+                     <match url=".*" />
+                     <conditions logicalGrouping="MatchAny" trackAllCaptures="false">
+                         <add input="{REQUEST_FILENAME}" matchType="IsFile" negate="true" />
+                         <add input="{REQUEST_FILENAME}" matchType="IsDirectory" negate="true" />
+                     </conditions>
+                     <action type="Rewrite" url="http://localhost:5212/{R:0}" />
+                 </rule>
+             </rules>
+         </rewrite>
+         <security>
+             <requestFiltering allowDoubleEscaping="true">
+                 <requestLimits maxAllowedContentLength="60000000" />
+             </requestFiltering>
+         </security>
+     </system. webServer>
+</configuration>
+```
+
+{% endtab %}
+{% endtabs %}
+
+### Process daemon
+
+You can choose one of the following two ways.
+
+#### Systemd
+
+```bash
+# edit configuration file
+vim /usr/lib/systemd/system/cloudreve.service
+```
+
+Replace `PATH_TO_CLOUDREVE` below with the directory where the program is located:
+
+```bash
+[Unit]
+Description=Cloudreve
+Documentation=https://docs.cloudreve.org
+After=network.target
+After=mysqld.service
+Wants=network.target
+
+[Service]
+Working Directory=/PATH_TO_CLOUDREVE
+ExecStart=/PATH_TO_CLOUDREVE/cloudreve
+Restart=on-abnormal
+RestartSec=5s
+KillMode=mixed
+
+StandardOutput=null
+StandardError=syslog
+
+[Install]
+WantedBy=multi-user.target
+```
+
+```bash
+# update configuration
+systemctl daemon-reload
+
+# start the service
+systemctl start cloudreve
+
+# set boot
+systemctl enable cloudreve
+```
+
+Management commands:
+
+```bash
+# start the service
+systemctl start cloudreve
+
+# Out of service
+systemctl stop cloudreve
+
+# restart service
+systemctl restart cloudreve
+
+# check status
+systemctl status cloudreve
+```
+
+#### Supervisor
+
+First install `supervisor`, you can skip the ones already installed.
+
+```bash
+# install supervisor
+sudo yum install python-setuptools
+sudo easy_install supervisor
+
+# Initialize the global configuration file
+sudo touch /etc/supervisord.conf
+sudo echo_supervisord_conf > /etc/supervisord.conf
+```
+
+Edit the global configuration file:
+
+```bash
+sudo vim /etc/supervisord.conf
+```
+
+Delete the `[include]` partition comment symbol `;` at the bottom of the file, and add a new configuration file to include the path:
+
+```bash
+[include]
+files = /etc/supervisor/conf/*.conf
+```
+
+Create the file directory where the Cloudreve application configuration is located, and create an open configuration file:
+
+```bash
+sudo mkdir -p /etc/supervisor/conf
+sudo vim /etc/supervisor/conf/cloudreve.conf
+```
+
+Fill in the following content according to the actual situation and save:
+
+```bash
+[program: cloudreve]
+directory=/home/cloudreve
+command=/home/cloudreve/cloudreve
+autostart=true
+autorestart=true
+stderr_logfile=/var/log/cloudreve.err
+stdout_logfile=/var/log/cloudreve.log
+environment=CODENATION_ENV=prod
+```
+
+The following configuration items need to be changed according to the actual situation:
+
+- `directory`: The directory where the Cloudreve main program is located
+- `command`: absolute path of Cloudreve main program
+- `stderr_logfile`: error log path
+- `stdout_logfile`: usual log path
+
+Start supervisor via the global configuration file:
+
+```bash
+supervisord -c /etc/supervisord.conf
+```
+
+In the future you can manage the Cloudreve process with the following commands:
+
+```bash
+# start up
+sudo supervisorctl start cloudreve
+
+# stop
+sudo supervisorctl stop cloudreve
+
+# check status
+sudo supervisorctl status cloudreve
+```
+
+## Docker
+> Before using, please make sure you know the working mechanism of docker. In general, the above deployment process can already cover most usage scenarios.
+
+We provide official docker image, which supports three architectures `armv7`, `arm64` and `amd64`, you can use the following command to deploy
+
+### Create directory structure
+
+Please **make sure** before running:
+
+> 1. Manually create an empty `conf.ini` file or a `conf.ini` that conforms to the Cloudreve configuration file specification, and replace `<path_to_your_config>` with the path
+> 2. Manually create `cloudreve.db` empty file and replace `<path_to_your_db>` with this path
+> 3. Manually create `uploads` folder and replace `<path_to_your_uploads>` with the path
+> 4. Manually create the `avatar` folder and replace `<path_to_your_avatar>` with the path
+
+Alternatively, create it directly with the following command:
+
+```bash
+mkdir -vp cloudreve/{uploads,avatar} \
+&& touch cloudreve/conf.ini \
+&& touch cloudreve/cloudreve.db
+```
+
+### run
+
+Then, run the docker container:
+
+```bash
+docker run -d \
+-p 5212:5212 \
+--mount type=bind,source=<path_to_your_config>,target=/cloudreve/conf.ini\
+--mount type=bind,source=<path_to_your_db>,target=/cloudreve/cloudreve.db\
+-v <path_to_your_uploads>:/cloudreve/uploads\
+-v <path_to_your_avatar>:/cloudreve/avatar \
+cloudreve/cloudreve:latest
+```
+
+## Docker Compose
+
+In addition, we also provide `docker compose` deployment and integrate offline download service
+Before that, you need to create a `data` directory as a temporary staging directory for offline downloads
+
+### Create directory structure
+
+```bash
+mkdir -vp cloudreve/{uploads,avatar} \
+&& touch cloudreve/conf.ini \
+&& touch cloudreve/cloudreve.db\
+&& mkdir -p aria2/config \
+&& mkdir -p data/aria2 \
+&& chmod -R 777 data/aria2
+```
+
+### run
+
+Then save the following file as `docker-compose.yml`, place it in the current directory, at the same level as cloudreve, and modify `RPC_SECRET` in the file
+
+```yml
+version: "3.8"
+services:
+   cloudreve:
+     container_name: cloudreve
+     image: cloudreve/cloudreve:latest
+     restart: unless-stopped
+     ports:
+       - "5212:5212"
+     volumes:
+       - temp_data:/data
+       - ./cloudreve/uploads:/cloudreve/uploads
+       - ./cloudreve/conf.ini:/cloudreve/conf.ini
+       - ./cloudreve/cloudreve.db:/cloudreve/cloudreve.db
+       - ./cloudreve/avatar:/cloudreve/avatar
+     depends_on:
+       - aria2
+   aria2:
+     container_name: aria2
+     image: p3terx/aria2-pro
+     restart: unless-stopped
+     environment:
+       -RPC_SECRET=your_aria_rpc_token
+       -RPC_PORT=6800
+     volumes:
+       - ./aria2/config:/config
+       - temp_data:/data
+volumes:
+   temp_data:
+     driver: local
+     driver_opts:
+       type: none
+       device: $PWD/data
+       o: bind
+```
+
+run mirror
+
+```bash
+# Background operation mode, you can get the default administrator account username and password from the docker/docker-compose log
+docker-compose up -d
+
+# Or, run it directly, the log will be output directly in the current console, please note that the current container is running after exiting
+docker-compose up
+```
+
+In the subsequent control panel, configure as follows
+
+1. **[Unmodifiable]** RPC server address => `http://aria2:6800`
+2. **[Can be modified, must be consistent with the docker-compose.yml file]** RPC authorization token => `your_aria_rpc_token`
+3. **[Unmodifiable]** Absolute path on the node where Aria2 is used as temporary download directory => `/data`
+
+### renew
+
+Close the currently running container, this step will not delete the mounted configuration files and related directories
+```bash
+docker-compose down
+```
+
+If the docker image has been pulled before, use the following command to get the latest image
+```bash
+docker pull cloudreve/cloudreve
+```
+
+Just repeat the steps

From 0fe0774c65810d03dff08d8ab0ceea83e38b6c86 Mon Sep 17 00:00:00 2001
From: lk29 <12291632+lk29@users.noreply.github.com>
Date: Wed, 1 Mar 2023 05:15:46 +0500
Subject: [PATCH 24/27] Update SUMMARY.ENG.md

---
 SUMMARY.ENG.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/SUMMARY.ENG.md b/SUMMARY.ENG.md
index aa4853f..2655f86 100644
--- a/SUMMARY.ENG.md
+++ b/SUMMARY.ENG.md
@@ -4,7 +4,7 @@
 
 ## Getting Started <a href="#getting-started" id="getting-started"></a>
 
-* [Quick start](getting-started/install.md)
+* [Quick start](getting-started/install.ENG.md)
 * [configuration file](getting-started/config.md)
 * [Build](getting-started/build.md)
 

From 33af70ac8f567b6646b8fe4ba8f1e1a22b4f208b Mon Sep 17 00:00:00 2001
From: lk29 <12291632+lk29@users.noreply.github.com>
Date: Wed, 1 Mar 2023 05:52:22 +0500
Subject: [PATCH 25/27] Create config.ENG.md

---
 getting-started/config.ENG.md | 198 ++++++++++++++++++++++++++++++++++
 1 file changed, 198 insertions(+)
 create mode 100644 getting-started/config.ENG.md

diff --git a/getting-started/config.ENG.md b/getting-started/config.ENG.md
new file mode 100644
index 0000000..e58f2bd
--- /dev/null
+++ b/getting-started/config.ENG.md
@@ -0,0 +1,198 @@
+# configuration file
+
+## configuration file
+
+When starting for the first time, Cloudreve will create a configuration file named `conf.ini` in the same directory. You can modify this file to configure some parameters. After saving, you need to restart Cloudreve to take effect.
+
+You can also add the `-c` parameter to specify the configuration file path at startup:
+
+```
+./cloudreve -c /path/to/conf.ini
+```
+
+An example of a complete configuration file is as follows:
+
+{% code title="conf.ini" %}
+```ini
+[System]
+; run mode
+Mode = master
+; listening port
+Listen = :5212
+; Whether to enable Debug
+Debug = false
+; Session key, usually automatically generated at first startup
+SessionSecret = 23333
+; Hash plus salt, usually automatically generated at the first startup
+HashIDSalt = something really hard to guss
+; Header to use when presenting client IP
+ProxyHeader = X-Forwarded-For
+
+; SSL related
+[SSL]
+; SSL listening port
+Listen = :443
+; certificate path
+CertPath = C:\Users\i\Documents\fullchain.pem
+; private key path
+KeyPath = C:\Users\i\Documents\privkey.pem
+
+; Enable Unix Socket listening
+[UnixSocket]
+Listen = /run/cloudreve/cloudreve.sock
+; Set the permissions of the generated socket file
+Perm = 0666
+
+; Database related, if you only want to use the built-in SQLite database, delete this part directly
+[Database]
+; Database type, currently supports sqlite/mysql/mssql/postgres
+Type = mysql
+; MySQL port
+Port = 3306
+; username
+User = root
+; password
+Password = root
+; database address
+Host = 127.0.0.1
+; Name database
+Name = v3
+; data table prefix
+TablePrefix = cd_
+; character set
+Charset = utf8mb4
+; SQLite database file path
+DBFile = cloudreve.db
+; The buffer time to safely close the database connection before the process exits
+GracePeriod = 30
+; Connect to database using Unix Socket
+UnixSocket = false
+
+; Configuration in slave mode
+[Slave]
+; communication key
+Secret = 1234567891234567123456789123456712345678912345671234567891234567
+; Callback request timeout (s)
+CallbackTimeout = 20
+; signature validity period
+SignatureTTL = 60
+
+; Cross domain configuration
+[CORS]
+AllowOrigins = *
+AllowMethods = OPTIONS,GET,POST
+AllowHeaders = *
+AllowCredentials = false
+SameSite = Default
+Secure = lse
+
+; Redis related
+[Redis]
+Server=127.0.0.1:6379
+Password =
+DB = 0
+
+; Slave configuration override
+[OptionOverwrite]
+; Can be overridden directly using `setting name=value` format
+max_worker_num = 50
+```
+{% endcode %}
+
+## Configuration example
+
+### Using MySQL
+
+By default, Cloudreve will use the built-in SQLite database and create a database file `cloudreve.db` in the same directory. If you want to use MySQL, please add the following content to the configuration file and restart Cloudreve. Note that Cloudreve only supports MySQL versions greater than or equal to 5.7.
+
+```ini
+[Database]
+; Database type, currently supports sqlite/mysql/mssql/postgres
+Type = mysql
+; MySQL port
+Port = 3306
+; username
+User = root
+; password
+Password = root
+; database address
+Host = 127.0.0.1
+; Name database
+Name = v3
+; data table prefix
+TablePrefix = cd
+; character set
+Charset = utf8
+```
+
+{% hint style="info" %}
+After changing the database configuration, Cloudreve will re-initialize the database, and the original data will be lost.
+{% endhint %}
+
+### Using Redis
+
+You can add Redis related settings in the configuration file:
+
+```ini
+[Redis]
+Server=127.0.0.1:6379
+Password = your password
+DB = 0
+```
+
+{% hint style="info" %}
+Please specify a DB that is not used by other businesses for Cloudreve to avoid conflicts.
+{% endhint %}
+
+After restarting Cloudreve, you can pay attention to the console output to determine whether Cloudreve successfully connected to the Redis server. After using Redis, the following will be taken over by Redis:
+
+* User sessions (login sessions are no longer lost after restarting Cloudreve)
+* Data table high-frequency record query cache (such as storage strategy, setting items)
+* callback session
+* OneDrive Credentials
+
+### Enable HTTPS
+
+{% hint style="info" %}
+If you are using the web server as a reverse proxy to Cloudreve, it is recommended that you configure SSL on the web server. The enabling method described in this section is only valid for the scenario of using Cloudreve's built-in web server.
+{% endhint %}
+
+Add to the configuration file:
+
+```ini
+[SSL]
+Listen = :443
+CertPath = C:\Users\i\Documents\fullchain.pem
+KeyPath = C:\Users\i\Documents\privkey.pem
+```
+
+Where `CertPath` and `KeyPath` are the SSL certificate and private key path respectively. After saving, restart Cloudreve to take effect.
+
+### Override the configuration items of the slave node
+
+Some configuration items of Cloudreve are stored in the database, but the slave node does not connect to the database, you can override the corresponding configuration items in the configuration file.
+
+For example, when the slave node is running as a storage node, you can set the thumbnail specification generated by the slave through the following configuration:
+
+```ini
+[OptionOverwrite]
+thumb_width = 400
+thumb_height = 300
+thumb_file_suffix = ._thumb
+thumb_max_task_count = -1
+thumb_encode_method = jpg
+thumb_gc_after_gen = 0
+thumb_encode_quality = 85
+```
+
+If the slave node is used as an offline download node, you can override the default retry and timeout parameters through the following configuration to avoid file transfer failure due to the default value being too conservative:
+
+```ini
+[OptionOverwrite]
+; The maximum number of tasks that can be executed in parallel in the task queue
+max_worker_num = 50
+; The maximum number of parallel coroutines when the task queue transfers tasks
+max_parallel_transfer = 10
+; The maximum number of retries after the upload of intermediate parts fails
+chunk_retries = 10
+```

From 7184d8ad1d59f719b911ea8424df355b52feaab6 Mon Sep 17 00:00:00 2001
From: lk29 <12291632+lk29@users.noreply.github.com>
Date: Wed, 1 Mar 2023 06:05:33 +0500
Subject: [PATCH 26/27] Create build.ENG.md

---
 getting-started/build.ENG.md | 80 ++++++++++++++++++++++++++++++++++++
 1 file changed, 80 insertions(+)
 create mode 100644 getting-started/build.ENG.md

diff --git a/getting-started/build.ENG.md b/getting-started/build.ENG.md
new file mode 100644
index 0000000..e7fb22e
--- /dev/null
+++ b/getting-started/build.ENG.md
@@ -0,0 +1,80 @@
+# Construct
+
+The Cloudreve project is mainly composed of two parts: the back-end main warehouse [cloudreve/Cloudreve](https://github.com/cloudreve/Cloudreve), and the front-end warehouse [cloudreve/frontend](https://github.com/cloudreve/ front end). Before compiling the Cloudreve backend, you need to build the frontend submodule in the `assets` directory and embed it into the backend repository using [statik](https://github.com/rakyll/statik).
+
+## Environment preparation
+
+1. Refer to [Getting Started - The Go Programming Language](https://golang.org/doc/install) to install and configure the Go language development environment (>=1.18);
+2. Refer to [Download | Node.js](https://nodejs.org/zh-cn/download/) to install Node.js;
+3. Refer to [Install | Yarn](https://classic.yarnpkg.com/zh-Hans/docs/install#windows-stable) to install Yarn;
+
+## start building
+
+### Clone code
+
+```bash
+# Clone repository
+git clone --recurse-submodules https://github.com/cloudreve/Cloudreve.git
+
+# Checkout the version you want to compile
+git checkout 3.x.x
+```
+
+### Build static resources
+
+```bash
+# Enter the front terminal module
+cd assets
+# install dependencies
+yarn install
+# start building
+yarn run build
+# Delete the mapping file after the build is complete
+cd build
+find . -name "*.map" -type f -delete
+# Return to the main directory of the project to package static resources
+cd ../../
+zip -r -assets/build >assets.zip
+```
+
+After completion, the built static resource files are located in the `assets/build` directory.
+
+You can rename this directory to the `statics` directory, place it in the same directory as the main Cloudreve program and restart Cloudreve, Cloudreve will use the static resource files in this directory instead of the built-in ones.
+
+### Compile the project
+
+```bash
+# Return to the project main directory
+cd ../
+
+# Get the current version number, Commit
+export COMMIT_SHA=$(git rev-parse --short HEAD)
+export VERSION=$(git describe --tags)
+
+# start compiling
+go build -a -o cloudreve -ldflags " -X 'github.com/cloudreve/Cloudreve/v3/pkg/conf.BackendVersion=$VERSION' -X 'github.com/cloudreve/Cloudreve/v3/pkg/conf.LastCommit =$COMMIT_SHA'"
+```
+
+{% hint style="info" %}
+When compiling for the first time, Go will download related dependent libraries. If your network environment is not good, this step may be too slow or fail. You can use [GOPROXY.IO](https://goproxy.io/zh/) to speed up module downloading.
+{% endhint %}
+
+After the compilation is complete, the final executable file `cloudreve` will be generated in the project root directory.
+
+## Build helpers
+
+You can use [goreleaser](https://goreleaser.com/intro/) to quickly complete operations such as building and packaging, as follows:
+
+```bash
+# install goreleaser
+go install github.com/goreleaser/goreleaser@latest
+
+# Build the project
+goreleaser build --clean --single-target --snapshot
+```
+
+Or cross compile all available versions:
+
+```sh
+goreleaser build --clean --snapshot
+```

From 36b2d21376f8419bcf2a1af30b96361d339c8c06 Mon Sep 17 00:00:00 2001
From: lk29 <12291632+lk29@users.noreply.github.com>
Date: Wed, 1 Mar 2023 06:15:52 +0500
Subject: [PATCH 27/27] Update SUMMARY.ENG.md

---
 SUMMARY.ENG.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/SUMMARY.ENG.md b/SUMMARY.ENG.md
index 2655f86..a9a2244 100644
--- a/SUMMARY.ENG.md
+++ b/SUMMARY.ENG.md
@@ -5,8 +5,8 @@
 ## Getting Started <a href="#getting-started" id="getting-started"></a>
 
 * [Quick start](getting-started/install.ENG.md)
-* [configuration file](getting-started/config.md)
-* [Build](getting-started/build.md)
+* [configuration file](getting-started/config.ENG.md)
+* [Build](getting-started/build.ENG.md)
 
 ## Use <a href="#use" id="use"></a>