跳到主要内容
版本:2.22

使用 Docker 部署

信息

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

注意

此文档仅提供使用默认 H2 数据库的 Docker 运行方式,主要用于体验和测试,在生产环境我们不推荐使用 H2 数据库,这可能因为操作不当导致数据文件损坏。如果因为某些原因(如内存不足以运行独立数据库)必须要使用,建议按时备份数据

如果需要使用其他数据库部署,我们推荐使用 Docker Compose 部署:使用 Docker Compose 部署

环境搭建

部署 Halo

镜像说明

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

镜像名称由以下组成:

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

# 社区版
halohub/halo:<version>

<version> 表示 Halo 的具体版本号,比如 2.22.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. 创建容器

    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.22
    信息

    注意:此命令默认使用自带的 H2 Database 数据库。如需使用 PostgreSQL,请参考:使用 Docker Compose 部署

    • -it:开启输入功能并连接伪终端
    • -d:后台运行容器
    • --name:为容器指定一个名称
    • -p:端口映射,格式为 主机(宿主)端口:容器端口 ,可在 application.yaml 配置。
    • -v:工作目录映射。形式为:-v 宿主机路径:/root/.halo2,后者不能修改。

    运行参数详解:

    参数名描述
    spring.r2dbc.url数据库连接地址,详细可查阅下方的 数据库配置
    spring.r2dbc.username数据库用户名
    spring.r2dbc.password数据库密码
    spring.sql.init.platform数据库平台名称,支持 postgresqlmysqlmariadboracleh2
    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 )
       );
    信息

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

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

    提示

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

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

升级 Halo

  1. 备份数据,可以参考 备份与恢复 进行完整备份(可选,但推荐备份)。

  2. 拉取新版本镜像

    docker pull registry.fit2cloud.com/halo/halo-pro:2.22
  3. 停止运行中的容器

    docker stop halo
    docker rm halo
  4. 更新 Halo

    修改版本号后,按照最初安装的方式,重新创建容器即可。

    docker run -it -d --name halo -p 8090:8090 -v ~/.halo2:/root/.halo2 registry.fit2cloud.com/halo/halo-pro:2.22