Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update documentation for Halo 2.10 #262

Merged
merged 1 commit into from
Oct 10, 2023
Merged

docs: update documentation for Halo 2.10 #262

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/developer-guide/core/build.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ git checkout v2.4.0
```

:::tip
请务必按照以上要求切换到最新的 tag，而不是直接使用 main 分支构建，main 分支是我们的开发分支。此文档以 `2.9.0` 为例，查看最新的 tag 可使用 `git tag --column` 查看。
请务必按照以上要求切换到最新的 tag，而不是直接使用 main 分支构建，main 分支是我们的开发分支。此文档以 `2.10.0` 为例，查看最新的 tag 可使用 `git tag --column` 查看。
:::

:::warning
Expand Down Expand Up @@ -63,7 +63,7 @@ pnpm build

## 构建 Fat Jar

构建之前需要修改 `gradle.properties` 中的 `version` 为当前 tag 的版本号，如：`version=2.9.0`
构建之前需要修改 `gradle.properties` 中的 `version` 为当前 tag 的版本号，如：`version=2.10.0`

```bash
cd path/to/halo
Expand All @@ -89,18 +89,18 @@ cd path/to/halo
./gradlew clean build -x check
```

构建完成之后，在 halo 项目下产生的 `application/build/libs/halo-2.9.0.jar` 即为构建完成的文件。
构建完成之后，在 halo 项目下产生的 `application/build/libs/halo-2.10.0.jar` 即为构建完成的文件。

## 构建 Docker 镜像

在进行之前，请确保已经完成上述操作，最终需要确认在 halo 项目的 `application/build/libs/` 目录已经包含了 `halo-2.9.0.jar` 文件。
在进行之前，请确保已经完成上述操作，最终需要确认在 halo 项目的 `application/build/libs/` 目录已经包含了 `halo-2.10.0.jar` 文件。

```bash
cd path/to/halo
```

```bash
docker build -t halo-dev/halo:2.9.0 .
docker build -t halo-dev/halo:2.10.0 .
```

```bash
Expand Down
22 changes: 11 additions & 11 deletions docs/getting-started/install/docker-compose.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,18 +20,18 @@ import DockerArgs from "./slots/docker-args.md"

## 创建容器组

可用的 Halo 2.9 的 Docker 镜像：
可用的 Halo 2.10 的 Docker 镜像：

- [halohub/halo](https://hub.docker.com/r/halohub/halo)
- [ghcr.io/halo-dev/halo](https://github.com/halo-dev/halo/pkgs/container/halo)

:::info 注意
目前 Halo 2 并未更新 Docker 的 latest 标签镜像，主要因为 Halo 2 不兼容 1.x 版本，防止使用者误操作。我们推荐使用固定版本的标签，比如 `halohub/halo:2.9` 或者 `halohub/halo:2.9.0`。
目前 Halo 2 并未更新 Docker 的 latest 标签镜像，主要因为 Halo 2 不兼容 1.x 版本，防止使用者误操作。我们推荐使用固定版本的标签，比如 `halohub/halo:2.10` 或者 `halohub/halo:2.10.0`。

- `halohub/halo:2.9`：表示最新的 2.9.x 版本，即每次发布 patch 版本都会同时更新 `halohub/halo:2.9` 镜像。
- `halohub/halo:2.9.0`：表示一个具体的版本。
- `halohub/halo:2.10`：表示最新的 2.10.x 版本，即每次发布 patch 版本都会同时更新 `halohub/halo:2.10` 镜像。
- `halohub/halo:2.10.0`：表示一个具体的版本。

后续文档以 `halohub/halo:2.9` 为例。
后续文档以 `halohub/halo:2.10` 为例。
:::

1. 在系统任意位置创建一个文件夹，此文档以 `~/halo` 为例。
Expand Down Expand Up @@ -59,7 +59,7 @@ import DockerArgs from "./slots/docker-args.md"

services:
halo:
image: halohub/halo:2.9
image: halohub/halo:2.10
container_name: halo
restart: on-failure:3
depends_on:
Expand Down Expand Up @@ -117,7 +117,7 @@ import DockerArgs from "./slots/docker-args.md"

services:
halo:
image: halohub/halo:2.9
image: halohub/halo:2.10
container_name: halo
restart: on-failure:3
depends_on:
Expand Down Expand Up @@ -181,7 +181,7 @@ import DockerArgs from "./slots/docker-args.md"

services:
halo:
image: halohub/halo:2.9
image: halohub/halo:2.10
container_name: halo
restart: on-failure:3
volumes:
Expand All @@ -205,7 +205,7 @@ import DockerArgs from "./slots/docker-args.md"

services:
halo:
image: halohub/halo:2.9
image: halohub/halo:2.10
container_name: halo
restart: on-failure:3
network_mode: "host"
Expand Down Expand Up @@ -268,7 +268,7 @@ import DockerArgs from "./slots/docker-args.md"
```yaml {3}
services:
halo:
image: halohub/halo:2.9
image: halohub/halo:2.10
container_name: halo
```

Expand Down Expand Up @@ -338,7 +338,7 @@ networks:

services:
halo:
image: halohub/halo:2.9
image: halohub/halo:2.10
container_name: halo
restart: on-failure:3
volumes:
Expand Down
16 changes: 8 additions & 8 deletions docs/getting-started/install/docker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,24 +25,24 @@ import DockerArgs from "./slots/docker-args.md"

## 使用 Docker 镜像

可用的 Halo 2.9 的 Docker 镜像：
可用的 Halo 2.10 的 Docker 镜像：

- [halohub/halo](https://hub.docker.com/r/halohub/halo)
- [ghcr.io/halo-dev/halo](https://github.com/halo-dev/halo/pkgs/container/halo)

:::info 注意
目前 Halo 2 并未更新 Docker 的 latest 标签镜像，主要因为 Halo 2 不兼容 1.x 版本，防止使用者误操作。我们推荐使用固定版本的标签，比如 `halohub/halo:2.9` 或者 `halohub/halo:2.9.0`。
目前 Halo 2 并未更新 Docker 的 latest 标签镜像，主要因为 Halo 2 不兼容 1.x 版本，防止使用者误操作。我们推荐使用固定版本的标签，比如 `halohub/halo:2.10` 或者 `halohub/halo:2.10.0`。

- `halohub/halo:2.9`：表示最新的 2.9.x 版本，即每次发布 patch 版本都会同时更新 `halohub/halo:2.9` 镜像。
- `halohub/halo:2.9.0`：表示一个具体的版本。
- `halohub/halo:2.10`：表示最新的 2.10.x 版本，即每次发布 patch 版本都会同时更新 `halohub/halo:2.10` 镜像。
- `halohub/halo:2.10.0`：表示一个具体的版本。

后续文档以 `halohub/halo:2.9` 为例。
后续文档以 `halohub/halo:2.10` 为例。
:::

1. 创建容器

```bash
docker run -it -d --name halo -p 8090:8090 -v ~/.halo2:/root/.halo2 halohub/halo:2.9
docker run -it -d --name halo -p 8090:8090 -v ~/.halo2:/root/.halo2 halohub/halo:2.10
```

:::info
Expand Down Expand Up @@ -70,7 +70,7 @@ import DockerArgs from "./slots/docker-args.md"
1. 拉取新版本镜像

```bash
docker pull halohub/halo:2.9
docker pull halohub/halo:2.10
```

2. 停止运行中的容器
Expand All @@ -93,5 +93,5 @@ import DockerArgs from "./slots/docker-args.md"
修改版本号后，按照最初安装的方式，重新创建容器即可。

```bash
docker run -it -d --name halo -p 8090:8090 -v ~/.halo2:/root/.halo2 halohub/halo:2.9
docker run -it -d --name halo -p 8090:8090 -v ~/.halo2:/root/.halo2 halohub/halo:2.10
```
2 changes: 1 addition & 1 deletion docs/getting-started/install/other/traefik.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ networks:

services:
halo:
image: halohub/halo:2.9
image: halohub/halo:2.10
container_name: halo
restart: on-failure:3
volumes:
Expand Down
22 changes: 11 additions & 11 deletions docs/getting-started/install/podman.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,25 +50,25 @@ Podman 采用无守护进程的包容性架构，因此可以更安全、更简
通过[前言](#前言)我们已经了解了 Podman ，其中提到 ***Podman 与 Docker 高度兼容*** ，正是因为 Podman 完全是为了替代 Docker 而诞生，所以原本的 Docker 生态中的镜像我们可以无需更改直接使用。
:::

可用的 Halo 2.9 的 Docker 镜像：
可用的 Halo 2.10 的 Docker 镜像：

- [halohub/halo](https://hub.docker.com/r/halohub/halo)
- [ghcr.io/halo-dev/halo](https://github.com/halo-dev/halo/pkgs/container/halo)

:::info 注意
目前 Halo 2 并未更新 Docker 的 latest 标签镜像，主要因为 Halo 2 不兼容 1.x 版本，防止使用者误操作。我们推荐使用固定版本的标签，比如 `halohub/halo:2.9` 或者 `halohub/halo:2.9.0`。
目前 Halo 2 并未更新 Docker 的 latest 标签镜像，主要因为 Halo 2 不兼容 1.x 版本，防止使用者误操作。我们推荐使用固定版本的标签，比如 `halohub/halo:2.10` 或者 `halohub/halo:2.10.0`。

- `halohub/halo:2.9`：表示最新的 2.9.x 版本，即每次发布 patch 版本都会同时更新 `halohub/halo:2.9` 镜像。
- `halohub/halo:2.9.0`：表示一个具体的版本。
- `halohub/halo:2.10`：表示最新的 2.10.x 版本，即每次发布 patch 版本都会同时更新 `halohub/halo:2.10` 镜像。
- `halohub/halo:2.10.0`：表示一个具体的版本。

后续文档以 `halohub/halo:2.9` 为例。
后续文档以 `halohub/halo:2.10` 为例。
:::

1. 创建容器

```bash
mkdir -p ~/.halo2
podman run -it -d --name halo -p 8090:8090 -v ~/.halo2:/root/.halo2 halohub/halo:2.9
podman run -it -d --name halo -p 8090:8090 -v ~/.halo2:/root/.halo2 halohub/halo:2.10
```

:::info
Expand Down Expand Up @@ -96,7 +96,7 @@ Podman 采用无守护进程的包容性架构，因此可以更安全、更简
1. 拉取新版本镜像

```bash
podman pull halohub/halo:2.9
podman pull halohub/halo:2.10
```

2. 停止运行中的容器
Expand All @@ -120,7 +120,7 @@ Podman 采用无守护进程的包容性架构，因此可以更安全、更简

```bash
mkdir -p ~/.halo2
podman run -it -d --name halo -p 8090:8090 -v ~/.halo2:/root/.halo2 halohub/halo:2.9
podman run -it -d --name halo -p 8090:8090 -v ~/.halo2:/root/.halo2 halohub/halo:2.10
```

## 使用 [Podman Quadlet](https://docs.podman.io/en/latest/markdown/podman-systemd.unit.5.html)
Expand Down Expand Up @@ -156,7 +156,7 @@ Podman 没有和 Docker 类似的管理进程，在低配置的主机上更友
Environment=TZ=Asia/Shanghai
Volume=/opt/podman-data/halo:/.halo
PublishPort=127.0.0.1:8090:8090
Image=ghcr.io/halo-dev/halo:2.9
Image=ghcr.io/halo-dev/halo:2.10
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 --halo.cache.page.disabled=false

[Service]
Expand Down Expand Up @@ -185,7 +185,7 @@ Podman Quadlet 解析:

`[Container]` 部分:

- `AutoUpdate=registry`指定了自动拉取容器。假设后续Halo镜像支持了`latest`标签，你需要`systemctl enable --now podman-auto-update.timer`以启用容器自动更新。本文示例`ghcr.io/halo-dev/halo:2.9`，将会自动更新适用与`2.9`版本的patch，例如您创建容器时是`2.9.1`，在官方发布`2.9.2`版本时，容器会自动更新到`2.9.2`。
- `AutoUpdate=registry`指定了自动拉取容器。假设后续Halo镜像支持了`latest`标签，你需要`systemctl enable --now podman-auto-update.timer`以启用容器自动更新。本文示例`ghcr.io/halo-dev/halo:2.10`，将会自动更新适用与`2.10`版本的patch，例如您创建容器时是`2.10.1`，在官方发布`2.10.2`版本时，容器会自动更新到`2.10.2`。
- `ContainerName=`指定了 systemd 将生成的服务名称。
- `User=60000 Group=60000 UserNS=keep-id:uid=60000,gid=60000` 限制容器以 id 60000 的用户运行，提高安全性。注意这个id 60000请根据你实际想要运行的用户名来修改，可通过`id user`获得你的用户的id.
- `Environment=`字段指定了容器的环境变量，其中你需要注意的是`Environment=HALO_WORK_DIR="/.halo"` `Environment=SPRING_CONFIG_LOCATION="optional:classpath:/;optional:file:/.halo/"`这两个变量中的`/.halo`路径。
Expand Down Expand Up @@ -228,7 +228,7 @@ Podman Quadlet 解析:
ContainerName=halo
Volume=/opt/podman-data/halo:/root/.halo
PublishPort=127.0.0.1:8090:8090
Image=ghcr.io/halo-dev/halo:2.9
Image=ghcr.io/halo-dev/halo:2.10
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 --halo.cache.page.disabled=false

[Service]
Expand Down
2 changes: 1 addition & 1 deletion docs/intro.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ slug: /
## 快速开始

```bash
docker run -it -d --name halo -p 8090:8090 -v ~/.halo2:/root/.halo2 halohub/halo:2.9
docker run -it -d --name halo -p 8090:8090 -v ~/.halo2:/root/.halo2 halohub/halo:2.10
```

以上仅作为体验使用，详细部署文档请查阅：<https://docs.halo.run/getting-started/install/docker-compose>
Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/backup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: 备份与恢复
description: 备份与恢复功能说明
---

从 Halo 2.9 开始，Halo 内置了备份和恢复的功能，可以在 Console 中一键备份和恢复完整的数据。
从 Halo 2.8 开始，Halo 内置了备份和恢复的功能，可以在 Console 中一键备份和恢复完整的数据。

## 备份

Expand Down
4 changes: 2 additions & 2 deletions docs/user-guide/faq.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,15 +101,15 @@ server {
--name halo-1 \
-p 8090:8090 \
-v ~/.halo2:/root/.halo2 \
halohub/halo:2.9 \
halohub/halo:2.10 \

# 第二个 Halo 容器
docker run \
-it -d \
--name halo-2 \
-p 8091:8090 \
-v ~/.halo2_2:/root/.halo2 \
halohub/halo:2.9 \
halohub/halo:2.10 \
```

更多 Docker 相关的教程请参考：[使用 Docker 部署 Halo](../getting-started/install/docker.md)
Expand Down
29 changes: 15 additions & 14 deletions docusaurus.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,11 @@ const config = {
showLastUpdateAuthor: true,
remarkPlugins: [math, mermaid],
rehypePlugins: [katex],
lastVersion: "2.9",
lastVersion: "2.10",
versions: {
current: {
label: "2.10.0-SNAPSHOT",
path: "2.10.0-SNAPSHOT",
label: "2.11.0-SNAPSHOT",
path: "2.11.0-SNAPSHOT",
},
},
},
Expand Down Expand Up @@ -284,18 +284,19 @@ const config = {
if (existingPath.startsWith("/1.4/")) {
return [existingPath.replace("/1.4/", "/1.4.17/")];
}
if (existingPath.startsWith("/2.10.0-SNAPSHOT/")) {
if (existingPath.startsWith("/2.11.0-SNAPSHOT/")) {
return [
existingPath.replace("/2.10.0-SNAPSHOT/", "/2.0.0-SNAPSHOT/"),
existingPath.replace("/2.10.0-SNAPSHOT/", "/2.1.0-SNAPSHOT/"),
existingPath.replace("/2.10.0-SNAPSHOT/", "/2.2.0-SNAPSHOT/"),
existingPath.replace("/2.10.0-SNAPSHOT/", "/2.3.0-SNAPSHOT/"),
existingPath.replace("/2.10.0-SNAPSHOT/", "/2.4.0-SNAPSHOT/"),
existingPath.replace("/2.10.0-SNAPSHOT/", "/2.5.0-SNAPSHOT/"),
existingPath.replace("/2.10.0-SNAPSHOT/", "/2.6.0-SNAPSHOT/"),
existingPath.replace("/2.10.0-SNAPSHOT/", "/2.7.0-SNAPSHOT/"),
existingPath.replace("/2.10.0-SNAPSHOT/", "/2.8.0-SNAPSHOT/"),
existingPath.replace("/2.10.0-SNAPSHOT/", "/2.9.0-SNAPSHOT/"),
existingPath.replace("/2.11.0-SNAPSHOT/", "/2.0.0-SNAPSHOT/"),
existingPath.replace("/2.11.0-SNAPSHOT/", "/2.1.0-SNAPSHOT/"),
existingPath.replace("/2.11.0-SNAPSHOT/", "/2.2.0-SNAPSHOT/"),
existingPath.replace("/2.11.0-SNAPSHOT/", "/2.3.0-SNAPSHOT/"),
existingPath.replace("/2.11.0-SNAPSHOT/", "/2.4.0-SNAPSHOT/"),
existingPath.replace("/2.11.0-SNAPSHOT/", "/2.5.0-SNAPSHOT/"),
existingPath.replace("/2.11.0-SNAPSHOT/", "/2.6.0-SNAPSHOT/"),
existingPath.replace("/2.11.0-SNAPSHOT/", "/2.7.0-SNAPSHOT/"),
existingPath.replace("/2.11.0-SNAPSHOT/", "/2.8.0-SNAPSHOT/"),
existingPath.replace("/2.11.0-SNAPSHOT/", "/2.9.0-SNAPSHOT/"),
existingPath.replace("/2.11.0-SNAPSHOT/", "/2.10.0-SNAPSHOT/"),
];
}
return undefined;
Expand Down
Loading
Loading