Skip to content

Commit b0c5f9f

Browse files
committed
chore: add config list reference
1 parent 9eb4a1a commit b0c5f9f

File tree

2 files changed

+58
-36
lines changed
  • docs/developer-guide/plugin/basics
  • versioned_docs/version-2.20/developer-guide/plugin/basics

2 files changed

+58
-36
lines changed

docs/developer-guide/plugin/basics/devtools.md

+29-18
Original file line numberDiff line numberDiff line change
@@ -103,15 +103,22 @@ halo {
103103

104104
## 任务
105105

106-
本插件提供了 haloServer 和 watch 两个任务,使用 haloServer 和 watch 这两个任务的前提条件是需要具有 Docker 环境。
106+
本插件提供了 `haloServer``watch` 两个任务,使用它们的前提条件是需要在本地配置 Docker 环境。
107107

108-
对于 Windows 和 Mac 用户,可以直接安装 Docker Desktop,对于 Linux 用户,可以参考 [Docker 官方文档](https://docs.docker.com/engine/install/) 安装 Docker。
108+
### 环境要求
109109

110-
然后启动 Docker 服务,即可使用 haloServer 和 watch 任务。
110+
- **Windows 和 Mac 用户**:可以直接安装 [Docker Desktop](https://www.docker.com/products/docker-desktop)
111+
- **Linux 用户**:请参考 [Docker 官方文档](https://docs.docker.com/engine/install/) 安装 Docker。
111112

112-
这两个任务会将 Halo 的工作目录挂在到插件项目的 `workplace` 目录下,以确保重启任务时不会丢失数据
113+
确保 Docker 服务已启动后,即可运行 `haloServer``watch` 任务
113114

114-
如果你想要修改 Halo 的配置,可以在 `workplace` 目录下创建一个 `config` 目录并添加一个 `application.yaml` 文件,然后在此文件中添加 Halo 的配置以覆盖 Halo 的 `default` 配置, 如:
115+
### 工作目录
116+
117+
这两个任务会将 Halo 的工作目录挂载到插件项目的 `workplace` 目录下,以确保在重启任务时数据不会丢失。
118+
119+
### 自定义配置
120+
121+
如果需要修改 Halo 的配置,您可以在 `workplace` 目录下创建一个 `config` 目录,并添加一个 `application.yaml` 文件。在该文件中,您可以覆盖 Halo 的默认配置。例如:
115122

116123
```yaml
117124
# workplace/config/application.yaml
@@ -120,7 +127,21 @@ logging:
120127
run.halo.app: DEBUG
121128
```
122129
123-
Halo 使用的缺省配置如下:
130+
更多配置项请参考 [Halo 配置列表](../../../getting-started/install/config.md#配置列表)。
131+
132+
### haloServer 任务
133+
134+
使用方式:
135+
136+
```shell
137+
./gradlew haloServer
138+
```
139+
140+
此任务用于启动 Halo 服务并自动将使用此 Gradle 插件的 Halo 插件项目以开发模式加载到 Halo 服务中,当你修改了插件的代码后,可以通过 `reload` 任务使更改生效。
141+
142+
#### haloServer 任务默认配置
143+
144+
`haloServer` 任务具有以下默认配置用于连接和操作 Halo 服务:
124145

125146
```groovy
126147
halo {
@@ -129,24 +150,14 @@ halo {
129150
superAdminPassword = 'admin'
130151
externalUrl = 'http://localhost:8090'
131152
docker {
132-
// windows 默认为 npipe:////./pipe/docker_engine
153+
// Windows 用户默认使用 npipe:////./pipe/docker_engine
133154
url = 'unix:///var/run/docker.sock'
134155
apiVersion = '1.42'
135156
}
136157
}
137158
```
138159

139-
如需修改,你可以在 `build.gradle` 配置。
140-
141-
### haloServer 任务
142-
143-
使用方式:
144-
145-
```shell
146-
./gradlew haloServer
147-
```
148-
149-
此任务用于启动 Halo 服务并自动将使用此 Gradle 插件的 Halo 插件项目以开发模式加载到 Halo 服务中,当你修改了插件的代码后,可以通过 `reload` 任务使更改生效。
160+
如需修改,可以在 `build.gradle` 文件中进行配置。
150161

151162
### reload 任务
152163

versioned_docs/version-2.20/developer-guide/plugin/basics/devtools.md

+29-18
Original file line numberDiff line numberDiff line change
@@ -103,15 +103,22 @@ halo {
103103

104104
## 任务
105105

106-
本插件提供了 haloServer 和 watch 两个任务,使用 haloServer 和 watch 这两个任务的前提条件是需要具有 Docker 环境。
106+
本插件提供了 `haloServer``watch` 两个任务,使用它们的前提条件是需要在本地配置 Docker 环境。
107107

108-
对于 Windows 和 Mac 用户,可以直接安装 Docker Desktop,对于 Linux 用户,可以参考 [Docker 官方文档](https://docs.docker.com/engine/install/) 安装 Docker。
108+
### 环境要求
109109

110-
然后启动 Docker 服务,即可使用 haloServer 和 watch 任务。
110+
- **Windows 和 Mac 用户**:可以直接安装 [Docker Desktop](https://www.docker.com/products/docker-desktop)
111+
- **Linux 用户**:请参考 [Docker 官方文档](https://docs.docker.com/engine/install/) 安装 Docker。
111112

112-
这两个任务会将 Halo 的工作目录挂在到插件项目的 `workplace` 目录下,以确保重启任务时不会丢失数据
113+
确保 Docker 服务已启动后,即可运行 `haloServer``watch` 任务
113114

114-
如果你想要修改 Halo 的配置,可以在 `workplace` 目录下创建一个 `config` 目录并添加一个 `application.yaml` 文件,然后在此文件中添加 Halo 的配置以覆盖 Halo 的 `default` 配置, 如:
115+
### 工作目录
116+
117+
这两个任务会将 Halo 的工作目录挂载到插件项目的 `workplace` 目录下,以确保在重启任务时数据不会丢失。
118+
119+
### 自定义配置
120+
121+
如果需要修改 Halo 的配置,您可以在 `workplace` 目录下创建一个 `config` 目录,并添加一个 `application.yaml` 文件。在该文件中,您可以覆盖 Halo 的默认配置。例如:
115122

116123
```yaml
117124
# workplace/config/application.yaml
@@ -120,7 +127,21 @@ logging:
120127
run.halo.app: DEBUG
121128
```
122129
123-
Halo 使用的缺省配置如下:
130+
更多配置项请参考 [Halo 配置列表](../../../getting-started/install/config.md#配置列表)。
131+
132+
### haloServer 任务
133+
134+
使用方式:
135+
136+
```shell
137+
./gradlew haloServer
138+
```
139+
140+
此任务用于启动 Halo 服务并自动将使用此 Gradle 插件的 Halo 插件项目以开发模式加载到 Halo 服务中,当你修改了插件的代码后,可以通过 `reload` 任务使更改生效。
141+
142+
#### haloServer 任务默认配置
143+
144+
`haloServer` 任务具有以下默认配置用于连接和操作 Halo 服务:
124145

125146
```groovy
126147
halo {
@@ -129,24 +150,14 @@ halo {
129150
superAdminPassword = 'admin'
130151
externalUrl = 'http://localhost:8090'
131152
docker {
132-
// windows 默认为 npipe:////./pipe/docker_engine
153+
// Windows 用户默认使用 npipe:////./pipe/docker_engine
133154
url = 'unix:///var/run/docker.sock'
134155
apiVersion = '1.42'
135156
}
136157
}
137158
```
138159

139-
如需修改,你可以在 `build.gradle` 配置。
140-
141-
### haloServer 任务
142-
143-
使用方式:
144-
145-
```shell
146-
./gradlew haloServer
147-
```
148-
149-
此任务用于启动 Halo 服务并自动将使用此 Gradle 插件的 Halo 插件项目以开发模式加载到 Halo 服务中,当你修改了插件的代码后,可以通过 `reload` 任务使更改生效。
160+
如需修改,可以在 `build.gradle` 文件中进行配置。
150161

151162
### reload 任务
152163

0 commit comments

Comments
 (0)