自动更新

GitHub

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

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

服务您的捆绑包

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

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

服务捆绑包

配置

添加 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,
}

服务器 API 应该以 JSON 格式响应，capacitor-updater 插件将使用此数据，如果有更新：

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

In Auto-update 模式下，服务器应比较版本并返回正确的版本，如果 URL 键存在，则插件会启动下载过程。

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

version 键应在 semver 格式。

zip 应该有 index.html 作为根目录的文件，或只有一个根目录的文件夹 index.html 内部。

您可以使用 CLI 命令来压缩您的捆绑包：

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

生成捆绑包校验和

重要提示： 您必须使用 Capgo CLI 来创建您的打包 zip 文件。 Capgo 插件需要特定的 zip 格式和结构，这些格式和结构只有使用官方 CLI 工具时才会被保证。标准 zip 工具可能会创建不兼容的存档。

要为您的打包生成校验和，请使用 Capgo CLI zip 命令并指定 --json 标志：

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

此命令将：

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

示例输出：

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

使用以下输出的值在您的__CAPGO_KEEP_0__响应中来确保插件在安装前可以验证捆绑包完整性。 checksum 使用此输出的值在您的API响应中来确保插件在安装前可以验证捆绑包完整性。

继续从自动更新

如果您正在使用 自动更新 来规划迁移和企业运营，连接它与使用@capgo/capacitor-updater 为native能力在使用@capgo/capacitor-updater Capgo企业为产品工作流程在Capgo企业 Ionic企业插件替代品 Ionic 企业插件替代方案的产品工作流程 Capgo Alternatives for the product workflow in Capgo Alternatives, and Capgo 咨询 for the product workflow in Capgo Consulting.