From 49370397d3a75982046fb9f8f08ca78370d96772 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E4=B9=85=E6=B2=BB=E6=98=8E=E5=8D=83=E6=A0=91=E6=B1=90?= Date: Wed, 1 Jun 2022 00:24:56 +0800 Subject: [PATCH 1/3] fix: fixed some formatting errors and identified typos MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 修正部分格式错误与可以确定的错别字 --- getting-started/build.md | 6 +++--- getting-started/config.md | 10 +++++----- getting-started/install.md | 4 ++-- use/aria2.md | 2 +- use/zi-ding-yi-qian-duan.md | 2 +- 5 files changed, 12 insertions(+), 12 deletions(-) diff --git a/getting-started/build.md b/getting-started/build.md index 650586b..393a0eb 100644 --- a/getting-started/build.md +++ b/getting-started/build.md @@ -1,12 +1,12 @@ # 构建 -Cloudreve 项目主要由两部分组成：后端主仓库 [cloudreve/Cloudreve](https://github.com/cloudreve/Cloudreve)，以及前端仓库 [cloudreve/frontend](https://github.com/cloudreve/frontend)。编译 Cloudreve 后端前，需要先构建`assets` 目录下的前端子模块，并使用[statik](https://github.com/rakyll/statik)嵌入到后端仓库。 +Cloudreve 项目主要由两部分组成：后端主仓库 [cloudreve/Cloudreve](https://github.com/cloudreve/Cloudreve)，以及前端仓库 [cloudreve/frontend](https://github.com/cloudreve/frontend)。编译 Cloudreve 后端前，需要先构建`assets` 目录下的前端子模块，并使用 [statik](https://github.com/rakyll/statik) 嵌入到后端仓库。 ## 环境准备 1. 参照 [Getting Started - The Go Programming Language](https://golang.org/doc/install) 安装并配置 Go 语言开发环境 (>=1.17)； 2. 参考 [下载 | Node.js](https://nodejs.org/zh-cn/download/) 安装 Node.js; -3. 参考 [安装 | Yarn](https://classic.yarnpkg.com/zh-Hans/docs/install#windows-stable) 安装Yarn; +3. 参考 [安装 | Yarn](https://classic.yarnpkg.com/zh-Hans/docs/install#windows-stable) 安装 Yarn; ## 开始构建 @@ -69,7 +69,7 @@ go build -a -o cloudreve -ldflags " -X 'github.com/cloudreve/Cloudreve/v3/pkg/co ## 交叉编译 -交叉编译前，你需要启用`CGO` ，正确安装目标平台的 GCC 工具链，并将`CC` 环境变量设定为对应平台的GCC 编译工具。 +交叉编译前，你需要启用`CGO` ，正确安装目标平台的 GCC 工具链，并将`CC` 环境变量设定为对应平台的 GCC 编译工具。 比如，在 Linux/AMD64 宿主平台上交叉编译 Windows/AMD64： diff --git a/getting-started/config.md b/getting-started/config.md index 3c78882..58e5271 100644 --- a/getting-started/config.md +++ b/getting-started/config.md @@ -39,7 +39,7 @@ KeyPath = C:\Users\i\Documents\privkey.pem [UnixSocket] Listen = /run/cloudreve/cloudreve.sock -; 数据库相关，如果你只想使用内置的 SQLite数据库，这一部分直接删去即可 +; 数据库相关，如果你只想使用内置的 SQLite 数据库，这一部分直接删去即可 [Database] ; 数据库类型，目前支持 sqlite/mysql/mssql/postgres Type = mysql @@ -136,7 +136,7 @@ DB = 0 重启 Cloudreve 后，可注意控制台输出，确定 Cloudreve 是否成功连接 Redis 服务器。使用 Redis 后，以下内容将被 Redis 接管： -* 用户会话（重启Cloudreve后不会再丢失登录会话） +* 用户会话（重启 Cloudreve 后不会再丢失登录会话） * 数据表高频记录查询缓存（如存储策略、设置项） * 回调会话 * OneDrive 凭证 @@ -147,7 +147,7 @@ DB = 0 如果您正在使用 Web 服务器反向代理 Cloudreve，推荐您在 Web 服务器中配置 SSL，本小节所阐述的启用方式只针对使用 Cloudreve 内置 Web 服务器的情境下有效。 {% endhint %} -在配置配置文件中加入： +在配置文件中加入： ```ini [SSL] @@ -160,7 +160,7 @@ KeyPath = C:\Users\i\Documents\privkey.pem ### 覆盖从机节点的配置项 -Cloudreve 的某些配置项时存储测在数据库中的，但是从机机点并不会连接数据库，你可以在配置文件中覆盖响应的配置项。 +Cloudreve 的某些配置项是存储在数据库中的，但是从机节点并不会连接数据库，你可以在配置文件中覆盖相应的配置项。 比如，从机节点作为存储端运行时，你可以通过下面的配置设定从机生成的缩略图规格： @@ -175,7 +175,7 @@ thumb_gc_after_gen = 0 thumb_encode_quality = 85 ``` -如果从机端作为离线下载节点使用，你可以通过下面的配置覆盖默认的重试、超时参数，以避免默认的数值过于保守导致文件转存失败： +如果从机节点作为离线下载节点使用，你可以通过下面的配置覆盖默认的重试、超时参数，以避免默认的数值过于保守导致文件转存失败： ```ini [OptionOverwrite] diff --git a/getting-started/install.md b/getting-started/install.md index 1868610..27c3f2f 100644 --- a/getting-started/install.md +++ b/getting-started/install.md @@ -257,7 +257,7 @@ environment=CODENATION_ENV=prod 其中以下配置项需要根据实际情况更改： -- `directory`: Clopudreve 主程序所在目录 +- `directory`: Cloudreve 主程序所在目录 - `command`: Cloudreve 主程序绝对路径 - `stderr_logfile`: 错误日志路径 - `stdout_logfile`: 通常日志路径 @@ -305,7 +305,7 @@ mkdir -vp cloudreve/{uploads,avatar} \ ### 运行 -然后，运行 docker container: +然后，运行 docker container： ```bash docker run -d \ diff --git a/use/aria2.md b/use/aria2.md index e628ea9..243ac25 100644 --- a/use/aria2.md +++ b/use/aria2.md @@ -39,7 +39,7 @@ Aria2 RPC 服务器的地址，一般可填写为`http://127.0.0.1:6800/` 。其 **RPC Secret** -上文中您在 Aria2 配置文件中设定的 RPC 授权令牌 +上文中您在 Aria2 配置文件中设定的 RPC 授权令牌。 **临时下载目录** diff --git a/use/zi-ding-yi-qian-duan.md b/use/zi-ding-yi-qian-duan.md index f0c1fa9..208eac6 100644 --- a/use/zi-ding-yi-qian-duan.md +++ b/use/zi-ding-yi-qian-duan.md @@ -1,6 +1,6 @@ # 自定义前端 -默认情况下，Cloudreve 会使用内置的静态资源文件，包括 HTML文档、JS脚本、CSS、图像资源等。如果您需要使用自己个性化修改后的静态资源，请将[前端仓库](https://github.com/cloudreve/frontend)编译编译得到的`build` 目录重命名为`statics` 并置于 Cloudreve 同级目录下，重启 Cloudreve 后生效。 +默认情况下，Cloudreve 会使用内置的静态资源文件，包括 HTML 文档、JS 脚本、CSS、图像资源等。如果您需要使用自己个性化修改后的静态资源，请将[前端仓库](https://github.com/cloudreve/frontend)编译编译得到的`build` 目录重命名为`statics` 并置于 Cloudreve 同级目录下，重启 Cloudreve 后生效。 有关前端仓库的构建流程，请参阅以下章节： From 387168da9f4512cf36d3cf3474942d50f395eb06 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E4=B9=85=E6=B2=BB=E6=98=8E=E5=8D=83=E6=A0=91=E6=B1=90?= Date: Wed, 1 Jun 2022 00:31:52 +0800 Subject: [PATCH 2/3] fix: never use UTF-8 in MySQL --- getting-started/config.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/getting-started/config.md b/getting-started/config.md index 58e5271..a69e915 100644 --- a/getting-started/config.md +++ b/getting-started/config.md @@ -56,7 +56,7 @@ Name = v3 ; 数据表前缀 TablePrefix = cd_ ; 字符集 -Charset = utf8 +Charset = utf8mb4 ; SQLite 数据库文件路径 DBFile = cloudreve.db From e488e709785c5d14e7dd6fe9a13b21752d53dace Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E4=B9=85=E6=B2=BB=E6=98=8E=E5=8D=83=E6=A0=91=E6=B1=90?= Date: Wed, 1 Jun 2022 00:35:47 +0800 Subject: [PATCH 3/3] docs: prevent ambiguity https://github.com/cloudreve/docs/issues/13 --- getting-started/config.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/getting-started/config.md b/getting-started/config.md index a69e915..7ea6a8c 100644 --- a/getting-started/config.md +++ b/getting-started/config.md @@ -18,7 +18,7 @@ ; 运行模式 Mode = master ; 监听端口 -Listen = :5000 +Listen = :5212 ; 是否开启 Debug Debug = false ; Session 密钥, 一般在首次启动时自动生成