Skip to content

Commit aa9b25e

Browse files
authored
fix: fixed some formatting errors and identified typos (#15)
* fix: fixed some formatting errors and identified typos 修正部分格式错误与可以确定的错别字 * fix: never use UTF-8 in MySQL * docs: prevent ambiguity #13
1 parent d3e35ee commit aa9b25e

File tree

5 files changed

+14
-14
lines changed

5 files changed

+14
-14
lines changed

getting-started/build.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# 构建
22

3-
Cloudreve 项目主要由两部分组成:后端主仓库 [cloudreve/Cloudreve](https://github.com/cloudreve/Cloudreve),以及前端仓库 [cloudreve/frontend](https://github.com/cloudreve/frontend)。编译 Cloudreve 后端前,需要先构建`assets` 目录下的前端子模块,并使用[statik](https://github.com/rakyll/statik)嵌入到后端仓库。
3+
Cloudreve 项目主要由两部分组成:后端主仓库 [cloudreve/Cloudreve](https://github.com/cloudreve/Cloudreve),以及前端仓库 [cloudreve/frontend](https://github.com/cloudreve/frontend)。编译 Cloudreve 后端前,需要先构建`assets` 目录下的前端子模块,并使用 [statik](https://github.com/rakyll/statik) 嵌入到后端仓库。
44

55
## 环境准备
66

77
1. 参照 [Getting Started - The Go Programming Language](https://golang.org/doc/install) 安装并配置 Go 语言开发环境 (>=1.17);
88
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;
9+
3. 参考 [安装 | Yarn](https://classic.yarnpkg.com/zh-Hans/docs/install#windows-stable) 安装 Yarn;
1010

1111
## 开始构建
1212

@@ -69,7 +69,7 @@ go build -a -o cloudreve -ldflags " -X 'github.com/cloudreve/Cloudreve/v3/pkg/co
6969

7070
## 交叉编译
7171

72-
交叉编译前,你需要启用`CGO` ,正确安装目标平台的 GCC 工具链,并将`CC` 环境变量设定为对应平台的GCC 编译工具。
72+
交叉编译前,你需要启用`CGO` ,正确安装目标平台的 GCC 工具链,并将`CC` 环境变量设定为对应平台的 GCC 编译工具。
7373

7474
比如,在 Linux/AMD64 宿主平台上交叉编译 Windows/AMD64:
7575

getting-started/config.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
; 运行模式
1919
Mode = master
2020
; 监听端口
21-
Listen = :5000
21+
Listen = :5212
2222
; 是否开启 Debug
2323
Debug = false
2424
; Session 密钥, 一般在首次启动时自动生成
@@ -39,7 +39,7 @@ KeyPath = C:\Users\i\Documents\privkey.pem
3939
[UnixSocket]
4040
Listen = /run/cloudreve/cloudreve.sock
4141

42-
; 数据库相关,如果你只想使用内置的 SQLite数据库,这一部分直接删去即可
42+
; 数据库相关,如果你只想使用内置的 SQLite 数据库,这一部分直接删去即可
4343
[Database]
4444
; 数据库类型,目前支持 sqlite/mysql/mssql/postgres
4545
Type = mysql
@@ -56,7 +56,7 @@ Name = v3
5656
; 数据表前缀
5757
TablePrefix = cd_
5858
; 字符集
59-
Charset = utf8
59+
Charset = utf8mb4
6060
; SQLite 数据库文件路径
6161
DBFile = cloudreve.db
6262

@@ -136,7 +136,7 @@ DB = 0
136136

137137
重启 Cloudreve 后,可注意控制台输出,确定 Cloudreve 是否成功连接 Redis 服务器。使用 Redis 后,以下内容将被 Redis 接管:
138138

139-
* 用户会话(重启Cloudreve后不会再丢失登录会话
139+
* 用户会话(重启 Cloudreve 后不会再丢失登录会话
140140
* 数据表高频记录查询缓存(如存储策略、设置项)
141141
* 回调会话
142142
* OneDrive 凭证
@@ -147,7 +147,7 @@ DB = 0
147147
如果您正在使用 Web 服务器反向代理 Cloudreve,推荐您在 Web 服务器中配置 SSL,本小节所阐述的启用方式只针对使用 Cloudreve 内置 Web 服务器的情境下有效。
148148
{% endhint %}
149149

150-
在配置配置文件中加入
150+
在配置文件中加入
151151

152152
```ini
153153
[SSL]
@@ -160,7 +160,7 @@ KeyPath = C:\Users\i\Documents\privkey.pem
160160

161161
### 覆盖从机节点的配置项
162162

163-
Cloudreve 的某些配置项时存储测在数据库中的,但是从机机点并不会连接数据库,你可以在配置文件中覆盖响应的配置项
163+
Cloudreve 的某些配置项是存储在数据库中的,但是从机节点并不会连接数据库,你可以在配置文件中覆盖相应的配置项
164164

165165
比如,从机节点作为存储端运行时,你可以通过下面的配置设定从机生成的缩略图规格:
166166

@@ -175,7 +175,7 @@ thumb_gc_after_gen = 0
175175
thumb_encode_quality = 85
176176
```
177177

178-
如果从机端作为离线下载节点使用,你可以通过下面的配置覆盖默认的重试、超时参数,以避免默认的数值过于保守导致文件转存失败:
178+
如果从机节点作为离线下载节点使用,你可以通过下面的配置覆盖默认的重试、超时参数,以避免默认的数值过于保守导致文件转存失败:
179179

180180
```ini
181181
[OptionOverwrite]

getting-started/install.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -257,7 +257,7 @@ environment=CODENATION_ENV=prod
257257

258258
其中以下配置项需要根据实际情况更改:
259259

260-
- `directory`: Clopudreve 主程序所在目录
260+
- `directory`: Cloudreve 主程序所在目录
261261
- `command`: Cloudreve 主程序绝对路径
262262
- `stderr_logfile`: 错误日志路径
263263
- `stdout_logfile`: 通常日志路径
@@ -305,7 +305,7 @@ mkdir -vp cloudreve/{uploads,avatar} \
305305

306306
### 运行
307307

308-
然后,运行 docker container:
308+
然后,运行 docker container
309309

310310
```bash
311311
docker run -d \

use/aria2.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Aria2 RPC 服务器的地址,一般可填写为`http://127.0.0.1:6800/` 。其
3939

4040
**RPC Secret**
4141

42-
上文中您在 Aria2 配置文件中设定的 RPC 授权令牌
42+
上文中您在 Aria2 配置文件中设定的 RPC 授权令牌
4343

4444
**临时下载目录**
4545

use/zi-ding-yi-qian-duan.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# 自定义前端
22

3-
默认情况下,Cloudreve 会使用内置的静态资源文件,包括 HTML文档、JS脚本、CSS、图像资源等。如果您需要使用自己个性化修改后的静态资源,请将[前端仓库](https://github.com/cloudreve/frontend)编译编译得到的`build` 目录重命名为`statics` 并置于 Cloudreve 同级目录下,重启 Cloudreve 后生效。
3+
默认情况下,Cloudreve 会使用内置的静态资源文件,包括 HTML 文档、JS 脚本、CSS、图像资源等。如果您需要使用自己个性化修改后的静态资源,请将[前端仓库](https://github.com/cloudreve/frontend)编译编译得到的`build` 目录重命名为`statics` 并置于 Cloudreve 同级目录下,重启 Cloudreve 后生效。
44

55
有关前端仓库的构建流程,请参阅以下章节:
66

0 commit comments

Comments
 (0)