插件安装指南

在 Halo 中安装 Dishes(家庭私厨) 插件的两种方式:

方式适用场景
应用市场安装日常使用,版本由市场分发,推荐
手动上传安装开发调试、使用 Release / 自行构建的 Jar

一、应用市场安装(推荐)

最简单、与 Halo 版本匹配关系一般由市场托管。

步骤

  1. 登录 Halo 管理后台
  2. 打开 插件应用市场(或「插件市场」,以当前 Halo 界面为准)
  3. 搜索 Dishes / 家庭私厨
  4. 点击 安装,安装完成后在插件列表中 启用

提示:若市场展示的插件名与文档略有差异,以应用市场实际展示为准。


二、手动上传安装

适用于:GitHub Release、CI 产物,或本地 ./gradlew build 打出的插件包。

1. 获取插件构建包(.jar

途径 A — GitHub Release(推荐)

途径 B — 本地构建

在项目根目录执行:

./gradlew clean build
# Windows
.\gradlew.bat clean build

产物目录:build/libs/,选择其中的 .jar 插件包(勿解压)。

提示:文件名不必手写为 plugin-name-1.x.jar,以 build/libs 或 Release 附件里的实际文件名为准。

2. 在 Halo 中上传并启用

  1. 登录 Halo 管理后台
  2. 进入 插件安装(或等价入口)
  3. 选择 手动上传 / 本地安装
  4. 选中下载或构建好的 .jar,等待上传完成
  5. 在插件列表中找到 Dishes(家庭私厨),点击 启用

三、环境与兼容性

安装前建议确认:

检查项说明
Halo 版本本插件要求见仓库 plugin.yaml 中的 spec.requires(示例:>=2.23.0
Jar 完整性下载不完整或传输损坏会导致安装失败,可重新下载或校验 Release 附件

四、常见问题(FAQ)

插件上传失败?

可能原因包括:

  • Jar 损坏或未下载完整 → 重新下载或本地重新 build
  • Halo 版本过低,不满足 requires → 升级 Halo 或选用兼容的旧版插件
  • 上传了 错误文件类型(非插件 Jar)

插件无法启用?

建议逐项检查:

  • Halo 日志中是否有该插件的报错栈
  • 是否与当前 Halo 主版本不兼容
  • 磁盘权限、插件目录是否正常(依部署方式而定)

安装后在后台看不到菜单或前台打不开?

可尝试:

  • 重启 Halo 进程或容器
  • 浏览器 强制刷新 或清理插件相关缓存后重试
  • 插件设置 中检查前台路径、访问模式等配置(参见 README)

五、获取更多帮助

  • 反馈问题:GitHub Issues

文档版本随仓库更新;若与市场安装入口不一致,以当前 Halo 控制台界面为准。