自動更新

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

バンドルを配信

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

注意

自社ホストの更新をプッシュする場合、Androidアプリのセキュリティポリシーに違反するため、HTTPエンドポイントを使用できません。テスト用途では 許可.

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 キーは semver フォーマットでなければなりません。

zipファイルは index.html rootディレクトリのファイルとして、またはrootディレクトリに index.html 内に

You can use the command of the CLI to zip your bundle:

バンドルを生成するためのコマンドは__CAPGO_KEEP_0__で使用できます。

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 の応答にこの出力の値を含めてください。