docs: fix some correct document formatting using autocorrect (#493)

Fix some correct document formatting using [autocorrect](https://github.com/huacnlee/autocorrect)

```release-note
None
```
This commit is contained in:
Ryan Wang
2025-04-23 11:45:09 +08:00
committed by GitHub
parent c82df43df2
commit 1cf9b3636f
70 changed files with 166 additions and 166 deletions
@@ -20,7 +20,7 @@ Halo 安装完成后,默认初始化了一篇 `Hello Halo` 文章,接下来
4. 确认无误后,点击弹框下方的 `发布` 按钮,我们的第一篇文章就成功发布了。
:::info
关于文章相关其他功能及文章各种设置项的说明,请参考《[用户指南-文章](../user-guide/posts.md)》章节
关于文章相关其他功能及文章各种设置项的说明,请参考《[用户指南 - 文章](../user-guide/posts.md)》章节
:::
## 查看文章
@@ -11,7 +11,7 @@ description: 使用阿里云计算巢服务部署 Halo
![image.png](/img/install/alibab-cloud-computenest/deploy_1.jpg)
2. 参数填写完成后可以看到对应询价明细,确认参数后点击**下一步:确认订单**。确认订单完成后同意服务协议并点击**立即创建**进入部署阶段。
3. 等待部署完成后进入服务实例管理, 在控制台找到 Halo 服务访问链接。
3. 等待部署完成后进入服务实例管理在控制台找到 Halo 服务访问链接。
![image.png](/img/install/alibab-cloud-computenest/deploy_2.jpg)
4. 单击链接访问 Halo 服务。
@@ -282,7 +282,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
## 反向代理
你可以在下面的反向代理软件中任选一项,我们假设你已经安装好了其中一项,并对其的基本操作有一定了解。 如果你对它们没有任何了解,可以参考我们更为详细的反向代理文档:
你可以在下面的反向代理软件中任选一项,我们假设你已经安装好了其中一项,并对其的基本操作有一定了解。如果你对它们没有任何了解,可以参考我们更为详细的反向代理文档:
1. 使用 [Nginx Proxy Manager](../install/other/nginxproxymanager.md)
2. 使用 [Traefik](../install/other/traefik.md)
@@ -90,8 +90,8 @@ helm install halo halo/halo --set mysql.enabled=true --set postgresql.enabled=fa
:::info 参数说明
- `mysql.enabled=true` 自动安装 MySQL 数据库;
- `postgresql.enabled=false` 不自动安装 PostgreSQL 数据库;
- `mysql.enabled=true`:自动安装 MySQL 数据库;
- `postgresql.enabled=false`:不自动安装 PostgreSQL 数据库;
- 关于 mysql 的更多参数说明,请参考 [Bitnami MySQL Chart](https://github.com/bitnami/charts/tree/main/bitnami/mysql#parameters),在原有参数格式上增加 `mysql.` 前缀即可。
:::
@@ -113,8 +113,8 @@ helm install halo halo/halo \
:::info 参数说明
- `mysql.enabled=true` 不自动安装 MySQL 数据库;
- `postgresql.enabled=false` 不自动安装 PostgreSQL 数据库;
- `mysql.enabled=true`:不自动安装 MySQL 数据库;
- `postgresql.enabled=false`:不自动安装 PostgreSQL 数据库;
- `externalDatabase.platform=mysql`:外部数据库类型,例如 `postgresql``mysql`
- `externalDatabase.host=mysql`:外部数据库连接地址;
- `externalDatabase.port=3306`:外部数据库连接端口;
@@ -266,7 +266,7 @@ journalctl -n 20 -u halo
## 反向代理
你可以在下面的反向代理软件中任选一项,我们假设你已经安装好了其中一项,并对其的基本操作有一定了解。 如果你对它们没有任何了解,可以参考我们更为详细的反向代理文档:
你可以在下面的反向代理软件中任选一项,我们假设你已经安装好了其中一项,并对其的基本操作有一定了解。如果你对它们没有任何了解,可以参考我们更为详细的反向代理文档:
1. 使用 [Nginx Proxy Manager](../install/other/nginxproxymanager.md)
@@ -20,7 +20,7 @@ Halo 离线安装包使用 Docker + Docker Compose 的方式部署 Halo 及其
### 解压安装包
以 root 用户 ssh 登录到目标机器, 并执行如下命令:
以 root 用户 ssh 登录到目标机器并执行如下命令:
```bash
cd /tmp
@@ -25,7 +25,7 @@ Nginx Proxy Manager 后台还可以一键申请 SSL 证书,并且会自动续
> 说明:默认你的服务器已经安装了 Docker 和 Docker Compose,如果你没有安装,可以参考:[使用 Docker Compose 部署](../docker-compose) 的环境搭建部分来进行安装。
点击下方链接进入 Nginx Proxy Manager(以下简称 NPM 官网:[https://nginxproxymanager.com/](https://nginxproxymanager.com/)
点击下方链接进入 Nginx Proxy Manager(以下简称 NPM)官网:[https://nginxproxymanager.com/](https://nginxproxymanager.com/)
我们可以直接选择 [快速安装](https://nginxproxymanager.com/guide/#quick-setup)。
@@ -109,9 +109,9 @@ docker compose up -d # 如果你用的是 docker-compose-plugin 的话,用
- `Forward Hostname/IP` :填入服务器的 IP,或者 Docker 容器内部的 IP(如果 NPM 和 Halo 搭建在同一台服务器上的话)
- `Forward Port`:填入 Halo 映射出的端口,这边默认是 `8090`
- `Cache Assets` :缓存,可以选择打开
- `Block Common Exploits` 阻止常见的漏洞,可以选择打开
- `Block Common Exploits`:阻止常见的漏洞,可以选择打开
- `Websockets Support` WS 支持,可以选择打开
- `Access List` 这个是 NPM 自带的一个限制访问功能,这边我们不管,后续可以自行研究。
- `Access List`:这个是 NPM 自带的一个限制访问功能,这边我们不管,后续可以自行研究。
以下是一个样列:
@@ -20,9 +20,9 @@ Podman 采用无守护进程的包容性架构,因此可以更安全、更简
为什么选择 Podman 而不是 Docker ?
这个需要视情况而定, 如果您的主机配置不是很高, 您使用 Docker 时, 因为 Docker 自带的守护进程可能会雪上加霜, 它会大量占用您的资源。
这个需要视情况而定如果您的主机配置不是很高您使用 Docker 时因为 Docker 自带的守护进程可能会雪上加霜它会大量占用您的资源。
而 Podman 采用无守护进程架构,而且容器是无根模式,您可以在占用资源极小的情况下运行镜像,并且获得很高的安全性。
而且 Podman 与 Docker 高度兼容,您不需要做特别配置即可将 Docker 容器运行在Podman 上。
而且 Podman 与 Docker 高度兼容,您不需要做特别配置即可将 Docker 容器运行在 Podman 上。
[什么是 Podman?](https://www.redhat.com/zh/topics/containers/what-is-podman)
@@ -40,15 +40,15 @@ Podman 采用无守护进程的包容性架构,因此可以更安全、更简
- Podman 安装文档:[https://podman.io/docs/installation](https://podman.io/docs/installation)
:::tip
我们推荐您先阅读 Podman 官方文档对 Podman 有了相关了解后,再考虑通过Linux包管理系统安装 Podman 或者使用文档中指定的方式安装
我们推荐您先阅读 Podman 官方文档对 Podman 有了相关了解后,再考虑通过 Linux 包管理系统安装 Podman 或者使用文档中指定的方式安装。
:::
## 使用 Docker 镜像
:::tip
为什么是 Docker 镜像?
为什么是 Docker 镜像
通过[前言](#前言)我们已经了解了 Podman ,其中提到 ***Podman 与 Docker 高度兼容*** ,正是因为 Podman 完全是为了替代 Docker 而诞生,所以原本的 Docker 生态中的镜像我们可以无需更改直接使用。
通过[前言](#前言)我们已经了解了 Podman,其中提到 ***Podman 与 Docker 高度兼容*** ,正是因为 Podman 完全是为了替代 Docker 而诞生,所以原本的 Docker 生态中的镜像我们可以无需更改直接使用。
:::
<DockerRegistryList />
@@ -115,7 +115,7 @@ Podman 没有和 Docker 类似的管理进程,在低配置的主机上更友
但是使用 Podman 想要开机后自动启动,官方推荐一种和 systemd 服务类似的语法文件,即 Podman Quadlet。
:::
下面是一个使用 Podstgresql 数据库的示例:
下面是一个使用 Podstgresql 数据库的示例
```bash
mkdir -p /opt/podman-data/halo
@@ -162,38 +162,38 @@ systemctl start halo
# 之后重启会自动启动不需要enable服务.
```
Podman Quadlet 解析:
Podman Quadlet 解析
`[Unit]` 部分:
`[Unit]` 部分
- WantsAfter字段指定了Halo在什么服务后启动。
- WantsAfter 字段指定了 Halo 在什么服务后启动。
`[Container]` 部分:
`[Container]` 部分
- `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`。
- `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`。
- `ContainerName=`指定了 systemd 将生成的服务名称。
- `User=60000 Group=60000 UserNS=keep-id:uid=60000,gid=60000` 限制容器以 id 60000 的用户运行,提高安全性。注意这个id 60000请根据你实际想要运行的用户名来修改,可通过`id user`获得你的用户的id.
- `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`路径。
- `Volume=`字段指定挂载到容器储存Halo配置文件的路径,请仔细观察`/opt/podman-data/halo:/.halo`其中的`/.halo`要与上面需要注意的环境变量路径要一致。
- `PublishPort=`和docker -p命令一致,即需要映射的端口。
- `Image=ghcr.io/halo-dev/halo` 即Docker镜像的地址,注意要完整的。比如`ghcr.io`这个路径就不能少,如果你没有配置 Podman 的 registries 文件,此路径就必不可少,建议写全。
- `Exec=` 即附加到Halo容器的 Command ,具体变量参考上方的 DockerArgs 。多个变量以空格分开。
- `Volume=`字段指定挂载到容器储存 Halo 配置文件的路径,请仔细观察`/opt/podman-data/halo:/.halo`其中的`/.halo`要与上面需要注意的环境变量路径要一致。
- `PublishPort=`和 docker -p 命令一致,即需要映射的端口。
- `Image=ghcr.io/halo-dev/halo` 即 Docker 镜像的地址,注意要完整的。比如`ghcr.io`这个路径就不能少,如果你没有配置 Podman 的 registries 文件,此路径就必不可少,建议写全。
- `Exec=` 即附加到 Halo 容器的 Command,具体变量参考上方的 DockerArgs。多个变量以空格分开。
`[Service]` 部分:
即原生systemd语法
`[Service]` 部分
即原生 systemd 语法
- `Restart` 指定遇到错误后总是重启容器
- `RestartSec` 重启的间隔时间
- `StartLimitInterval` 重启的次数,超过这个次数将不再重启。
- `TimeoutStartSec` 启动容器的超时时间,建议不要修改,因为每次开机后 Podman 将自动拉取容器,这时也许耗时会很长,这些时间是算在启动时间中的。如果定义太小的时间,可能将导致 Podman 无法拉取容器镜像。
- `TimeoutStopSec` 停止容器时的超时时间,`systemctl stop halo` 假设使用这个命令,如果停止时间超过了`TimeoutStopSec`定义的时间,将会被系统Kill.
- `TimeoutStopSec` 停止容器时的超时时间,`systemctl stop halo` 假设使用这个命令,如果停止时间超过了`TimeoutStopSec`定义的时间,将会被系统 Kill.
`[Install]` 部分:
`[Install]` 部分
此部分请查看systemd文档,不建议修改。
此部分请查看 systemd 文档,不建议修改。
使用默认的 root 用户运行时无需定义 `User=60000 Group=60000 UserNS=keep-id:uid=60000,gid=60000` 与 `Environment=HALO_WORK_DIR="/.halo"` `Environment=SPRING_CONFIG_LOCATION="optional:classpath:/;optional:file:/.halo/"`
示例:
示例
```bash
mkdir -p /opt/podman-data/halo