免费开始

GitHub

复制一个包含安装步骤和本插件的全Markdown指南的配置提示。

本文档将解释如何运行您的自动更新服务器。

服务您的捆绑包

确保您的捆绑包通过 HTTPS 服务，并且服务器具有正确的 CORS 头来允许应用程序下载更新。例如： https://myserver.com/app/updates/updates.json

如果您不熟悉服务捆绑包，我们建议您尝试 Capgo 云或查看以下示例：

服务捆绑包

配置

添加一个 updateUrl 到您的 capacitor.config.json.

{
  "plugins": {
    "CapacitorUpdater": {
      "updateUrl": "https://myserver.com/app/updates/updates.json",
    }
  }
}

更新API

插件将每次打开应用时向您的API发送一个POST请求，请求体如下：

interface AppInfos {
    "platform": "ios" | "android" | "electron",
    "device_id": "UUID_of_device_unique_by_install",
    "app_id": "APPID_FROM_CAPACITOR_CONFIG",
    "custom_id": "your_custom_id_set_on_runtime",
    "plugin_version": "PLUGIN_VERSION",
    "version_build": "VERSION_NUMBER_FROM_NATIVE_CODE",
    "version_code": "VERSION_CODE_FROM_NATIVE_CODE",
    "version_name": "LAST_DOWNLOADER_VERSION" | "builtin"
    "version_os": "VERSION_OF_SYSTEM_OS",
    "is_emulator": boolean,
    "is_prod": boolean,
}

服务器应以 JSON 格式响应 API，并将此数据传递给 capacitor-updater 插件。如果有更新：

{
"version": "1.2.3",
"url": "https://myserver.com/app/updates/my-new-app-2.0.0.zip",
"checksum": "sha256_checksum_of_bundle"
}

在自动更新模式下，服务器应比较版本并返回正确的版本，如果 URL 键存在，则启动下载过程。

如果您添加“message”和“error”键，则版本将不会被设置，消息将在日志中显示而不是版本。

version key 应该在 semver 格式。

zip 文件应包含 index.html 作为根目录下的文件，或根目录下只有一个文件夹，且 index.html 文件夹内。

您可以使用 CLI 命令对您的捆绑包进行压缩：

npx @capgo/cli bundle zip --path [/path/to/my/bundle]

生成包校验和

重要: You must use the Capgo CLI to create your bundle zip file. The Capgo plugin requires a specific zip format and structure that is only guaranteed when using the official CLI tool. Standard zip utilities may create incompatible archives.

要为您的包生成校验和，请使用 Capgo CLI zip 命令并添加以下标志: --json 标志:

npx @capgo/cli bundle zip [appId] --json

此命令将:

创建与 Capgo 插件兼容的正确格式化 zip 文件
生成 SHA256 校验和以进行完整性验证
输出包信息以 JSON 格式

示例输出:

{
  "version": "1.2.3",
  "checksum": "a1b2c3d4e5f6789...",
  "size": 1234567
}

使用 checksum 确保在您的API响应中包含此输出的值，以便插件在安装前验证包的完整性。

继续使用 Auto Update

如果您正在使用 自动更新 来规划迁移和企业运营，连接它与使用 @capgo/capacitor-updater 来使用 @capgo/capacitor-updater 的本地能力 Capgo 企业版为Capgo 企业版产品工作流 ionic 企业版插件替代品为ionic 企业版插件替代品产品工作流 Capgo 替代品为Capgo 替代品产品工作流 Capgo 咨询为Capgo 咨询产品工作流