Skip to content

Commit 9df9374

Browse files
authored
docs: update documentations for 2.21 (#502)
Signed-off-by: Ryan Wang <i@ryanc.cc>
1 parent afda4f8 commit 9df9374

File tree

209 files changed

+19242
-515
lines changed

Some content is hidden

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

209 files changed

+19242
-515
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.20.0`
36+
构建之前需要修改 `gradle.properties` 中的 `version` 属性(推荐遵循 [SemVer 规范](https://semver.org/)),例如:`version=2.21.0`
3737

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

docs/developer-guide/core/prepare.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ description: 开发环境的准备工作
55

66
## 环境要求
77

8-
- [OpenJDK 17 LTS](https://github.com/openjdk/jdk)
8+
- [OpenJDK 21 LTS](https://github.com/openjdk/jdk)
99
- [Node.js 20 LTS](https://nodejs.org)
10-
- [pnpm 9](https://pnpm.io/)
10+
- [pnpm 10](https://pnpm.io/)
1111
- [IntelliJ IDEA](https://www.jetbrains.com/idea/)
1212
- [Git](https://git-scm.com/)
1313
- [Docker](https://www.docker.com/)(可选)

docs/getting-started/install/config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Halo 支持通过多种方式进行配置,目前 [Docker Compose 部署文档]
1616
```yaml {5-10}
1717
services:
1818
halo:
19-
image: registry.fit2cloud.com/halo/halo:2.20
19+
image: registry.fit2cloud.com/halo/halo:2.21
2020
...
2121
command:
2222
- --spring.r2dbc.url=r2dbc:pool:postgresql://halodb/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.20
55+
image: registry.fit2cloud.com/halo/halo:2.21
5656
restart: on-failure:3
5757
depends_on:
5858
halodb:
@@ -111,7 +111,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
111111

112112
services:
113113
halo:
114-
image: registry.fit2cloud.com/halo/halo:2.20
114+
image: registry.fit2cloud.com/halo/halo:2.21
115115
restart: on-failure:3
116116
depends_on:
117117
halodb:
@@ -181,7 +181,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
181181

182182
services:
183183
halo:
184-
image: registry.fit2cloud.com/halo/halo:2.20
184+
image: registry.fit2cloud.com/halo/halo:2.21
185185
restart: on-failure:3
186186
volumes:
187187
- ./halo2:/root/.halo2
@@ -207,7 +207,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
207207

208208
services:
209209
halo:
210-
image: registry.fit2cloud.com/halo/halo:2.20
210+
image: registry.fit2cloud.com/halo/halo:2.21
211211
restart: on-failure:3
212212
network_mode: "host"
213213
volumes:
@@ -273,7 +273,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
273273
```yaml {3}
274274
services:
275275
halo:
276-
image: registry.fit2cloud.com/halo/halo:2.20
276+
image: registry.fit2cloud.com/halo/halo:2.21
277277
```
278278
279279
```bash
@@ -337,7 +337,7 @@ networks:
337337

338338
services:
339339
halo:
340-
image: registry.fit2cloud.com/halo/halo:2.20
340+
image: registry.fit2cloud.com/halo/halo:2.21
341341
restart: on-failure:3
342342
volumes:
343343
- ./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 -e JVM_OPTS="-Xmx256m -Xms256m" registry.fit2cloud.com/halo/halo:2.20
34+
docker run -it -d --name halo -p 8090:8090 -v ~/.halo2:/root/.halo2 -e JVM_OPTS="-Xmx256m -Xms256m" registry.fit2cloud.com/halo/halo:2.21
3535
```
3636

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

6666
```bash
67-
docker pull registry.fit2cloud.com/halo/halo:2.20
67+
docker pull registry.fit2cloud.com/halo/halo:2.21
6868
```
6969

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

8181
```bash
82-
docker run -it -d --name halo -p 8090:8090 -v ~/.halo2:/root/.halo2 registry.fit2cloud.com/halo/halo:2.20
82+
docker run -it -d --name halo -p 8090:8090 -v ~/.halo2:/root/.halo2 registry.fit2cloud.com/halo/halo:2.21
8383
```

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

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@ title: 使用 JAR 文件部署
1010

1111
在开始之前,需要确保服务器已经满足以下条件:
1212

13-
1. [Java](https://openjdk.org) 环境,目前 Halo 最低需要 **JRE 17** 的环境。
13+
1. [Java](https://openjdk.org) 环境,版本要求:
14+
- 2.21 以上版本:**JRE 21**
15+
- 2.20 及以下版本:**JRE 17**
1416
2. 数据库(任一)
1517
- [MySQL 5.7+](https://www.mysql.com)
1618
- [MariaDB](https://mariadb.org)
@@ -53,7 +55,7 @@ title: 使用 JAR 文件部署
5355
3. 下载运行包
5456

5557
```bash
56-
wget https://dl.halo.run/release/halo-2.20.12.jar -O halo.jar
58+
wget https://dl.halo.run/release/halo-2.21.0.jar -O halo.jar
5759
```
5860

5961
:::info
@@ -249,7 +251,7 @@ journalctl -n 20 -u halo
249251
3. 下载新版本的 Halo 运行包,覆盖原有的运行包
250252

251253
```bash
252-
wget https://dl.halo.run/release/halo-2.20.12.jar -O /home/halo/app/halo.jar
254+
wget https://dl.halo.run/release/halo-2.21.0.jar -O /home/halo/app/halo.jar
253255
```
254256

255257
:::info

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.20
99+
image: registry.fit2cloud.com/halo/halo:2.21
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.20
60+
podman run -it -d --name halo -p 8090:8090 -v ~/.halo2:/root/.halo2 registry.fit2cloud.com/halo/halo:2.21
6161
```
6262

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

9292
```bash
93-
podman pull registry.fit2cloud.com/halo/halo:2.20
93+
podman pull registry.fit2cloud.com/halo/halo:2.21
9494
```
9595

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

107107
```bash
108-
podman run -it -d --name halo -p 8090:8090 -v ~/.halo2:/root/.halo2 registry.fit2cloud.com/halo/halo:2.20
108+
podman run -it -d --name halo -p 8090:8090 -v ~/.halo2:/root/.halo2 registry.fit2cloud.com/halo/halo:2.21
109109
```
110110

111111
## 使用 [Podman Quadlet](https://docs.podman.io/en/latest/markdown/podman-systemd.unit.5.html)
@@ -141,7 +141,7 @@ Environment=SPRING_CONFIG_LOCATION="optional:classpath:/;optional:file:/.halo/"
141141
Environment=TZ=Asia/Shanghai
142142
Volume=/opt/podman-data/halo:/.halo
143143
PublishPort=127.0.0.1:8090:8090
144-
Image=ghcr.io/halo-dev/halo:2.20
144+
Image=ghcr.io/halo-dev/halo:2.21
145145
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
146146
147147
[Service]
@@ -170,7 +170,7 @@ Podman Quadlet 解析:
170170

171171
`[Container]` 部分:
172172

173-
- `AutoUpdate=registry`指定了自动拉取容器。假设后续 Halo 镜像支持了`latest`标签,你需要`systemctl enable --now podman-auto-update.timer`以启用容器自动更新。本文示例`ghcr.io/halo-dev/halo:2.20`,将会自动更新适用与`2.20`版本的 patch,例如您创建容器时是`2.20.1`,在官方发布`2.20.2`版本时,容器会自动更新到`2.20.2`
173+
- `AutoUpdate=registry`指定了自动拉取容器。假设后续 Halo 镜像支持了`latest`标签,你需要`systemctl enable --now podman-auto-update.timer`以启用容器自动更新。本文示例`ghcr.io/halo-dev/halo:2.21`,将会自动更新适用与`2.21`版本的 patch,例如您创建容器时是`2.21.1`,在官方发布`2.21.2`版本时,容器会自动更新到`2.21.2`
174174
- `ContainerName=`指定了 systemd 将生成的服务名称。
175175
- `User=60000 Group=60000 UserNS=keep-id:uid=60000,gid=60000` 限制容器以 id 60000 的用户运行,提高安全性。注意这个 id 60000 请根据你实际想要运行的用户名来修改,可通过`id user`获得你的用户的 id.
176176
- `Environment=`字段指定了容器的环境变量,其中你需要注意的是`Environment=HALO_WORK_DIR="/.halo"` `Environment=SPRING_CONFIG_LOCATION="optional:classpath:/;optional:file:/.halo/"`这两个变量中的`/.halo`路径。
@@ -213,7 +213,7 @@ AutoUpdate=registry
213213
ContainerName=halo
214214
Volume=/opt/podman-data/halo:/root/.halo
215215
PublishPort=127.0.0.1:8090:8090
216-
Image=ghcr.io/halo-dev/halo:2.20
216+
Image=ghcr.io/halo-dev/halo:2.21
217217
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
218218
219219
[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.20` 或者 `2.20.0`
8+
目前 Halo 2 并未更新 Docker 的 latest 标签镜像,主要因为 Halo 2 不兼容 1.x 版本,防止使用者误操作。我们推荐使用固定版本的标签,比如 `2.21` 或者 `2.21.0`
99

1010
- `registry.fit2cloud.com/halo/halo:2`:表示最新的 2.x 版本,即每次发布新版本都会更新此镜像。
11-
- `registry.fit2cloud.com/halo/halo:2.20`:表示最新的 2.20.x 版本,即每次发布 patch 版本都会同时更新此镜像。
12-
- `registry.fit2cloud.com/halo/halo:2.20.0`:表示一个具体的版本。
11+
- `registry.fit2cloud.com/halo/halo:2.21`:表示最新的 2.21.x 版本,即每次发布 patch 版本都会同时更新此镜像。
12+
- `registry.fit2cloud.com/halo/halo:2.21.0`:表示一个具体的版本。
1313

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

docs/getting-started/prepare.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,11 @@ Halo 理论上可以运行在任何支持 Docker 及 Java 的平台。
4949
- [使用 JAR 文件部署](./install/jar-file.md)
5050

5151
:::info
52-
当前版本(2.0)需要 JRE 17 的版本,推荐使用 OpenJDK 17。
52+
版本要求:
53+
54+
- 2.21 以上版本:**JRE 21**
55+
- 2.20 及以下版本:**JRE 17**
56+
5357
:::
5458

5559
#### 数据库

0 commit comments

Comments
 (0)