Skip to content

Commit 4e471e7

Browse files
HFO4gitbook-bot
HFO4
authored and
gitbook-bot
committed
GitBook: [#47] No subject
1 parent a4e18c7 commit 4e471e7

File tree

4 files changed

+54
-47
lines changed

4 files changed

+54
-47
lines changed

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,4 @@ Cloudreve 可以让您快速搭建起公私兼备的网盘系统。Cloudreve 在
2525

2626
或是与开发者联系：
2727

28-
 Email：[abslant@foxmail.com](mailto:abslant@foxmail.com)
28+
 Email：[abslant.liu@gmail.com](mailto:abslant.liu@gmail.com)

‎getting-started/build.md‎

Lines changed: 4 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,9 @@ Cloudreve 项目主要由两部分组成：后端主仓库 [cloudreve/Cloudreve]
44

55
## 环境准备
66

7-
1. 参照 [Getting Started - The Go Programming Language](https://golang.org/doc/install) 安装并配置Go语言开发环境；
8-
2. 参考 [下载 \| Node.js](https://nodejs.org/zh-cn/download/) 安装 Node.js;
9-
3. 参考 [安装 \| Yarn](https://classic.yarnpkg.com/zh-Hans/docs/install#windows-stable) 安装Yarn;
10-
4. 执行 `go get github.com/rakyll/statik` 安装statik 命令行工具;
7+
1. 参照 [Getting Started - The Go Programming Language](https://golang.org/doc/install) 安装并配置 Go 语言开发环境 (>=1.17)；
8+
2. 参考 [下载 | Node.js](https://nodejs.org/zh-cn/download/) 安装 Node.js;
9+
3. 参考 [安装 | Yarn](https://classic.yarnpkg.com/zh-Hans/docs/install#windows-stable) 安装Yarn;
1110

1211
## 开始构建
1312

@@ -36,28 +35,12 @@ yarn run build
3635

3736
你可以将此目录改名为`statics` 目录，放置在 Cloudreve 主程序同级目录下并重启 Cloudreve，Cloudreve 将会使用此目录下的静态资源文件，而非内置的。
3837

39-
### 嵌入静态资源
38+
### 编译项目
4039

4140
```bash
4241
# 回到项目主目录
4342
cd ../
4443

45-
# 安装 statik, 用于嵌入静态资源
46-
go get github.com/rakyll/statik
47-
48-
# 开始嵌入
49-
statik -src=assets/build/ -include=*.html,*.js,*.json,*.css,*.png,*.svg,*.ico,*.ttf -f
50-
```
51-
52-
{% hint style="info" %}
53-
如果在嵌入时找不到`statik` 命令，请尝试执行：
54-
55-
`export PATH=$PATH:$(go env GOPATH)/bin`
56-
{% endhint %}
57-
58-
### 编译项目
59-
60-
```bash
6144
# 获得当前版本号、Commit
6245
export COMMIT_SHA=$(git rev-parse --short HEAD)
6346
export VERSION=$(git describe --tags)
@@ -98,4 +81,3 @@ export CGO_ENABLED=1
9881

9982
go build
10083
```
101-

‎getting-started/config.md‎

Lines changed: 44 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@
1212

1313
一个完整的配置文件示例如下：
1414

15-
```d
15+
{% code title="conf.ini" %}
16+
```ini
1617
[System]
1718
; 运行模式
1819
Mode = master
@@ -81,26 +82,20 @@ Server = 127.0.0.1:6379
8182
Password =
8283
DB = 0
8384

84-
; 缩略图
85-
[Thumbnail]
86-
MaxWidth = 400
87-
MaxHeight = 300
88-
FileSuffix = ._thumb
89-
; 最大并行执行缩略图生成的数量，填写 -1 时会根据 CPU 核心数自动决定
90-
MaxTaskCount = -1
91-
; 可填写 jpg / png
92-
EncodeMethod = jpg
93-
; 是否在缩略图生成完毕后立刻进行垃圾回收
94-
GCAfterGen = false
95-
; 缩略图质量
96-
EncodeQuality = 85
85+
; 从机配置覆盖
86+
[OptionOverwrite]
87+
; 可直接使用 `设置名称 = 值` 的格式覆盖
88+
max_worker_num = 50
9789
```
90+
{% endcode %}
9891

99-
## 使用 MySQL
92+
## 配置案例
93+
94+
### 使用 MySQL
10095

10196
默认情况下，Cloudreve 会使用内置的 SQLite 数据库，并在同级目录创建数据库文件`cloudreve.db`，如果您想要使用 MySQL，请在配置文件中加入以下内容，并重启 Cloudreve。注意，Cloudreve 只支持大于或等于 5.7 版本的 MySQL 。
10297

103-
```
98+
```ini
10499
[Database]
105100
; 数据库类型，目前支持 sqlite/mysql/mssql/postgres
106101
Type = mysql
@@ -124,11 +119,11 @@ Charset = utf8
124119
更换数据库配置后，Cloudreve 会重新初始化数据库，原有的数据将会丢失。
125120
{% endhint %}
126121

127-
## 使用 Redis
122+
### 使用 Redis
128123

129124
你可以在配置文件中加入 Redis 相关设置：
130125

131-
```
126+
```ini
132127
[Redis]
133128
Server = 127.0.0.1:6379
134129
Password = your password
@@ -146,19 +141,48 @@ DB = 0
146141
* 回调会话
147142
* OneDrive 凭证
148143

149-
## 启用 HTTPS
144+
### 启用 HTTPS
150145

151146
{% hint style="info" %}
152147
如果您正在使用 Web 服务器反向代理 Cloudreve，推荐您在 Web 服务器中配置 SSL，本小节所阐述的启用方式只针对使用 Cloudreve 内置 Web 服务器的情境下有效。
153148
{% endhint %}
154149

155150
在配置配置文件中加入：
156151

157-
```
152+
```ini
158153
[SSL]
159154
Listen = :443
160155
CertPath = C:\Users\i\Documents\fullchain.pem
161156
KeyPath = C:\Users\i\Documents\privkey.pem
162157
```
163158

164159
其中 `CertPath` 和`KeyPath` 分别为 SSL 证书和私钥路径。保存后重启 Cloudreve 生效。
160+
161+
### 覆盖从机节点的配置项
162+
163+
Cloudreve 的某些配置项时存储测在数据库中的，但是从机机点并不会连接数据库，你可以在配置文件中覆盖响应的配置项。
164+
165+
比如，从机节点作为存储端运行时，你可以通过下面的配置设定从机生成的缩略图规格：
166+
167+
```ini
168+
[OptionOverwrite]
169+
thumb_width = 400
170+
thumb_height = 300
171+
thumb_file_suffix = ._thumb
172+
thumb_max_task_count = -1
173+
thumb_encode_method = jpg
174+
thumb_gc_after_gen = 0
175+
thumb_encode_quality = 85
176+
```
177+
178+
如果从机端作为离线下载节点使用，你可以通过下面的配置覆盖默认的重试、超时参数，以避免默认的数值过于保守导致文件转存失败：
179+
180+
```ini
181+
[OptionOverwrite]
182+
; 任务队列最多并行执行的任务数
183+
max_worker_num = 50
184+
; 任务队列中转任务传输时，最大并行协程数
185+
max_parallel_transfer = 10
186+
; 中转分片上传失败后重试的最大次数
187+
chunk_retries = 10
188+
```

‎use/policy/compare.md‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ Cloudreve 支持多种底层存储策略，但是由于 API 限制等各方面
44

55
## 基本对比
66

7-
| | 本机 | 从机 | 七牛 | OSS | COS | 又拍云 | OneDrive | S3 |
8-
| --------- | :------------------: | :------------------: | :------------------: | :------------------: | :-------------------: | :------------------: | :------------------: | -------------------- |
97
| 上传 | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: |
8+
| --------- | :------------------: | :------------------: | :------------------: | :------------------: | :-------------------: | :------------------: | :------------------: | -------------------- |
9+
| 分片上传 | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :x: | :x: | :white\_check\_mark: | :white\_check\_mark: |
1010
| 下载 | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: |
1111
| 复制 | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: |
1212
| 移动 | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: |
@@ -16,8 +16,9 @@ Cloudreve 支持多种底层存储策略，但是由于 API 限制等各方面
1616
| 缩略图 | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :x: |
1717
| 打包下载 | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: |
1818
| 真实文件名下载 | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :x: | :white\_check\_mark: |
19-
| 理论最大文件 | 无限 | 无限 | 无限 | 5GB | 5GB | 150GB | 未知 | 未知 |
19+
| 理论最大文件 | 无限 | 无限 | 无限 | 无限 | 5GB | 150GB | 未知 | 无限 |
2020
| 公网接入要求 | 无 | 无 | 需要 | 需要 | 需要 | 需要 | 需要 | 需要 |
21+
| 可用于对公使用 | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | 以 ToS 为准 | :x: |
2122

2223
## 高级功能
2324

@@ -34,7 +35,7 @@ Cloudreve 支持多种底层存储策略，但是由于 API 限制等各方面
3435

3536
| | 本机 | 从机 | 七牛 | OSS | COS | 又拍云 | OneDrive | S3 |
3637
| ----------- | -------------------- | -------------------- | -------------------- | -------------------- | -------------------- | -------------------- | -------------------- | -------------------- |
37-
| Web 上传客户端直传 | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | >= 4MB 时直传 | :white\_check\_mark: |
38+
| Web 上传客户端直传 | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: |
3839
| 下载直传 | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: | :white\_check\_mark: |
3940
| 打包下载/压缩/解压缩 | 直传 | 中转 | 中转 | 中转 | 中转 | 中转 | 中转 | 中转 |
4041
| 离线下载 | 直传 | 中转 | 中转 | 中转 | 中转 | 中转 | 中转 | 中转 |

0 commit comments

Comments
 (0)