凌霞帮助中心

INFO

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

说明

Halo 专业版的部署方式和社区版完全一致，只有 Docker 镜像不同，我们为 Halo 专业版提供了单独的镜像。

环境搭建

Docker 安装文档：https://docs.docker.com/engine/install/
Docker Compose 安装文档：https://docs.docker.com/compose/install/

TIP

我们推荐按照 Docker 官方文档安装 Docker 和 Docker Compose，因为部分 Linux 发行版软件仓库中的 Docker 版本可能过旧。

部署

目前 Halo 官方维护的 Docker 镜像仓库，可以根据自己的需求选择合适的镜像源：

registry.fit2cloud.com/halo/halo-pro
halohub/halo-pro

注意

目前 Halo 2 并未更新 Docker 的 latest 标签镜像，主要因为 Halo 2 不兼容 1.x 版本，防止使用者误操作。我们推荐使用固定版本的标签，比如 2.17 或者 2.20.0。

registry.fit2cloud.com/halo/halo-pro:2：表示最新的 2.x 版本，即每次发布新版本都会更新此镜像。
registry.fit2cloud.com/halo/halo-pro:2.20：表示最新的 2.20.x 版本，即每次发布 patch 版本都会同时更新此镜像。
registry.fit2cloud.com/halo/halo-pro:2.20.0：表示一个具体的版本。

后续文档以 registry.fit2cloud.com/halo/halo-pro:2.20 为例。

创建目录

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

mkdir ~/halo && cd ~/halo

INFO

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

创建 `docker-compose.yaml`

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

INFO

需要注意的是，此文档为了更加方便的管理配置，所有与 Halo 相关的配置都使用 Docker 容器启动参数代替，所以无需创建 application.yaml 文件。

Halo + PostgreSQL

version: "3"

services:
  halo:
    image: registry.fit2cloud.com/halo/halo-pro:2.20
    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          
    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 数据库容器默认没有设置端口映射，如果需要在容器外部访问数据库，可以自行在 halodb 服务中添加端口映射，PostgreSQL 的端口为 5432。

Halo + MySQL

version: "3"

services:
  halo:
    image: registry.fit2cloud.com/halo/halo-pro:2.20
    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
    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 数据库容器默认没有设置端口映射，如果需要在容器外部访问数据库，可以自行在 halodb 服务中添加端口映射，MySQL 的端口为 3306。

Halo + 内置 H2

WARNING

此方案使用了默认的 H2 数据库，但不推荐在生产环境使用，这可能因为操作不当导致数据文件损坏。如果因为某些原因（如内存不足以运行独立数据库）必须要使用，建议按时备份数据。

version: "3"

services:
  halo:
    image: registry.fit2cloud.com/halo/halo-pro:2.20
    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          
    command:
      # 外部访问地址，请根据实际需要修改
      - --halo.external-url=http://localhost:8090/

Halo + 外部数据库

version: "3"

services:
  halo:
    image: registry.fit2cloud.com/halo/halo-pro:2.20
    restart: on-failure:3
    network_mode: "host"
    volumes:
      - ./halo2:/root/.halo2
    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

运行参数详解：

参数名	描述
`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
MySQL	`r2dbc:pool:mysql://{HOST}:{PORT}/{DATABASE}`	mysql
MariaDB	`r2dbc:pool:mariadb://{HOST}:{PORT}/{DATABASE}`	mariadb
Oracle（专业版）	`r2dbc:pool:oracle://{HOST}:{PORT}/{DATABASE}`	oracle
H2 Database	`r2dbc:h2:file:///${halo.work-dir}/db/halo-next?MODE=MySQL&DB_CLOSE_ON_EXIT=FALSE`	h2

Oracle 用户需要注意

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

在 Oracle 数据库中创建数据库，比如 halo。
添加 Halo 的启动参数 --spring.sql.init.mode=never。

执行创建表的 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 )
 );

启动 Halo 服务

docker-compose up -d

实时查看日志：

docker-compose logs -f

访问 Halo

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

TIP

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

激活 Halo 专业版

初始化完成之后，还需要参考 Halo 专业版许可证激活进行许可证激活，完成之后即可正常使用。

版本升级

备份数据

可以参考备份与恢复进行完整备份。

更新 Halo 服务

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

services:
  halo:
    image: registry.fit2cloud.com/halo/halo-pro:2.20

docker-compose up -d

反向代理

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

使用 Nginx Proxy Manager
使用 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 容器组的配置

networks 中引入和 Traefik 服务的相同网络，这里以 traefik 为例
services.halo.networks 中添加网络 traefik
修改外部地址为你的域名
声明路由规则、开启 TLS

version: "3.8"

networks:
  traefik:
    external: true
  halo:

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

说明

环境搭建

部署

创建目录

创建 docker-compose.yaml

Halo + PostgreSQL

Halo + MySQL

Halo + 内置 H2

Halo + 外部数据库

启动 Halo 服务

访问 Halo

版本升级

备份数据

更新 Halo 服务

反向代理

Nginx

Caddy 2

Traefik

创建 `docker-compose.yaml`