メインコンテンツへスキップ

自動アップデート

GitHub

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

BundleがHTTPS経由で配信され、アプリが更新をダウンロードできるように、サーバーに適切なCORSヘッダーが設定されていることを確認してください。 例: https://myserver.com/app/updates/updates.json

Bundleの配信に慣れていない場合は、Capgo Cloudを試すことをおすすめします。こちらの例も参照してください:

追加する updateUrl あなたの capacitor.config.json.

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

このプラグインは、アプリを開くたびに 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"
}

Auto-updateモードでは、サーバーがバージョンを比較して適切なものを返す必要があります。URLキーが存在する場合、プラグインはダウンロードプロセスを開始します。

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

version キーの形式は semver である必要があります。

zipファイルには index.html をルートに配置するか、ルートに1つのフォルダのみを配置し、その中に index.html を含める必要があります。

CLI のコマンドを使用して、bundleをzip圧縮できます:

サーバーから配信するファイルを含むbundleを作成する
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
}

以下の checksum プラグインがインストール前にバンドルの整合性を検証できるよう、この出力値を API レスポンスに含めてください。

使用している場合 自動アップデート 移行とエンタープライズ運用を計画するには、次と連携してください @capgo/capacitor-updater を使用する 「@capgo/capacitor-updater を使用する」のネイティブ機能については、 Capgo エンタープライズ Capgo Enterprise のプロダクトワークフロー向けに、 Ionic Enterprise プラグインの代替案 Ionic Enterprise Plugin Alternatives のプロダクトワークフロー向けに、 Capgo の代替案 Capgo Alternatives のプロダクトワークフロー向け、および Capgo コンサルティング Capgo Consulting のプロダクトワークフロー向けに。