将 REBUILD 打包为桌面客户端使用

79 阅读3分钟

将 REBUILD 打包为桌面客户端

REBUILD 基于 Web 技术打造,您可以通过任何电脑浏览器访问,无需下载安装。同时,如您需要也可以将 RB 打包为独立的桌面客户端使用,打包后的客户端可供用户直接下载使用。

在打包后,还将具备以下原生能力:

  • 系统通知(页面内通知由客户端接管显示,点击通知可打开窗口并跳转)
  • 最小化到系统托盘(关闭窗口时隐藏到托盘,点击托盘图标恢复窗口)

本文介绍如何打包桌面客户端,整个过程非常简单方便。打包基于 Electron 和 electron-builder 工具,Windows 环境下即可完成。

1. 下载模板

首先下载模板,然后解压到任意目录,如 D:\works\rebuild-desktop5

2. 修改配置

2.1. 编辑 .env 文件修改基础配置。

  1. 填写您的 RB 访问地址,如 https://nightly.getrebuild.com
  2. 填写应用名称,如“REBUILD”(影响系统通知显示名、窗口标题、托盘提示)
REBUILD_SERVER_URL=https://nightly.getrebuild.com
REBUILD_APP_NAME=REBUILD

如你希望将 AI 助手打包为桌面版使用,可以在访问地址后面加入 /aibot/chat,例如 https://nightly.getrebuild.com/aibot/chat

2.2. 修改图标。

直接替换 resources 目录下的文件即可,无需修改任何配置:

文件用途建议尺寸
resources/icon.png应用图标、安装程序图标512×512 或更大
resources/tray-icon.png系统托盘图标256×256

2.3. 如需自定义应用名称,还须同步修改 electron-builder.yml 中的 productName,它决定了安装后的可执行文件名和安装目录名:

productName: REBUILD  # 建议与 REBUILD_APP_NAME 保持一致

至此,配置完成。

其余配置项不建议修改,您也可以参考项目内 README 了解更多配置说明。

3. 开始打包

当完成 APP 配置后,在项目根目录打开 PowerShell 执行一键打包脚本:

.\build.ps1

脚本会自动检查 Node 环境并安装依赖,整个过程约 3-5 分钟左右(首次打包需下载依赖,视网络情况而定)。完成后在 dist 目录中即可得到安装程序(即 exe 文件)。

我们建议您将安装包上传到 RB 中,进入 RB 管理中心 - 通用配置,在桌面端安装包处点击上传(此功能从 V4.5 版本开始支持)。

image.png

上传后,在登录页面将提供桌面端下载链接,用户点击下载即可安装使用,更为便捷。

企业微信截图_1788692742600.png

进阶使用

代码签名(可选)

默认打包的安装程序未签名,Windows 可能会提示“未知发布者”。如您有代码签名证书,可在 electron-builder.yml 中配置:

win:
  certificateFile: '证书文件路径'
  certificatePassword: '证书密码'

配置后重新打包即可。

更多选项

本文基于 electron-builder 工具编写,更多配置选项也可参阅 electron-builder 官方文档

常见问题

打包时下载依赖超时怎么办

项目已在 .npmrc 中配置国内镜像,正常情况下无需处理。如仍超时,可重试或删除 node_modules 目录后重新执行 .\build.ps1

能否打包 macOS 版本

可以,但 macOS 应用须在 macOS 环境下打包,且需要苹果开发者证书签名,需要较多知识储备,非专业用户不建议尝试。

是否支持 Win7 系统

默认支持 Win10/Win11 64 位操作系统,Win7/8 或 32 位系统请 下载此模板 使用。