> 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.

# 使用 Docker 部署

:::info 先阅读《写在前面》
在继续操作之前，我们推荐您先阅读[《写在前面》](https://docs.halo.run/guide/prepare.md)，这可以快速帮助你了解 Halo。
:::

:::warning 仅适合体验和测试
此文档仅提供使用默认 H2 数据库的 Docker 运行方式，主要用于体验和测试，在生产环境我们不推荐使用 H2 数据库，这可能因为操作不当导致数据文件损坏。如果因为某些原因（如内存不足以运行独立数据库）必须要使用，建议按时[备份数据](https://docs.halo.run/guide/use/backup.md)。

如果需要使用其他数据库部署，我们推荐使用 Docker Compose 部署：[使用 Docker Compose 部署](https://docs.halo.run/guide/install/docker-compose.md)
:::

## 环境搭建

- Docker 安装文档：[https://docs.docker.com/engine/install/](https://docs.docker.com/engine/install/)

## 部署 Halo

### 镜像说明

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:<version>

# 社区版
halohub/halo:<version>
```

`<version>` 表示 Halo 的具体版本号，比如 `2.26.0`，版本命名方式遵循 [SemVer](https://semver.org/lang/zh-CN/)，即 `<major>.<minor>.<patch>`

除了具体版本号的标签之外，Halo 还提供了 `:<major>` 和 `:<major>.<minor>` 的标签，比如：

- `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
docker run -it -d --name halo -p 8090:8090 -v ~/.halo2:/root/.halo2 -e JVM_OPTS="-Xmx256m -Xms256m" 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
docker pull registry.fit2cloud.com/halo/halo-pro:2.26
```
### 停止运行中的容器
```bash
docker stop halo
docker rm halo
```
### 更新 Halo
修改版本号后，按照最初安装的方式，重新创建容器即可。
```bash
docker run -it -d --name halo -p 8090:8090 -v ~/.halo2:/root/.halo2 -e JVM_OPTS="-Xmx256m -Xms256m" registry.fit2cloud.com/halo/halo-pro:2.26
```
