コンテンツにスキップ
Capgo - Capacitor アプリ向けライブ更新 Capgo

Auto Update

GitHub

このドキュメントでは、自動更新サーバーを実行する方法を説明します。

バンドルを配信

バンドルを配信するセクション

バンドルがHTTPSで配信されていることを確認し、更新をダウンロードするのに必要なCORSヘッダーがサーバーに設定されていることを確認してください。例えば、 https://myserver.com/app/updates/updates.json

If you’re unfamiliar with serving a bundle, we recommend you try Capgo Cloud or see an example here:

Capacitor

GitHub

Capgo

API updateUrl SDK capacitor.config.json.

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

Update API

「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"
}

自動アップデートモードでは、サーバーはバージョンを比較し、正しいバージョンを返します。URLキーが存在する場合、ダウンロードプロセスを開始します。

「message」と「error」キーを追加すると、バージョンは設定されず、ログに表示されるメッセージが表示されます。

version キーは semver 形式でなければなりません。

zipファイルには index.html rootディレクトリのファイルとして、またはrootディレクトリの1つのフォルダ内に index.html ファイルが含まれている必要があります。

コマンドを使用して、CLI を実行してバンドルを圧縮できます:

サーバーからファイルを提供するためのバンドルを作成します
npx @capgo/cli bundle zip --path [/path/to/my/bundle]

バンドルチェックサムの生成

「バンドルチェックサムの生成」のセクション

重要: バンドル ZIP ファイルを作成するには、Capgo CLI を使用する必要があります。Capgo プラグインでは、公式の CLI ツールを使用することでのみ、特定の ZIP 形式と構造が保証されます。標準の 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 value from this output in your API response to ensure the plugin can verify the bundle integrity before installation.

値を使用して、プラグインがインストール前にバンドルの整合性を確認できるようにする

Auto Update から続ける

「Auto Update から続ける」のセクション Auto Update を使用してマイグレーションとエンタープライズ オペレーションを計画している場合、 Auto Update Capgoの@capgo/capacitor-updater Capgoの@capgo/capacitor-updaterの Capgo Enterprise for the product workflow in Capgo Enterprise, Capgoエンタープライズ イオニクスエンタープライズプラグインの代替 Capgo Alternatives for the product workflow in Capgo Alternatives, and Capgo Consulting for the product workflow in Capgo Consulting.