Auto Update

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

バンドルを配信

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

code updateUrl API capacitor.config.json.

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

npm

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

バンドルを配信する方法については、ご存知ですか？ API Cloud を試してみたり、ここで例を参照してみたりしてください。

アプリが開いたときに、プラグインは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 プラグインに適合した正しくフォーマットされた 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 を使用して、企業向けオペレーションとマイグレーション計画を計画している場合、Auto Update を接続してください。 __CAPGO_KEEP_0__ Capgoの@capgo/capacitor-updater Capgoの@capgo/capacitor-updaterの Capgo Enterprise for the product workflow in Capgo Enterprise, Capgoエンタープライズ CapgoのIonicエンタープライズプラグインの代替 Capgo Alternatives for the product workflow in Capgo Alternatives, and Capgo Consulting for the product workflow in Capgo Consulting.