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

Auto Update

GitHub

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

バンドルを配信

バンドルが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",
    }
  }
}

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サーバーは、capacitor-updater プラグインにJSON形式で返答する必要があります。必要なアップデートがある場合、以下のデータを返します。

{
"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 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_KEEP_0__ __CAPGO_KEEP_1__

  • Create a properly formatted zip file compatible with the Capgo plugin
  • __CAPGO_KEEP_0__プラグインのために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を接続してください

Use the value from this output in your __CAPGO_KEEP_0__ response to ensure the plugin can verify the bundle integrity before installation. Copy to clipboard Example output: Using @capgo/capacitor-updater for the native capability in Using @capgo/capacitor-updater, Capgo Enterprise for the product workflow in Capgo Enterprise, イオニックエンタープライズプラグインの代替 イオニックエンタープライズプラグインの代替の製品フローで Capgo Alternatives for the product workflow in Capgo Alternatives, and Capgo Consulting for the product workflow in Capgo Consulting.