Capgoを使用する方法 - OTA更新のためのドキュメント

アプリの更新を速くアプリストアの遅延なしで __CAPGO_KEEP_0__ Capgo __CAPGO_KEEP_0__を使用すると、即時で安全なOver-the-Air (OTA)更新をユーザーに提供できます。アプリストアのレビューをスキップし、簡単にアプリを最新の状態に保つことができます。

Key Takeaways:

Capgoは何ですか? リアルタイムの更新を可能にするオープンソースプラットフォームです。 Capacitor アプリ
なぜOTA更新が必要ですか? 時間を節約し、ユーザー体験を向上させ、バグを迅速に修正することができます。
はじめからどうすればいいですか?
- __CAPGO_KEEP_0__ プラグインをインストールするアプリをCapgo キーで構成する。: npm install @capgo/capacitor-updater
- API
- ターゲットチャンネルとして「production」や「beta」を使用して、ターゲットされたロールアウトを実行します。
高度な機能: エンドツーエンドの暗号化、エラーハンドリング、CI/CD統合

Capgoのドキュメント（capgo.app/docs)は、セットアップ、セキュリティ、トラブルシューティングのためのステップバイステップの指示を提供します。インストールから高度な構成まで、更新がスムーズに実行されるように、ご自身のガイドとして活用してください。

Capgo, Live Update用のCapacitorJsプラグイン

Capgo Live Update ダッシュボードインターフェイス

Capgoドキュメントを使用する

ドキュメントを効果的にナビゲートすることは、OTA更新とともに作業する際に不可欠です。Capgoのドキュメントは、Capacitorアプリにライブ更新を統合するための詳細なガイダンスを提供します。

ドキュメントの場所

Capgoのドキュメントは capgo.app/docs [1]以下のセクションに分かれています。

セクション	目的	主なトピック
はじめに	初期設定	インストール手順 APIキー設定
設定	Core設定	プラグイン設定、環境設定
API リファレンス	技術詳細	メソッド、パラメータ、戻り値
セキュリティ	保護対策	暗号化設定、署名検証
トラブルシューティング	問題解決	一般的な問題、診断ツール

重要な用語と概念

以下の重要な用語をご覧ください：

チャンネル: この更新の流れはバージョンの配布を制御します。たとえば、「production」、「beta」、「staging」などのチャンネルを設定して、異なるユーザーグループに適応することができます [4].
更新ポリシー: このポリシーは、更新がどのように配布され、適用されるかを定義します。オプションには、自動ダウンロード、インストールのタイミング、ユーザーのプロンプトなどがあります [1].
アプリステートリスナー: このコンポーネントは、アプリが前景または背景にあるかを追跡します [4].
バンドル: アプリの新バージョンを含む、資産、code の変更、構成の更新などを含む、パッケージ化された更新ファイル [4].

Code の例とチュートリアル

ドキュメントでは、サンプル code を提供して、統合を簡素化します。ここでは、TypeScript/JavaScript を使用した基本的な例をご覧ください

import { CapacitorUpdater } from '@capgo/capacitor-updater'

// Initialize the updater
await CapacitorUpdater.notifyAppReady()

より高度な使用例については、ドキュメントには実際の例が含まれています [2][3]、例えば：

チャネル切り替えによるA/Bテスト
ユーザープロンプトを含むカスタムアップデートフロー
エラーの処理とロールバックの実装
CI/CD Pipelinesと統合されたアップデート

各チュートリアルでは、パフォーマンスの考慮とセキュリティの側面を強調し、情報に基づいた決定を下すことができます。ドキュメントは頻繁に更新され、最新の機能とベストプラクティスを含めています。 [1].

実装の詳細については、セットアップガイドを参照してください。

OTAアップデートの設定

CapgoでOTAアップデートを設定して、展開プロセスを簡素化します。次の手順とヒントに従って、無事な構成を実施してください。

基本的なセットアップ手順

最初に、CapacitorプロジェクトにCapgoプラグインをインストールしてください。

npm install @capgo/capacitor-updater
npx cap sync

次に、 capacitor.config.json __CAPGO_KEEP_0__ __CAPGO_KEEP_1__ キーを含むファイル Capgo API:

{
  "plugins": {
    "CapacitorUpdater": {
      "autoUpdate": true,
      "apiKey": "YOUR_API_KEY_HERE"
    }
  }
}

アプリの主ファイルにアップデート検出用のアップデートアップデーターを初期化してください:

import { CapacitorUpdater } from '@capgo/capacitor-updater';
await CapacitorUpdater.notifyAppReady();

この手順が完了したら、異なるアップデートストリームを管理するためのチャンネルを設定できます。

アップデートチャンネル設定

展開に適したアップデートチャンネルを整理してください:

チャンネルタイプ	目的	使用例
本番環境	安定版のリリース	一般ユーザーのベース
ステージング	プレリリーステスト	QAチームとベータテスター
ベータ	機能テスト	早期採用者

特定のチャンネルにアップデートをアップロードするには、 Capgo CLI:

npx @capgo/cli upload -c production

アップデート方法

Capgoは、2つの主な方法でアップデートを処理します:

自動更新 __CAPGO_KEEP_0__で自動更新を有効にすることで、 autoUpdate: true 設定ファイル内で

自動更新 より多くの制御が必要な場合は、

// Check for updates
const update = await CapacitorUpdater.download();

// Install when ready
if (update) {
  await CapacitorUpdater.set(update);
}

以下のパターンを使用して更新を確認して適用することができます。

if (update.version > currentVersion) {
  const userConsent = await showUpdatePrompt();
  if (userConsent) {
    await CapacitorUpdater.set(update);
  }
}

重要な更新の場合、ユーザーに確認を求めることができます。

await CapacitorUpdater.setCustomId('beta-tester-123');
await CapacitorUpdater.setChannel('beta');

カスタムIDとチャンネルを使用して特定のユーザーグループをターゲットにすることもできます。

try {
  await CapacitorUpdater.set(update);
} catch (error) {
  await CapacitorUpdater.reset(); // Revert to the last working version
  console.error('Update failed:', error);
}

最後に、エラー処理とロールバックオプションを含めるようにしてください。

これらの手順を実行することで、OTA更新システムは準備が整いました。さらにカスタマイズするために、詳細設定を探索してください。

sbb-itb-f9944d2

詳細設定 Capgo OTA更新セキュリティ機能と柔軟な更新設定を備えたセットアップ。これらのオプションは、安全でスムーズな更新体験を提供し、アプリストアのガイドラインに準拠します。

セキュリティ機能

Capgoは、更新パッケージを保護し、ユーザーに安全に配信するために使用される強力なセキュリティプロトコルを提供します。プラットフォームは、すべての更新にエンドツーヘンド暗号化と公開鍵暗号化を使用します。 [1]以下に、キーセキュリティ機能を有効にする方法を示します。

// Enable bundle verification
await CapacitorUpdater.setVerifyBundles(true);

// Configure encryption settings
await CapacitorUpdater.configure({
  encryption: {
    enabled: true,
    failOnError: true
  }
});

バンドル保護システムのキーコンポーネントは次のとおりです。

セキュリティ機能	説明	実装
バンドルインテグリティ	パッケージの有効性を暗号署名で検証します。	setVerifyBundles()で自動的に有効になります。
ロールバック保護	更新が失敗した場合に安定したバージョンに戻る	更新プロセスに組み込まれています
アクセス制御	ロールベースのパーミッションで更新を管理	ダッシュボードで設定

更新動作設定

更新の配布とインストール方法をカスタマイズするには、イベントリスナーと設定オプションを使用します。更新のタイミングとユーザーインタラクションを調整するには、これらの設定を使用してください。

// Listen for when an update is available
CapacitorUpdater.addListener('updateAvailable', async (info) => {
  if (info.version > currentVersion) {
    // Custom update logic based on app state
    const isAppInactive = await checkAppState();
    if (isAppInactive) {
      await CapacitorUpdater.download();
    }
  }
});

// Monitor download completion
CapacitorUpdater.addListener('downloadComplete', (info) => {
  console.log(`Update ${info.version} ready to install`);
  // Implement custom installation timing if desired
});

フェーズドロールアウトの場合、ダッシュボードまたはcodeで直接更新の配布を設定できます。

// Set custom update conditions for a gradual rollout
await CapacitorUpdater.configure({
  rollout: {
    percentage: 25, // Start with 25% of users
    timeInterval: 24 // Increase rollout percentage every 24 hours
  }
});

特定のバージョンに関する動作を管理するには

// Handle version-specific update failures
CapacitorUpdater.addListener('updateFailed', async (info) => {
  if (info.error.code === 'VERSION_MISMATCH') {
    await CapacitorUpdater.reset(); // Revert to the last stable version
    // Optionally, handle error notification here
  }
});

これらの設定により、更新が信頼性がありながら、またアプリのニーズに合わせてプロセスをカスタマイズすることができます。Capgoのステージング環境で更新を徹底的にテストすることをお勧めします。 [2].

問題解決ガイド

Capgoのエラーログと組み込みツールは、OTA更新の課題を解決しながら、アプリがストアの要件に準拠していることを保証します。

一般的な問題と解決策

以下は、一般的な問題とその対処方法です:

ダウンロードの失敗 症状: ダウンロードが停止したり、完了しない場合。 対処法: ネットワーク接続を確認し、更新URLが有効であることを確認し、中断を処理するためのリトライ機構を追加してください。
バージョン間の不一致 症状: 更新がインストールできず、またはアプリの安定性が損なわれる場合。 対処法: __CAPGO_KEEP_0__を明確に指定して、安全性のためにロールバックオプションを実装する。
インストールエラー 症状: 更新が失敗したり、自動ロールバックをトリガーしたりする。 解決策: __CAPGO_KEEP_0__を成功した更新後に呼び出すことを確認して、ロールバックを防止する。 notifyAppReady() Android デバイスでパフォーマンスを向上させるために、50MBを超える更新を小さなファイルに分割することができます。

詳細なエラーロギングを使用して、問題を早期に捕捉する。たとえば、次のリスナーを実装する。 [5].

エラーロギングと事前チェックを組み合わせると、コンプライアンスに焦点を当てる前に、これらの問題を効果的に処理できます。

CapacitorUpdater.addListener('updateFailed', (error) => {
  console.log(`Update failed: ${error.code}`);
  logUpdateError({
    errorCode: error.code,
    deviceInfo: error.device,
    timestamp: new Date().toISOString()
  });
});

App Store の規則

技術的な修正だけでは十分ではない - アプリの更新もアプリストアのガイドラインに沿ったものでなければなりません。

__CAPGO_KEEP_0__

Apple App Store 要求:

ユーザー透明性: アップデートの内容を明確にユーザーに伝え、同意を得る。
コア機能: レビューされたアプリの主な機能を維持する。
セキュリティ対策: 安全な方法でアップデートを送信する。

Android実装:

await CapacitorUpdater.configure({
  updateNotification: {
    title: "Update Available",
    message: "A new version is available. Please update to access the latest features.",
    requireUserConsent: true
  }
});

ベストプラクティス:

バージョン管理: アップデートを段階的にリリースして、コンフリクトを減らす。
アップデート通知: __CAPGO_KEEP_0__の最新情報を明確かつユーザーフレンドリーなアラートで提供します。
セキュリティ: バンドルの完全性を検証し、データ保護のために暗号化を使用します。

概要

このセクションでは、ガイドの主要なアイデアをまとめています。

Capgoのドキュメントでは、CapacitorアプリにOTA更新を統合する方法について、明確な指示を提供しています。アプリストア規制に準拠しながら、

Capgoのリソースを使用することで、開発者はエンドツーヘンド暗号化と CI/CD統合 などの基本的な機能を実装できます。初期設定から高度な設定まで、すべてのステップをカバーします。主な実装エリア [1].

end-to-end encryption

アスペクト	主な焦点	どこで見つけるか
セキュリティ	暗号化と整合性のチェック	セキュリティ機能セクション
法的合致	AppleとAndroidの要件を満たす	App Storeの規則ガイド
更新管理	バージョン管理とロールバック機能	更新方法ガイド
エラー処理	ログとトラブルシューティングの手順	問題解決ガイド

これらの領域は、Capgoの更新管理システムの骨格を形成しています。

CapgoのCLIと分析ツールは、アプリのライフサイクル全体を通しての更新の管理を簡素化します。 [1].

追加のリソースとして、 APIのドキュメントを参照してください。, サンプルプロジェクト, および コミュニティフォーラム [2].

Capgo の使用方法ドキュメントの OTA アップデートから続けてください

Capacitor を使用している場合 Capgo の使用方法ドキュメントの OTA アップデートから続けてください セキュリティとコンプライアンスの計画に使用するには、Cloudflare などと接続してください暗号化暗号化の実装詳細については、コンプライアンスコンプライアンスの実装詳細については、 Capgo セキュリティスキャナー Capgo セキュリティスキャナーにおける製品ワークフローについては、 Capgo セキュリティ Capgo セキュリティにおける製品ワークフローについては、 Capgo トラストセンター Capgo トラストセンターにおける製品ワークフローについては、

Capgoの使用方法