> For AI agents: the complete documentation index is available at https://docs.halo.run/llms.txt, the full documentation bundle is available at https://docs.halo.run/llms-full.txt. # 使用 Podman 部署 ## 前言 :::info 先阅读《写在前面》 在继续操作之前，我们推荐您先阅读[《写在前面》](https://docs.halo.run/guide/prepare.md)，这可以快速帮助你了解 Halo。 ::: :::info Podman 简介与适用场景 什么是 Podman ? Podman（全称 POD 管理器）是一款用于在 Linux® 系统上开发、管理和运行容器的开源工具。Podman 最初由红帽® 工程师联合开源社区一同开发，它可利用 lipod 库来管理整个容器生态系统。 Podman 采用无守护进程的包容性架构，因此可以更安全、更简单地进行容器管理，再加上 Buildah 和 Skopeo 等与之配套的工具和功能，开发人员能够按照自身需求来量身定制容器环境。 为什么选择 Podman 而不是 Docker ? 这个需要视情况而定，如果您的主机配置不是很高，您使用 Docker 时，因为 Docker 自带的守护进程可能会雪上加霜，它会大量占用您的资源。 而 Podman 采用无守护进程架构，而且容器是无根模式，您可以在占用资源极小的情况下运行镜像，并且获得很高的安全性。 而且 Podman 与 Docker 高度兼容，您不需要做特别配置即可将 Docker 容器运行在 Podman 上。 [什么是 Podman?](https://www.redhat.com/zh/topics/containers/what-is-podman) [Podman ArchWiki](https://wiki.archlinux.org/title/Podman) [Podman 官网](https://podman.io/) ::: :::tip 不建议在生产环境使用 H2 此文档提供使用默认 H2 数据库和 Postgresql 数据库的 Podman 运行示例，在生产环境我们不推荐使用 H2 数据库。 ::: ## 环境搭建 - Podman 安装文档：[https://podman.io/docs/installation](https://podman.io/docs/installation) :::tip 先阅读 Podman 官方文档 我们推荐您先阅读 Podman 官方文档对 Podman 有了相关了解后，再考虑通过 Linux 包管理系统安装 Podman 或者使用文档中指定的方式安装。 ::: ## 部署 Halo :::tip Podman 可直接使用 Docker 镜像 为什么是 Docker 镜像？ 通过[前言](#前言)我们已经了解了 Podman，其中提到 **_Podman 与 Docker 高度兼容_** ，正是因为 Podman 完全是为了替代 Docker 而诞生，所以原本的 Docker 生态中的镜像我们可以无需更改直接使用。 ::: ### 镜像说明 Halo 主要区分为[社区版和付费版](https://docs.halo.run/guide/prepare.md#%E5%8F%91%E8%A1%8C%E7%89%88%E6%9C%AC)，这两个版本使用不同的 Docker 镜像，以下是 Docker Hub 的官方镜像地址： - [Halo 付费版镜像](https://hub.docker.com/r/halohub/halo-pro/tags)：包括 [Halo 专业版](https://www.lxware.cn/halo?code=mcYhwMkn) 和 [Halo 商城版](https://www.lxware.cn/halo?code=mcYhwMkn)，包含社区版的所有功能，并提供额外的付费功能，部分付费功能需要使用许可证激活 - [Halo 社区版镜像](https://hub.docker.com/r/halohub/halo/tags)：使用 Halo 的[开源仓库](https://github.com/halo-dev/halo)构建，不包含任何付费功能，也不支持激活许可证 镜像名称由以下组成： ```bash # 付费版 halohub/halo-pro: # 社区版 halohub/halo: ``` `` 表示 Halo 的具体版本号，比如 `2.26.0`，版本命名方式遵循 [SemVer](https://semver.org/lang/zh-CN/)，即 `..` 除了具体版本号的标签之外，Halo 还提供了 `:` 和 `:.` 的标签，比如： - `halohub/halo-pro:2`：代表整个 Halo 2 的最新版本 - `halohub/halo-pro:2.20`：代表 Halo 2.20 的最新版本 以上是 Docker Hub 的官方镜像地址，如果你的服务器因为网络原因导致拉取速度缓慢，也可以使用我们自行搭建的镜像库： - 付费版：`registry.fit2cloud.com/halo/halo-pro` - 社区版：`registry.fit2cloud.com/halo/halo` 后续文档将使用 `registry.fit2cloud.com/halo/halo-pro` 为例，如果你需要安装社区版，需要将 `halo-pro` 替换为 `halo`。 ### 创建容器 ```bash mkdir -p ~/.halo2 podman run -it -d --name halo -p 8090:8090 -v ~/.halo2:/root/.halo2:Z registry.fit2cloud.com/halo/halo-pro:2.26 ``` :::info 默认使用 H2 数据库 注意：此命令默认使用自带的 H2 Database 数据库。如需使用 PostgreSQL，请参考：[使用 Docker Compose 部署](https://docs.halo.run/guide/install/docker-compose.md) ::: - **-it**：开启输入功能并连接伪终端 - **-d**：后台运行容器 - **--name**：为容器指定一个名称 - **-p**：端口映射，格式为 `主机(宿主)端口:容器端口` ，可在 `application.yaml` 配置。 - **-v**：工作目录映射。形式为：`-v 宿主机路径:/root/.halo2`，后者不能修改。 运行参数详解： | 参数名 | 描述 | | -------------------------- | ---------------------------------------------- | | `spring.r2dbc.url` | 数据库连接地址，详细可查阅下方的 `数据库配置` | | `spring.r2dbc.username` | 数据库用户名 | | `spring.r2dbc.password` | 数据库密码 | | `spring.sql.init.platform` | 数据库平台名称，支持 `postgresql`、`mysql`、`mariadb`、`h2` | | `halo.external-url` | 外部访问链接，如果需要在公网访问，需要配置为实际访问地址 | 数据库配置： | 链接方式 | 链接地址格式 | `spring.sql.init.platform` | | -------------- | ---------------------------------------------------------------------------------- | -------------------------- | | PostgreSQL（推荐） | `r2dbc:pool:postgresql://{HOST}:{PORT}/{DATABASE}` | postgresql | | MySQL | `r2dbc:pool:mysql://{HOST}:{PORT}/{DATABASE}` | mysql | | MariaDB | `r2dbc:pool:mariadb://{HOST}:{PORT}/{DATABASE}` | mariadb | | H2 Database | `r2dbc:h2:file:///${halo.work-dir}/db/halo-next?MODE=MySQL&DB_CLOSE_ON_EXIT=FALSE` | h2 | :::info 查看完整配置 为了保持部署流程的简洁，此文档仅提供了必要的配置示例，完整的配置选项列表可查阅：[配置说明](https://docs.halo.run/guide/install/config.md) ::: ### 测试访问 用浏览器访问 `/console` 即可进入 Halo 管理页面，首次启动会进入初始化页面。 :::tip 初始化前配置访问地址 如果需要配置域名访问，建议先配置好反向代理以及域名解析再进行初始化。如果通过 `http://ip:端口号` 的形式无法访问，请到服务器厂商后台将运行的端口号添加到安全组，如果服务器使用了 Linux 面板，请检查此 Linux 面板是否有还有安全组配置，需要同样将端口号添加到安全组。 ::: ### 激活许可证 可以参考 [许可证激活](https://docs.halo.run/guide/use/activate.md) 进行激活，社区版无需此步骤。 ## 升级 Halo ### 备份数据 可以参考 [备份与恢复](https://docs.halo.run/guide/use/backup.md) 进行完整备份（可选，但推荐备份）。 ### 拉取新版本镜像 ```bash podman pull registry.fit2cloud.com/halo/halo-pro:2.26 ``` ### 停止运行中的容器 ```bash podman stop halo podman rm halo ``` ### 更新 Halo 修改版本号后，按照最初安装的方式，重新创建容器即可。 ```bash podman run -it -d --name halo -p 8090:8090 -v ~/.halo2:/root/.halo2:Z registry.fit2cloud.com/halo/halo-pro:2.26 ``` ## 使用 [Podman Quadlet](https://docs.podman.io/en/latest/markdown/podman-systemd.unit.5.html) :::tip 使用 Quadlet 实现开机启动 Podman 没有和 Docker 类似的管理进程，在低配置的主机上更友好。 但是使用 Podman 想要开机后自动启动，官方推荐一种和 systemd 服务类似的语法文件，即 Podman Quadlet。 ::: 下面是一个使用 Podstgresql 数据库的示例： ```bash mkdir -p /opt/podman-data/halo mkdir -p /etc/containers/systemd vim /etc/containers/systemd/halo.container ``` ```ini [Unit] Description=The halo container Wants=network-online.target After=network-online.target [Container] AutoUpdate=registry ContainerName=halo User=60000 Group=60000 UserNS=keep-id:uid=60000,gid=60000 Environment=JVM_OPTS="-Xmx512m -Xms256m" Environment=HALO_WORK_DIR="/.halo" Environment=SPRING_CONFIG_LOCATION="optional:classpath:/;optional:file:/.halo/" Environment=TZ=Asia/Shanghai Volume=/opt/podman-data/halo:/.halo:Z PublishPort=127.0.0.1:8090:8090 Image=ghcr.io/halo-dev/halo:2.26 Exec=--halo.external-url=https://localhost:8090 --spring.sql.init.platform=postgresql --spring.r2dbc.url=r2dbc:pool:postgresql://host.containers.internal:5432/my-db --spring.r2dbc.username=my-user --spring.r2dbc.password=my-password [Service] Restart=always RestartSec=30s TimeoutStartSec=900 TimeoutStopSec=70 [Install] WantedBy=multi-user.target default.target ``` ```bash systemctl daemon-reload systemctl start halo # 只需要systemctl start halo. # 之后重启会自动启动不需要enable服务. ``` Podman Quadlet 解析： `[Unit]` 部分： - Wants 和 After 字段指定了 Halo 在什么服务后启动。 `[Container]` 部分： - `AutoUpdate=registry`指定了自动拉取容器。假设后续 Halo 镜像支持了`latest`标签，你需要`systemctl enable --now podman-auto-update.timer`以启用容器自动更新。本文示例`ghcr.io/halo-dev/halo:2.26`，将会自动更新适用与`2.26`版本的 patch，例如您创建容器时是`2.26.1`，在官方发布`2.26.2`版本时，容器会自动更新到`2.26.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`路径。 - `Volume=`字段指定挂载到容器储存 Halo 配置文件的路径，请仔细观察`/opt/podman-data/halo:/.halo:Z`其中的`/.halo`要与上面需要注意的环境变量路径要一致，`:Z` 用于为挂载目录设置 SELinux 标签。 - `PublishPort=`和 docker -p 命令一致，即需要映射的端口。 - `Image=ghcr.io/halo-dev/halo` 即 Docker 镜像的地址，注意要完整的。比如`ghcr.io`这个路径就不能少，如果你没有配置 Podman 的 registries 文件，此路径就必不可少，建议写全。 - `Exec=` 即附加到 Halo 容器的 Command，具体变量参考上方的 DockerArgs。多个变量以空格分开。示例中的 `host.containers.internal` 指向宿主机，如果数据库位于其他主机，请替换为实际地址。 `[Service]` 部分： 即原生 systemd 语法 - `Restart` 指定遇到错误后总是重启容器 - `RestartSec` 重启的间隔时间 - `TimeoutStartSec` 启动容器的超时时间，建议不要修改，因为每次开机后 Podman 将自动拉取容器，这时也许耗时会很长，这些时间是算在启动时间中的。如果定义太小的时间，可能将导致 Podman 无法拉取容器镜像。 - `TimeoutStopSec` 停止容器时的超时时间，`systemctl stop halo` 假设使用这个命令，如果停止时间超过了`TimeoutStopSec`定义的时间，将会被系统 Kill. `[Install]` 部分： 此部分请查看 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 mkdir -p /etc/containers/systemd vim /etc/containers/systemd/halo.container ``` ```ini # /etc/containers/systemd/halo.container [Unit] Description=The halo container Wants=network-online.target After=network-online.target [Container] AutoUpdate=registry ContainerName=halo Volume=/opt/podman-data/halo:/root/.halo2:Z PublishPort=127.0.0.1:8090:8090 Image=ghcr.io/halo-dev/halo:2.26 Exec=--halo.external-url=https://localhost:8090 --spring.sql.init.platform=postgresql --spring.r2dbc.url=r2dbc:pool:postgresql://host.containers.internal:5432/my-db --spring.r2dbc.username=my-user --spring.r2dbc.password=my-password [Service] Restart=always RestartSec=30s TimeoutStartSec=900 TimeoutStopSec=70 [Install] WantedBy=multi-user.target default.target ```