> 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 Compose 部署

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

## 环境搭建

- Docker 安装文档：[https://docs.docker.com/engine/install/](https://docs.docker.com/engine/install/)
- Docker Compose 安装文档：[https://docs.docker.com/compose/install/](https://docs.docker.com/compose/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`。

### 开始搭建


### 创建目录
在系统任意位置创建一个文件夹，此文档以 `~/halo` 为例。
```bash
mkdir ~/halo && cd ~/halo
```
:::info 妥善保存数据目录
注意：后续操作中，Halo 产生的所有数据都会保存在这个目录，请妥善保存。
:::
### 创建 `docker-compose.yaml`
此文档提供几种场景的 Docker Compose 配置文件，请根据你的需要**选择一种**。

**Halo + PostgreSQL（推荐）**

```yaml {25-31,45} title="~/halo/docker-compose.yaml"
services:
  halo:
    image: registry.fit2cloud.com/halo/halo-pro:2.26
    restart: on-failure:3
    depends_on:
      halodb:
        condition: service_healthy
    networks:
      halo_network:
    volumes:
      - ./halo2:/root/.halo2
    ports:
      - "8090:8090"
    healthcheck:
      test:
        ["CMD", "curl", "-f", "http://localhost:8090/actuator/health/readiness"]
      interval: 30s
      timeout: 5s
      retries: 5
      start_period: 30s
    environment:
      # JVM 参数，默认为 -Xmx256m -Xms256m，可以根据实际情况做调整，置空表示不添加 JVM 参数
      - JVM_OPTS=-Xmx256m -Xms256m
    command:
      - --spring.r2dbc.url=r2dbc:pool:postgresql://halodb/halo
      - --spring.r2dbc.username=halo
      # PostgreSQL 的密码，请保证与下方 POSTGRES_PASSWORD 的变量值一致。
      - --spring.r2dbc.password=openpostgresql
      - --spring.sql.init.platform=postgresql
      # 外部访问地址，请根据实际需要修改
      - --halo.external-url=http://localhost:8090/
  halodb:
    image: postgres:15.4
    restart: on-failure:3
    networks:
      halo_network:
    volumes:
      - ./db:/var/lib/postgresql/data
    healthcheck:
      test: ["CMD", "pg_isready"]
      interval: 10s
      timeout: 5s
      retries: 5
    environment:
      - POSTGRES_PASSWORD=openpostgresql
      - POSTGRES_USER=halo
      - POSTGRES_DB=halo
      - PGUSER=halo

networks:
  halo_network:
```
:::info PostgreSQL 容器端口
此示例的 PostgreSQL 数据库容器默认没有设置端口映射，如果需要在容器外部访问数据库，可以自行在 `halodb` 服务中添加端口映射，PostgreSQL 的端口为 `5432`。
:::


**Halo + MySQL**

```yaml {25-31,53} title="~/halo/docker-compose.yaml"
services:
  halo:
    image: registry.fit2cloud.com/halo/halo-pro:2.26
    restart: on-failure:3
    depends_on:
      halodb:
        condition: service_healthy
    networks:
      halo_network:
    volumes:
      - ./halo2:/root/.halo2
    ports:
      - "8090:8090"
    healthcheck:
      test:
        ["CMD", "curl", "-f", "http://localhost:8090/actuator/health/readiness"]
      interval: 30s
      timeout: 5s
      retries: 5
      start_period: 30s
    environment:
      # JVM 参数，默认为 -Xmx256m -Xms256m，可以根据实际情况做调整，置空表示不添加 JVM 参数
      - JVM_OPTS=-Xmx256m -Xms256m
    command:
      - --spring.r2dbc.url=r2dbc:pool:mysql://halodb:3306/halo
      - --spring.r2dbc.username=root
      # MySQL 的密码，请保证与下方 MYSQL_ROOT_PASSWORD 的变量值一致。
      - --spring.r2dbc.password=o#DwN&JSa56
      - --spring.sql.init.platform=mysql
      # 外部访问地址，请根据实际需要修改
      - --halo.external-url=http://localhost:8090/

  halodb:
    image: mysql:8.1.0
    restart: on-failure:3
    networks:
      halo_network:
    command:
      - --default-authentication-plugin=caching_sha2_password
      - --character-set-server=utf8mb4
      - --collation-server=utf8mb4_general_ci
      - --explicit_defaults_for_timestamp=true
    volumes:
      - ./mysql:/var/lib/mysql
      - ./mysqlBackup:/data/mysqlBackup
    healthcheck:
      test: ["CMD", "mysqladmin", "ping", "-h", "127.0.0.1", "--silent"]
      interval: 3s
      retries: 5
      start_period: 30s
    environment:
      # 请修改此密码，并对应修改上方 Halo 服务的 SPRING_R2DBC_PASSWORD 变量值
      - MYSQL_ROOT_PASSWORD=o#DwN&JSa56
      - MYSQL_DATABASE=halo

networks:
  halo_network:
```
:::info MySQL 容器端口
此示例的 MySQL 数据库容器默认没有设置端口映射，如果需要在容器外部访问数据库，可以自行在 `halodb` 服务中添加端口映射，MySQL 的端口为 `3306`。
:::


**Halo + H2**

:::warning 不建议在生产环境使用 H2
不推荐在生产环境使用默认的 H2 数据库，这可能因为操作不当导致数据文件损坏。如果因为某些原因（如内存不足以运行独立数据库）必须要使用，建议按时[备份数据](https://docs.halo.run/guide/use/backup.md)。
:::
```yaml {21} title="~/halo/docker-compose.yaml"
services:
  halo:
    image: registry.fit2cloud.com/halo/halo-pro:2.26
    restart: on-failure:3
    volumes:
      - ./halo2:/root/.halo2
    ports:
      - "8090:8090"
    healthcheck:
      test:
        ["CMD", "curl", "-f", "http://localhost:8090/actuator/health/readiness"]
      interval: 30s
      timeout: 5s
      retries: 5
      start_period: 30s
    environment:
      # JVM 参数，默认为 -Xmx256m -Xms256m，可以根据实际情况做调整，置空表示不添加 JVM 参数
      - JVM_OPTS=-Xmx256m -Xms256m
    command:
      # 外部访问地址，请根据实际需要修改
      - --halo.external-url=http://localhost:8090/
```


**使用外部数据库**

```yaml {5,13-20} title="~/halo/docker-compose.yaml"
services:
  halo:
    image: registry.fit2cloud.com/halo/halo-pro:2.26
    restart: on-failure:3
    network_mode: "host"
    volumes:
      - ./halo2:/root/.halo2
    environment:
      # JVM 参数，默认为 -Xmx256m -Xms256m，可以根据实际情况做调整，置空表示不添加 JVM 参数
      - JVM_OPTS=-Xmx256m -Xms256m
    command:
      # 修改为自己已有的 MySQL 配置
      - --spring.r2dbc.url=r2dbc:pool:mysql://localhost:3306/halo
      - --spring.r2dbc.username=root
      - --spring.r2dbc.password=
      - --spring.sql.init.platform=mysql
      # 外部访问地址，请根据实际需要修改
      - --halo.external-url=http://localhost:8090/
      # 端口号 默认8090
      - --server.port=8090
```
:::info 外部数据库需预先创建
使用外部数据库时，需要提前手动创建好数据库，以 MySQL 为例：
```sql
create database halo character set utf8mb4 collate utf8mb4_bin;
```
:::

运行参数详解：
| 参数名                        | 描述                                             |
| -------------------------- | ---------------------------------------------- |
| `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)
:::
### 启动 Halo 服务
```bash
docker compose up -d
```
实时查看日志：
```bash
docker compose logs -f
```
### 测试访问
用浏览器访问 /console 即可进入 Halo 管理页面，首次启动会进入初始化页面。
:::tip 配置域名访问
如果需要配置域名访问，建议先配置好反向代理以及域名解析再进行初始化。如果通过 `http://ip:端口号` 的形式无法访问，请到服务器厂商后台将运行的端口号添加到安全组，如果服务器使用了 Linux 面板，请检查此 Linux 面板是否有还有安全组配置，需要同样将端口号添加到安全组。
:::
### 激活许可证
可以参考 [许可证激活](https://docs.halo.run/guide/use/activate.md) 进行激活，社区版无需此步骤。

## 升级 Halo


### 备份数据
可以参考 [备份与恢复](https://docs.halo.run/guide/use/backup.md) 进行完整备份（可选，但推荐备份）。
### 更新 Halo 服务
修改 `docker-compose.yaml` 中配置的镜像版本。
```yaml {3}
services:
  halo:
    image: registry.fit2cloud.com/halo/halo-pro:2.26
```
```bash
docker compose up -d
```

## 反向代理

你可以在下面的反向代理软件中任选一项，我们假设你已经安装好了其中一项，并对其的基本操作有一定了解。如果你对它们没有任何了解，可以参考我们更为详细的反向代理文档：

1. 使用 [Nginx Proxy Manager](https://docs.halo.run/guide/install/other/nginxproxymanager.md)
2. 使用 [Traefik](https://docs.halo.run/guide/install/other/traefik.md)

### Nginx

```nginx {2,7,10}
upstream halo {
  server 127.0.0.1:8090;
}
server {
  listen 80;
  listen [::]:80;
  server_name www.yourdomain.com;
  client_max_body_size 1024m;
  location / {
    proxy_pass http://halo;
    proxy_set_header HOST $host;
    proxy_set_header X-Forwarded-Proto $scheme;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
  }
}
```

### Caddy 2

```txt {1,5}
www.yourdomain.com

encode gzip

reverse_proxy 127.0.0.1:8090
```

### Traefik

更新 halo 容器组的配置

1. `networks` 中引入已存在的网络 `traefik`（此网络需要 [提前创建](https://docs.halo.run/guide/install/other/traefik.md#%E5%88%9B%E5%BB%BA-traefik)）
2. `services.halo.networks` 中添加网络 `traefik`
3. 修改外部地址为你的域名
4. 声明路由规则、开启 TLS

```yaml {2-3,14,18,23-29}
networks:
  traefik:
    external: true
  halo:

services:
  halo:
    image: registry.fit2cloud.com/halo/halo-pro:2.26
    restart: on-failure:3
    volumes:
      - ./halo2:/root/.halo2
    networks:
      - traefik
      - halo
    command:
      # 外部访问地址，请根据实际需要修改
      - --halo.external-url=https://yourdomain.com
    labels:
      traefik.enable: "true"
      traefik.docker.network: traefik
      traefik.http.routers.halo.rule: Host(`yourdomain.com`)
      traefik.http.routers.halo.tls: "true"
      traefik.http.routers.halo.tls.certresolver: myresolver
      traefik.http.services.halo.loadbalancer.server.port: 8090
```