Skip to content

Commit e431bdc

Browse files
ruibabyruibaby
authored
docs: update documentation for Halo 2.18 (#407)
Signed-off-by: Ryan Wang <[email protected]>
1 parent 9d7d609 commit e431bdc

File tree

184 files changed

+15316
-84
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

184 files changed

+15316
-84
lines changed

‎docs/developer-guide/core/build.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ git checkout ${branch_name}
3333

3434
## 构建 Fat Jar
3535

36-
构建之前需要修改 `gradle.properties` 中的 `version` 属性（推荐遵循 [SemVer 规范](https://semver.org/)），例如：`version=2.18.0`
36+
构建之前需要修改 `gradle.properties` 中的 `version` 属性（推荐遵循 [SemVer 规范](https://semver.org/)），例如：`version=2.19.0`
3737

3838
```bash
3939
cd path/to/halo

‎docs/getting-started/install/docker-compose.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
5252

5353
services:
5454
halo:
55-
image: registry.fit2cloud.com/halo/halo:2.18
55+
image: registry.fit2cloud.com/halo/halo:2.19
5656
restart: on-failure:3
5757
depends_on:
5858
halodb:
@@ -108,7 +108,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
108108

109109
services:
110110
halo:
111-
image: registry.fit2cloud.com/halo/halo:2.18
111+
image: registry.fit2cloud.com/halo/halo:2.19
112112
restart: on-failure:3
113113
depends_on:
114114
halodb:
@@ -175,7 +175,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
175175

176176
services:
177177
halo:
178-
image: registry.fit2cloud.com/halo/halo:2.18
178+
image: registry.fit2cloud.com/halo/halo:2.19
179179
restart: on-failure:3
180180
volumes:
181181
- ./halo2:/root/.halo2
@@ -198,7 +198,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
198198

199199
services:
200200
halo:
201-
image: registry.fit2cloud.com/halo/halo:2.18
201+
image: registry.fit2cloud.com/halo/halo:2.19
202202
restart: on-failure:3
203203
network_mode: "host"
204204
volumes:
@@ -249,7 +249,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
249249
```yaml {3}
250250
services:
251251
halo:
252-
image: registry.fit2cloud.com/halo/halo:2.18
252+
image: registry.fit2cloud.com/halo/halo:2.19
253253
```
254254
255255
```bash
@@ -313,7 +313,7 @@ networks:
313313

314314
services:
315315
halo:
316-
image: registry.fit2cloud.com/halo/halo:2.18
316+
image: registry.fit2cloud.com/halo/halo:2.19
317317
restart: on-failure:3
318318
volumes:
319319
- ./halo2:/root/.halo2

‎docs/getting-started/install/docker.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
3131
1. 创建容器
3232

3333
```bash
34-
docker run -it -d --name halo -p 8090:8090 -v ~/.halo2:/root/.halo2 registry.fit2cloud.com/halo/halo:2.18
34+
docker run -it -d --name halo -p 8090:8090 -v ~/.halo2:/root/.halo2 registry.fit2cloud.com/halo/halo:2.19
3535
```
3636

3737
:::info
@@ -60,7 +60,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
6060
2. 拉取新版本镜像
6161

6262
```bash
63-
docker pull registry.fit2cloud.com/halo/halo:2.18
63+
docker pull registry.fit2cloud.com/halo/halo:2.19
6464
```
6565

6666
3. 停止运行中的容器
@@ -75,5 +75,5 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
7575
修改版本号后，按照最初安装的方式，重新创建容器即可。
7676

7777
```bash
78-
docker run -it -d --name halo -p 8090:8090 -v ~/.halo2:/root/.halo2 registry.fit2cloud.com/halo/halo:2.18
78+
docker run -it -d --name halo -p 8090:8090 -v ~/.halo2:/root/.halo2 registry.fit2cloud.com/halo/halo:2.19
7979
```

‎docs/getting-started/install/jar-file.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ title: 使用 JAR 文件部署
5353
3. 下载运行包
5454

5555
```bash
56-
wget https://dl.halo.run/release/halo-2.18.0.jar -O halo.jar
56+
wget https://dl.halo.run/release/halo-2.19.0.jar -O halo.jar
5757
```
5858

5959
:::info
@@ -244,7 +244,7 @@ journalctl -n 20 -u halo
244244
3. 下载新版本的 Halo 运行包，覆盖原有的运行包
245245

246246
```bash
247-
wget https://dl.halo.run/release/halo-2.18.0.jar -O /home/halo/app/halo.jar
247+
wget https://dl.halo.run/release/halo-2.19.0.jar -O /home/halo/app/halo.jar
248248
```
249249

250250
4. 启动 Halo 服务

‎docs/getting-started/install/other/traefik.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ networks:
9696
9797
services:
9898
halo:
99-
image: registry.fit2cloud.com/halo/halo:2.18
99+
image: registry.fit2cloud.com/halo/halo:2.19
100100
container_name: halo
101101
restart: on-failure:3
102102
volumes:

‎docs/getting-started/install/podman.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Podman 采用无守护进程的包容性架构，因此可以更安全、更简
5757

5858
```bash
5959
mkdir -p ~/.halo2
60-
podman run -it -d --name halo -p 8090:8090 -v ~/.halo2:/root/.halo2 registry.fit2cloud.com/halo/halo:2.18
60+
podman run -it -d --name halo -p 8090:8090 -v ~/.halo2:/root/.halo2 registry.fit2cloud.com/halo/halo:2.19
6161
```
6262

6363
:::info
@@ -86,7 +86,7 @@ Podman 采用无守护进程的包容性架构，因此可以更安全、更简
8686
2. 拉取新版本镜像
8787

8888
```bash
89-
podman pull registry.fit2cloud.com/halo/halo:2.18
89+
podman pull registry.fit2cloud.com/halo/halo:2.19
9090
```
9191

9292
3. 停止运行中的容器
@@ -101,7 +101,7 @@ Podman 采用无守护进程的包容性架构，因此可以更安全、更简
101101
修改版本号后，按照最初安装的方式，重新创建容器即可。
102102

103103
```bash
104-
podman run -it -d --name halo -p 8090:8090 -v ~/.halo2:/root/.halo2 registry.fit2cloud.com/halo/halo:2.18
104+
podman run -it -d --name halo -p 8090:8090 -v ~/.halo2:/root/.halo2 registry.fit2cloud.com/halo/halo:2.19
105105
```
106106

107107
## 使用 [Podman Quadlet](https://docs.podman.io/en/latest/markdown/podman-systemd.unit.5.html)
@@ -137,7 +137,7 @@ Environment=SPRING_CONFIG_LOCATION="optional:classpath:/;optional:file:/.halo/"
137137
Environment=TZ=Asia/Shanghai
138138
Volume=/opt/podman-data/halo:/.halo
139139
PublishPort=127.0.0.1:8090:8090
140-
Image=ghcr.io/halo-dev/halo:2.18
140+
Image=ghcr.io/halo-dev/halo:2.19
141141
Exec=--halo.external-url=https://localhost:8090 --spring.sql.init.platform=postgresql --spring.r2dbc.url=r2dbc:pool:postgresql://127.0.0.1:5432/my-db --spring.r2dbc.username=my-user --spring.r2dbc.password=my-password
142142
143143
[Service]
@@ -166,7 +166,7 @@ Podman Quadlet 解析:
166166

167167
`[Container]` 部分:
168168

169-
- `AutoUpdate=registry`指定了自动拉取容器。假设后续Halo镜像支持了`latest`标签，你需要`systemctl enable --now podman-auto-update.timer`以启用容器自动更新。本文示例`ghcr.io/halo-dev/halo:2.18`，将会自动更新适用与`2.18`版本的patch，例如您创建容器时是`2.18.1`，在官方发布`2.18.2`版本时，容器会自动更新到`2.18.2`。
169+
- `AutoUpdate=registry`指定了自动拉取容器。假设后续Halo镜像支持了`latest`标签，你需要`systemctl enable --now podman-auto-update.timer`以启用容器自动更新。本文示例`ghcr.io/halo-dev/halo:2.19`，将会自动更新适用与`2.19`版本的patch，例如您创建容器时是`2.19.1`，在官方发布`2.19.2`版本时，容器会自动更新到`2.19.2`。
170170
- `ContainerName=`指定了 systemd 将生成的服务名称。
171171
- `User=60000 Group=60000 UserNS=keep-id:uid=60000,gid=60000` 限制容器以 id 60000 的用户运行，提高安全性。注意这个id 60000请根据你实际想要运行的用户名来修改，可通过`id user`获得你的用户的id.
172172
- `Environment=`字段指定了容器的环境变量，其中你需要注意的是`Environment=HALO_WORK_DIR="/.halo"` `Environment=SPRING_CONFIG_LOCATION="optional:classpath:/;optional:file:/.halo/"`这两个变量中的`/.halo`路径。
@@ -209,7 +209,7 @@ AutoUpdate=registry
209209
ContainerName=halo
210210
Volume=/opt/podman-data/halo:/root/.halo
211211
PublishPort=127.0.0.1:8090:8090
212-
Image=ghcr.io/halo-dev/halo:2.18
212+
Image=ghcr.io/halo-dev/halo:2.19
213213
Exec=--halo.external-url=https://localhost:8090 --spring.sql.init.platform=postgresql --spring.r2dbc.url=r2dbc:pool:postgresql://127.0.0.1:5432/my-db --spring.r2dbc.username=my-user --spring.r2dbc.password=my-password
214214
215215
[Service]

‎docs/getting-started/install/slots/_docker-registry-list.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@
55
- [ghcr.io/halo-dev/halo](https://github.com/halo-dev/halo/pkgs/container/halo)
66

77
:::info 注意
8-
目前 Halo 2 并未更新 Docker 的 latest 标签镜像，主要因为 Halo 2 不兼容 1.x 版本，防止使用者误操作。我们推荐使用固定版本的标签，比如 `2.18` 或者 `2.18.0`。
8+
目前 Halo 2 并未更新 Docker 的 latest 标签镜像，主要因为 Halo 2 不兼容 1.x 版本，防止使用者误操作。我们推荐使用固定版本的标签，比如 `2.19` 或者 `2.19.0`。
99

1010
- `registry.fit2cloud.com/halo/halo:2`：表示最新的 2.x 版本，即每次发布新版本都会更新此镜像。
11-
- `registry.fit2cloud.com/halo/halo:2.18`：表示最新的 2.18.x 版本，即每次发布 patch 版本都会同时更新此镜像。
12-
- `registry.fit2cloud.com/halo/halo:2.18.0`：表示一个具体的版本。
11+
- `registry.fit2cloud.com/halo/halo:2.19`：表示最新的 2.19.x 版本，即每次发布 patch 版本都会同时更新此镜像。
12+
- `registry.fit2cloud.com/halo/halo:2.19.0`：表示一个具体的版本。
1313

14-
后续文档以 `registry.fit2cloud.com/halo/halo:2.18` 为例。
14+
后续文档以 `registry.fit2cloud.com/halo/halo:2.19` 为例。
1515
:::

‎docs/intro.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ slug: /
3434
## 快速开始
3535

3636
```bash
37-
docker run -d --name halo -p 8090:8090 -v ~/.halo2:/root/.halo2 halohub/halo:2.18
37+
docker run -d --name halo -p 8090:8090 -v ~/.halo2:/root/.halo2 halohub/halo:2.19
3838
```
3939

4040
以上仅作为体验使用，详细部署文档请查阅：[https://docs.halo.run/getting-started/install/docker-compose](https://docs.halo.run/getting-started/install/docker-compose)

‎docs/user-guide/faq.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,15 +93,15 @@ server {
9393
--name halo-1 \
9494
-p 8090:8090 \
9595
-v ~/.halo2:/root/.halo2 \
96-
registry.fit2cloud.com/halo/halo:2.18 \
96+
registry.fit2cloud.com/halo/halo:2.19 \
9797

9898
# 第二个 Halo 容器
9999
docker run \
100100
-it -d \
101101
--name halo-2 \
102102
-p 8091:8090 \
103103
-v ~/.halo2_2:/root/.halo2 \
104-
registry.fit2cloud.com/halo/halo:2.18 \
104+
registry.fit2cloud.com/halo/halo:2.19 \
105105
```
106106

107107
更多 Docker 相关的教程请参考：[使用 Docker 部署 Halo](../getting-started/install/docker.md)

‎docusaurus.config.js

Lines changed: 26 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,11 @@ const config = {
2828
routeBasePath: "/",
2929
showLastUpdateTime: true,
3030
showLastUpdateAuthor: true,
31-
lastVersion: "2.18",
31+
lastVersion: "2.19",
3232
versions: {
3333
current: {
34-
label: "2.19.0-SNAPSHOT",
35-
path: "2.19.0-SNAPSHOT",
34+
label: "2.20.0-SNAPSHOT",
35+
path: "2.20.0-SNAPSHOT",
3636
},
3737
},
3838
},
@@ -44,13 +44,15 @@ const config = {
4444
changefreq: "weekly",
4545
priority: 0.5,
4646
ignorePatterns: [
47-
"/2.0/**",
48-
"/2.1/**",
49-
"/2.2/**",
50-
"/2.3/**",
51-
"/2.4/**",
52-
"/2.5/**",
53-
"/2.6/**",
47+
"/2.10/**",
48+
"/2.11/**",
49+
"/2.12/**",
50+
"/2.13/**",
51+
"/2.14/**",
52+
"/2.15/**",
53+
"/2.16/**",
54+
"/2.17/**",
55+
"/2.18/**",
5456
],
5557
},
5658
googleAnalytics: {
@@ -147,11 +149,11 @@ const config = {
147149
items: [
148150
{
149151
label: "官网",
150-
href: "https://halo.run",
152+
href: "https://www.halo.run",
151153
},
152154
{
153155
label: "应用市场",
154-
href: "https://halo.run/store/apps",
156+
href: "https://www.halo.run/store/apps",
155157
},
156158
{
157159
label: "GitHub 组织",
@@ -176,7 +178,7 @@ const config = {
176178
},
177179
{
178180
label: "微信公众号",
179-
href: "https://halo.run/upload/2021/03/B3C27F16-4890-4633-81CC-20BA4B28F94F-2415126255c749b290312ca22d9bdeb0.jpeg",
181+
href: "https://www.halo.run/upload/2021/03/B3C27F16-4890-4633-81CC-20BA4B28F94F-2415126255c749b290312ca22d9bdeb0.jpeg",
180182
},
181183
{
182184
label: "GitHub Issues",
@@ -235,17 +237,18 @@ const config = {
235237
},
236238
],
237239
createRedirects(existingPath) {
238-
if (existingPath.startsWith("/2.19.0-SNAPSHOT/")) {
240+
if (existingPath.startsWith("/2.20.0-SNAPSHOT/")) {
239241
return [
240-
existingPath.replace("/2.19.0-SNAPSHOT/", "/2.10.0-SNAPSHOT/"),
241-
existingPath.replace("/2.19.0-SNAPSHOT/", "/2.11.0-SNAPSHOT/"),
242-
existingPath.replace("/2.19.0-SNAPSHOT/", "/2.12.0-SNAPSHOT/"),
243-
existingPath.replace("/2.19.0-SNAPSHOT/", "/2.13.0-SNAPSHOT/"),
244-
existingPath.replace("/2.19.0-SNAPSHOT/", "/2.14.0-SNAPSHOT/"),
245-
existingPath.replace("/2.19.0-SNAPSHOT/", "/2.15.0-SNAPSHOT/"),
246-
existingPath.replace("/2.19.0-SNAPSHOT/", "/2.16.0-SNAPSHOT/"),
247-
existingPath.replace("/2.19.0-SNAPSHOT/", "/2.17.0-SNAPSHOT/"),
248-
existingPath.replace("/2.19.0-SNAPSHOT/", "/2.18.0-SNAPSHOT/"),
242+
existingPath.replace("/2.20.0-SNAPSHOT/", "/2.10.0-SNAPSHOT/"),
243+
existingPath.replace("/2.20.0-SNAPSHOT/", "/2.11.0-SNAPSHOT/"),
244+
existingPath.replace("/2.20.0-SNAPSHOT/", "/2.12.0-SNAPSHOT/"),
245+
existingPath.replace("/2.20.0-SNAPSHOT/", "/2.13.0-SNAPSHOT/"),
246+
existingPath.replace("/2.20.0-SNAPSHOT/", "/2.14.0-SNAPSHOT/"),
247+
existingPath.replace("/2.20.0-SNAPSHOT/", "/2.15.0-SNAPSHOT/"),
248+
existingPath.replace("/2.20.0-SNAPSHOT/", "/2.16.0-SNAPSHOT/"),
249+
existingPath.replace("/2.20.0-SNAPSHOT/", "/2.17.0-SNAPSHOT/"),
250+
existingPath.replace("/2.20.0-SNAPSHOT/", "/2.18.0-SNAPSHOT/"),
251+
existingPath.replace("/2.20.0-SNAPSHOT/", "/2.19.0-SNAPSHOT/"),
249252
];
250253
}
251254
return undefined;

0 commit comments

Comments
 (0)