halo/docs
1
0
Fork 0
mirror of https://github.com/halo-dev/docs.git synced 2025-10-22 02:45:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update documentation for Halo 2.4.1 (#207)

Browse Source 
为 Halo 2.4.1 更新文档。

/kind documentation

```release-note
None
```
This commit is contained in:
Ryan Wang
2023-04-04 12:02:14 +08:00
committed by GitHub
parent c2bac256e9
commit 862756a76c
8 changed files with 54 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
docs/getting-started/install/docker-compose.md
View File

@@ -20,13 +20,18 @@ import DockerArgs from "./slots/docker-args.md"
## 创建容器组 ## 创建容器组
可用的 Halo 2.4.0 的 Docker 镜像： 可用的 Halo 2.4 的 Docker 镜像：
- [halohub/halo](https://hub.docker.com/r/halohub/halo) - [halohub/halo](https://hub.docker.com/r/halohub/halo)
- [ghcr.io/halo-dev/halo](https://github.com/halo-dev/halo/pkgs/container/halo) - [ghcr.io/halo-dev/halo](https://github.com/halo-dev/halo/pkgs/container/halo)
:::info 注意 :::info 注意
目前 Halo 2 并未更新 Docker 的 latest 标签镜像，主要因为 Halo 2 不兼容 1.x 版本，防止使用者误操作。我们推荐使用固定版本的标签，比如 `halohub/halo:2.4.0`。 目前 Halo 2 并未更新 Docker 的 latest 标签镜像，主要因为 Halo 2 不兼容 1.x 版本，防止使用者误操作。我们推荐使用固定版本的标签，比如 `halohub/halo:2.4` 或者 `halohub/halo:2.4.0`。
- `halohub/halo:2.4`：表示最新的 2.4.x 版本，即每次发布 patch 版本都会同时更新 `halohub/halo:2.4` 镜像。
- `halohub/halo:2.4.0`：表示一个具体的版本。
后续文档以 `halohub/halo:2.4` 为例。
::: :::
1. 在系统任意位置创建一个文件夹，此文档以 `~/halo` 为例。 1. 在系统任意位置创建一个文件夹，此文档以 `~/halo` 为例。
@@ -44,7 +49,7 @@ import DockerArgs from "./slots/docker-args.md"
此文档提供两种场景的 Docker Compose 配置文件，请根据你的需要**选择一种**。 此文档提供两种场景的 Docker Compose 配置文件，请根据你的需要**选择一种**。
:::info :::info
需要注意的是，此文档为了更加方便的管理配置，所有与 Halo 相关的配置都使用 Docker 环境变量代替，所以无需创建 application.yaml 文件。 需要注意的是，此文档为了更加方便的管理配置，所有与 Halo 相关的配置都使用 Docker 容器启动参数代替，所以无需创建 application.yaml 文件。
::: :::
1. 创建 Halo + PostgreSQL 的实例： 1. 创建 Halo + PostgreSQL 的实例：
@@ -54,7 +59,7 @@ import DockerArgs from "./slots/docker-args.md"
services: services:
halo: halo:
image: halohub/halo:2.4.0 image: halohub/halo:2.4
container_name: halo container_name: halo
restart: on-failure:3 restart: on-failure:3
depends_on: depends_on:
@@ -116,7 +121,7 @@ import DockerArgs from "./slots/docker-args.md"
services: services:
halo: halo:
image: halohub/halo:2.4.0 image: halohub/halo:2.4
container_name: halo container_name: halo
restart: on-failure:3 restart: on-failure:3
depends_on: depends_on:
@@ -184,7 +189,7 @@ import DockerArgs from "./slots/docker-args.md"
services: services:
halo: halo:
image: halohub/halo:2.4.0 image: halohub/halo:2.4
container_name: halo container_name: halo
restart: on-failure:3 restart: on-failure:3
volumes: volumes:
@@ -251,12 +256,12 @@ import DockerArgs from "./slots/docker-args.md"
```yaml {3} ```yaml {3}
services: services:
halo: halo:
image: halohub/halo:2.4.0 image: halohub/halo:2.4
container_name: halo container_name: halo
``` ```
```bash ```bash
docker-compose pull docker-compose pull halo
``` ```
```bash ```bash
@@ -290,7 +295,7 @@ networks:
services: services:
halo: halo:
image: halohub/halo:2.4.0 image: halohub/halo:2.4
container_name: halo container_name: halo
restart: on-failure:3 restart: on-failure:3
volumes: volumes:

15
docs/getting-started/install/docker.md
View File

@@ -25,13 +25,18 @@ import DockerArgs from "./slots/docker-args.md"
## 使用 Docker 镜像 ## 使用 Docker 镜像
可用的 Halo 2.4.0 的 Docker 镜像： 可用的 Halo 2.4 的 Docker 镜像：
- [halohub/halo](https://hub.docker.com/r/halohub/halo) - [halohub/halo](https://hub.docker.com/r/halohub/halo)
- [ghcr.io/halo-dev/halo](https://github.com/halo-dev/halo/pkgs/container/halo) - [ghcr.io/halo-dev/halo](https://github.com/halo-dev/halo/pkgs/container/halo)
:::info 注意 :::info 注意
目前 Halo 2 并未更新 Docker 的 latest 标签镜像，主要因为 Halo 2 不兼容 1.x 版本，防止使用者误操作。我们推荐使用固定版本的标签，比如 `halohub/halo:2.4.0`。 目前 Halo 2 并未更新 Docker 的 latest 标签镜像，主要因为 Halo 2 不兼容 1.x 版本，防止使用者误操作。我们推荐使用固定版本的标签，比如 `halohub/halo:2.4` 或者 `halohub/halo:2.4.0`。
- `halohub/halo:2.4`：表示最新的 2.4.x 版本，即每次发布 patch 版本都会同时更新 `halohub/halo:2.4` 镜像。
- `halohub/halo:2.4.0`：表示一个具体的版本。
后续文档以 `halohub/halo:2.4` 为例。
::: :::
1. 创建容器 1. 创建容器
@@ -42,7 +47,7 @@ import DockerArgs from "./slots/docker-args.md"
--name halo \ --name halo \
-p 8090:8090 \ -p 8090:8090 \
-v ~/.halo2:/root/.halo2 \ -v ~/.halo2:/root/.halo2 \
halohub/halo:2.4.0 \ halohub/halo:2.4 \
--halo.external-url=http://localhost:8090/ \ --halo.external-url=http://localhost:8090/ \
--halo.security.initializer.superadminusername=admin \ --halo.security.initializer.superadminusername=admin \
--halo.security.initializer.superadminpassword=P@88w0rd --halo.security.initializer.superadminpassword=P@88w0rd
@@ -73,7 +78,7 @@ import DockerArgs from "./slots/docker-args.md"
1. 拉取新版本镜像 1. 拉取新版本镜像
```bash ```bash
docker pull halohub/halo:2.4.0 docker pull halohub/halo:2.4
``` ```
2. 停止运行中的容器 2. 停止运行中的容器
@@ -101,7 +106,7 @@ import DockerArgs from "./slots/docker-args.md"
--name halo \ --name halo \
-p 8090:8090 \ -p 8090:8090 \
-v ~/.halo2:/root/.halo2 \ -v ~/.halo2:/root/.halo2 \
halohub/halo:2.4.0 \ halohub/halo:2.4 \
--halo.external-url=http://localhost:8090/ \ --halo.external-url=http://localhost:8090/ \
--halo.security.initializer.superadminusername=admin \ --halo.security.initializer.superadminusername=admin \
--halo.security.initializer.superadminpassword=P@88w0rd --halo.security.initializer.superadminpassword=P@88w0rd

2
docs/getting-started/install/other/traefik.md
View File

@@ -96,7 +96,7 @@ networks:
services: services:
halo: halo:
image: halohub/halo:2.4.0 image: halohub/halo:2.4
container_name: halo container_name: halo
restart: on-failure:3 restart: on-failure:3
volumes: volumes:

4
docs/user-guide/faq.md
View File

@@ -113,7 +113,7 @@ server {
-v ~/.halo2.1:/root/.halo2 \ -v ~/.halo2.1:/root/.halo2 \
-e HALO_EXTERNAL_URL=http://localhost:8090/ \ -e HALO_EXTERNAL_URL=http://localhost:8090/ \
-e HALO_SECURITY_INITIALIZER_SUPERADMINPASSWORD=P@88w0rd \ -e HALO_SECURITY_INITIALIZER_SUPERADMINPASSWORD=P@88w0rd \
halohub/halo:2.4.0 halohub/halo:2.4
# 第二个 Halo 容器 # 第二个 Halo 容器
docker run \ docker run \
@@ -123,7 +123,7 @@ server {
-v ~/.halo2.2:/root/.halo2 \ -v ~/.halo2.2:/root/.halo2 \
-e HALO_EXTERNAL_URL=http://localhost:8090/ \ -e HALO_EXTERNAL_URL=http://localhost:8090/ \
-e HALO_SECURITY_INITIALIZER_SUPERADMINPASSWORD=P@88w0rd \ -e HALO_SECURITY_INITIALIZER_SUPERADMINPASSWORD=P@88w0rd \
halohub/halo:2.4.0 halohub/halo:2.4
``` ```
更多 Docker 相关的教程请参考：[使用 Docker 部署 Halo](../getting-started/install/docker.md) 更多 Docker 相关的教程请参考：[使用 Docker 部署 Halo](../getting-started/install/docker.md)

23
versioned_docs/version-2.4/getting-started/install/docker-compose.md
View File

@@ -20,13 +20,18 @@ import DockerArgs from "./slots/docker-args.md"
## 创建容器组 ## 创建容器组
可用的 Halo 2.4.0 的 Docker 镜像： 可用的 Halo 2.4 的 Docker 镜像：
- [halohub/halo](https://hub.docker.com/r/halohub/halo) - [halohub/halo](https://hub.docker.com/r/halohub/halo)
- [ghcr.io/halo-dev/halo](https://github.com/halo-dev/halo/pkgs/container/halo) - [ghcr.io/halo-dev/halo](https://github.com/halo-dev/halo/pkgs/container/halo)
:::info 注意 :::info 注意
目前 Halo 2 并未更新 Docker 的 latest 标签镜像，主要因为 Halo 2 不兼容 1.x 版本，防止使用者误操作。我们推荐使用固定版本的标签，比如 `halohub/halo:2.4.0`。 目前 Halo 2 并未更新 Docker 的 latest 标签镜像，主要因为 Halo 2 不兼容 1.x 版本，防止使用者误操作。我们推荐使用固定版本的标签，比如 `halohub/halo:2.4` 或者 `halohub/halo:2.4.0`。
- `halohub/halo:2.4`：表示最新的 2.4.x 版本，即每次发布 patch 版本都会同时更新 `halohub/halo:2.4` 镜像。
- `halohub/halo:2.4.0`：表示一个具体的版本。
后续文档以 `halohub/halo:2.4` 为例。
::: :::
1. 在系统任意位置创建一个文件夹，此文档以 `~/halo` 为例。 1. 在系统任意位置创建一个文件夹，此文档以 `~/halo` 为例。
@@ -44,7 +49,7 @@ import DockerArgs from "./slots/docker-args.md"
此文档提供两种场景的 Docker Compose 配置文件，请根据你的需要**选择一种**。 此文档提供两种场景的 Docker Compose 配置文件，请根据你的需要**选择一种**。
:::info :::info
需要注意的是，此文档为了更加方便的管理配置，所有与 Halo 相关的配置都使用 Docker 环境变量代替，所以无需创建 application.yaml 文件。 需要注意的是，此文档为了更加方便的管理配置，所有与 Halo 相关的配置都使用 Docker 容器启动参数代替，所以无需创建 application.yaml 文件。
::: :::
1. 创建 Halo + PostgreSQL 的实例： 1. 创建 Halo + PostgreSQL 的实例：
@@ -54,7 +59,7 @@ import DockerArgs from "./slots/docker-args.md"
services: services:
halo: halo:
image: halohub/halo:2.4.0 image: halohub/halo:2.4
container_name: halo container_name: halo
restart: on-failure:3 restart: on-failure:3
depends_on: depends_on:
@@ -116,7 +121,7 @@ import DockerArgs from "./slots/docker-args.md"
services: services:
halo: halo:
image: halohub/halo:2.4.0 image: halohub/halo:2.4
container_name: halo container_name: halo
restart: on-failure:3 restart: on-failure:3
depends_on: depends_on:
@@ -184,7 +189,7 @@ import DockerArgs from "./slots/docker-args.md"
services: services:
halo: halo:
image: halohub/halo:2.4.0 image: halohub/halo:2.4
container_name: halo container_name: halo
restart: on-failure:3 restart: on-failure:3
volumes: volumes:
@@ -251,12 +256,12 @@ import DockerArgs from "./slots/docker-args.md"
```yaml {3} ```yaml {3}
services: services:
halo: halo:
image: halohub/halo:2.4.0 image: halohub/halo:2.4
container_name: halo container_name: halo
``` ```
```bash ```bash
docker-compose pull docker-compose pull halo
``` ```
```bash ```bash
@@ -290,7 +295,7 @@ networks:
services: services:
halo: halo:
image: halohub/halo:2.4.0 image: halohub/halo:2.4
container_name: halo container_name: halo
restart: on-failure:3 restart: on-failure:3
volumes: volumes:

15
versioned_docs/version-2.4/getting-started/install/docker.md
View File

@@ -25,13 +25,18 @@ import DockerArgs from "./slots/docker-args.md"
## 使用 Docker 镜像 ## 使用 Docker 镜像
可用的 Halo 2.4.0 的 Docker 镜像： 可用的 Halo 2.4 的 Docker 镜像：
- [halohub/halo](https://hub.docker.com/r/halohub/halo) - [halohub/halo](https://hub.docker.com/r/halohub/halo)
- [ghcr.io/halo-dev/halo](https://github.com/halo-dev/halo/pkgs/container/halo) - [ghcr.io/halo-dev/halo](https://github.com/halo-dev/halo/pkgs/container/halo)
:::info 注意 :::info 注意
目前 Halo 2 并未更新 Docker 的 latest 标签镜像，主要因为 Halo 2 不兼容 1.x 版本，防止使用者误操作。我们推荐使用固定版本的标签，比如 `halohub/halo:2.4.0`。 目前 Halo 2 并未更新 Docker 的 latest 标签镜像，主要因为 Halo 2 不兼容 1.x 版本，防止使用者误操作。我们推荐使用固定版本的标签，比如 `halohub/halo:2.4` 或者 `halohub/halo:2.4.0`。
- `halohub/halo:2.4`：表示最新的 2.4.x 版本，即每次发布 patch 版本都会同时更新 `halohub/halo:2.4` 镜像。
- `halohub/halo:2.4.0`：表示一个具体的版本。
后续文档以 `halohub/halo:2.4` 为例。
::: :::
1. 创建容器 1. 创建容器
@@ -42,7 +47,7 @@ import DockerArgs from "./slots/docker-args.md"
--name halo \ --name halo \
-p 8090:8090 \ -p 8090:8090 \
-v ~/.halo2:/root/.halo2 \ -v ~/.halo2:/root/.halo2 \
halohub/halo:2.4.0 \ halohub/halo:2.4 \
--halo.external-url=http://localhost:8090/ \ --halo.external-url=http://localhost:8090/ \
--halo.security.initializer.superadminusername=admin \ --halo.security.initializer.superadminusername=admin \
--halo.security.initializer.superadminpassword=P@88w0rd --halo.security.initializer.superadminpassword=P@88w0rd
@@ -73,7 +78,7 @@ import DockerArgs from "./slots/docker-args.md"
1. 拉取新版本镜像 1. 拉取新版本镜像
```bash ```bash
docker pull halohub/halo:2.4.0 docker pull halohub/halo:2.4
``` ```
2. 停止运行中的容器 2. 停止运行中的容器
@@ -101,7 +106,7 @@ import DockerArgs from "./slots/docker-args.md"
--name halo \ --name halo \
-p 8090:8090 \ -p 8090:8090 \
-v ~/.halo2:/root/.halo2 \ -v ~/.halo2:/root/.halo2 \
halohub/halo:2.4.0 \ halohub/halo:2.4 \
--halo.external-url=http://localhost:8090/ \ --halo.external-url=http://localhost:8090/ \
--halo.security.initializer.superadminusername=admin \ --halo.security.initializer.superadminusername=admin \
--halo.security.initializer.superadminpassword=P@88w0rd --halo.security.initializer.superadminpassword=P@88w0rd

2
versioned_docs/version-2.4/getting-started/install/other/traefik.md
View File

@@ -96,7 +96,7 @@ networks:
services: services:
halo: halo:
image: halohub/halo:2.4.0 image: halohub/halo:2.4
container_name: halo container_name: halo
restart: on-failure:3 restart: on-failure:3
volumes: volumes:

4
versioned_docs/version-2.4/user-guide/faq.md
View File

@@ -113,7 +113,7 @@ server {
-v ~/.halo2.1:/root/.halo2 \ -v ~/.halo2.1:/root/.halo2 \
-e HALO_EXTERNAL_URL=http://localhost:8090/ \ -e HALO_EXTERNAL_URL=http://localhost:8090/ \
-e HALO_SECURITY_INITIALIZER_SUPERADMINPASSWORD=P@88w0rd \ -e HALO_SECURITY_INITIALIZER_SUPERADMINPASSWORD=P@88w0rd \
halohub/halo:2.4.0 halohub/halo:2.4
# 第二个 Halo 容器 # 第二个 Halo 容器
docker run \ docker run \
@@ -123,7 +123,7 @@ server {
-v ~/.halo2.2:/root/.halo2 \ -v ~/.halo2.2:/root/.halo2 \
-e HALO_EXTERNAL_URL=http://localhost:8090/ \ -e HALO_EXTERNAL_URL=http://localhost:8090/ \
-e HALO_SECURITY_INITIALIZER_SUPERADMINPASSWORD=P@88w0rd \ -e HALO_SECURITY_INITIALIZER_SUPERADMINPASSWORD=P@88w0rd \
halohub/halo:2.4.0 halohub/halo:2.4
``` ```
更多 Docker 相关的教程请参考：[使用 Docker 部署 Halo](../getting-started/install/docker.md) 更多 Docker 相关的教程请参考：[使用 Docker 部署 Halo](../getting-started/install/docker.md)