跳到主要内容
版本：2.23

使用 Docker Compose 部署

信息

在继续操作之前，我们推荐您先阅读《写在前面》，这可以快速帮助你了解 Halo。

环境搭建​

部署 Halo​

镜像说明​

Halo 主要区分为社区版和付费版，这两个版本使用不同的 Docker 镜像，以下是 Docker Hub 的官方镜像地址：

镜像名称由以下组成：

# 付费版
halohub/halo-pro:<version>

# 社区版
halohub/halo:<version>

<version> 表示 Halo 的具体版本号，比如 2.23.0，版本命名方式遵循 SemVer，即 <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。

创建容器​

  1. 在系统任意位置创建一个文件夹，此文档以 ~/halo 为例。

    mkdir ~/halo && cd ~/halo
    信息

    注意：后续操作中，Halo 产生的所有数据都会保存在这个目录，请妥善保存。

  2. 创建 docker-compose.yaml

    此文档提供几种场景的 Docker Compose 配置文件，请根据你的需要选择一种。

    ~/halo/docker-compose.yaml
    services:
      halo:
        image: registry.fit2cloud.com/halo/halo-pro:2.23
        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:
    信息

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

    运行参数详解：

    参数名描述
    spring.r2dbc.url数据库连接地址，详细可查阅下方的 数据库配置
    spring.r2dbc.username数据库用户名
    spring.r2dbc.password数据库密码
    spring.sql.init.platform数据库平台名称，支持 postgresql、mysql、mariadb、oracle、h2
    halo.external-url外部访问链接，如果需要在公网访问，需要配置为实际访问地址

    数据库配置：

    链接方式链接地址格式spring.sql.init.platform
    PostgreSQL（推荐）r2dbc:pool:postgresql://{HOST}:{PORT}/{DATABASE}postgresql
    MySQLr2dbc:pool:mysql://{HOST}:{PORT}/{DATABASE}mysql
    MariaDBr2dbc:pool:mariadb://{HOST}:{PORT}/{DATABASE}mariadb
    Oracle（付费版）r2dbc:pool:oracle://{HOST}:{PORT}/{DATABASE}oracle
    H2 Databaser2dbc:h2:file:///${halo.work-dir}/db/halo-next?MODE=MySQL&DB_CLOSE_ON_EXIT=FALSEh2
    商城版需要注意

    由于商城版的数据结构与 Halo 其他版本不同，所以暂时仅支持 PostgreSQL、MySQL、MariaDB、H2。

    Oracle 用户需要注意

    由于 Oracle 数据库各个版本的差异，目前很难统一提供自动执行的 SQL 脚本，所以配置 Oracle 数据库连接之前，需要先手动创建数据库以及执行表创建脚本。以下是具体步骤：

    1. 在 Oracle 数据库中创建数据库，比如 halo。

    2. 添加 Halo 的启动参数 --spring.sql.init.mode=never。

    3. 执行创建表的 SQL 脚本，下面提供两种脚本，可以按照 Oracle 数据库的版本自行选择：

      如果你的 Oracle 数据库不支持 IF NOT EXISTS 语法：

       DECLARE 
           table_count INTEGER;
       BEGIN
           SELECT COUNT(*)
           INTO table_count
           FROM all_tables
           WHERE table_name = 'EXTENSIONS';
       
           IF table_count = 0 THEN
               EXECUTE IMMEDIATE '
                   CREATE TABLE extensions
                   (
                       name    VARCHAR2(255) NOT NULL,
                       data    BLOB,
                       version NUMBER,
                       CONSTRAINT pk_name PRIMARY KEY (name)
                   )';
           END IF;
       END;
       /

      如果你的 Oracle 数据库支持 IF NOT EXISTS 语法：

       CREATE TABLE IF NOT EXISTS EXTENSIONS (
           NAME    VARCHAR2(255) NOT NULL,
           DATA    BLOB,
           VERSION NUMBER,
           CONSTRAINT PK_NAME PRIMARY KEY ( NAME )
       );
    信息

    为了保持部署流程的简洁，此文档仅提供了必要的配置示例，完整的配置选项列表可查阅：配置说明

  3. 启动 Halo 服务

    docker compose up -d

    实时查看日志：

    docker-compose logs -f

  4. 用浏览器访问 /console 即可进入 Halo 管理页面，首次启动会进入初始化页面。

    提示

    如果需要配置域名访问，建议先配置好反向代理以及域名解析再进行初始化。如果通过 http://ip:端口号 的形式无法访问，请到服务器厂商后台将运行的端口号添加到安全组，如果服务器使用了 Linux 面板，请检查此 Linux 面板是否有还有安全组配置，需要同样将端口号添加到安全组。

  5. 激活许可证，可以参考 许可证激活 进行激活，社区版无需此步骤。

升级 Halo​

  1. 备份数据，可以参考 备份与恢复 进行完整备份（可选，但推荐备份）。

  2. 更新 Halo 服务

    修改 docker-compose.yaml 中配置的镜像版本。

    services:
     halo:
       image: registry.fit2cloud.com/halo/halo-pro:2.23
    docker compose up -d

反向代理​

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

  1. 使用 Nginx Proxy Manager
  2. 使用 Traefik

Nginx​

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​

www.yourdomain.com

encode gzip

reverse_proxy 127.0.0.1:8090

Traefik​

更新 halo 容器组的配置

  1. networks 中引入已存在的网络 traefik（此网络需要 提前创建）
  2. services.halo.networks 中添加网络 traefik
  3. 修改外部地址为你的域名
  4. 声明路由规则、开启 TLS
networks:
  traefik:
    external: true
  halo:

services:
  halo:
    image: registry.fit2cloud.com/halo/halo-pro:2.23
    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