メインコンテンツにジャンプする

How to Use Capgo Documentation for OTA Updates

Learn how to implement secure Over-the-Air updates in your Capacitor apps with Capgo's comprehensive documentation and step-by-step guidance.

How to Use Capgo Documentation for OTA Updates

より速い アプリケーションアップデート アプリストアの遅延なしで? Capgo __CAPGO_KEEP_0__は、ユーザーに即時で安全なオーバー・ザ・エア(OTA)アップデートを提供するオープンソースのプラットフォームです。アプリストアのレビューをスキップし、簡単にアプリを最新の状態に保つことができます。

Key Takeaways:

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

Capgo のドキュメント (capgo.app/docs)は、セットアップ、セキュリティ、トラブルシューティングのためのステップバイステップの指示を提供します。インストールから高度な構成まで、無問題の更新に役立つガイドです。

CapgoCapacitorJsライブアップデート用プラグイン

Capgo ライブアップデートダッシュボードインターフェイス

Capgoガイドの使用

OTA更新を扱う際に、ドキュメントを効果的にナビゲートすることは不可欠です。Capgoのドキュメントでは、リアルタイムの更新をCapacitorアプリに統合するための詳細なガイダンスが提供されています。

ドキュメントの場所

Capgoのドキュメントは以下の場所でご利用いただけます。 capgo.app/docs [1]ここでは、以下のセクションに分かれています。

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

重要な用語と概念

ここでは、重要な用語を紹介します。

  • チャンネルチャンネル [4].
  • これらは、バージョン配布を制御するために使用されるアップデートストリームです。たとえば、"production"、"beta"、"staging"などのチャンネルを設定して、異なるユーザーグループに適応させることができます。アップデートポリシー [1].
  • これらは、更新が配布され、適用される方法を定義します。オプションには、自動ダウンロード、インストールのタイミング、ユーザープロンプトなどがあります。アプリケーション状態リスナー [4].
  • これらは、アプリケーションが前景または背景にあるかを追跡するコンポーネントです。: Packaged update files containing your app’s new version, including assets, code changes, and configuration updates [4].

パッケージ化されたアップデートファイルで、アプリケーションの新しいバージョン、含むアセット、Codeの変更、構成の更新が含まれます。

ドキュメントでは、codeを使用して、統合を簡素化します。TypeScript/JavaScriptを使用した基本的な例を以下に示します。

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

// Initialize the updater
await CapacitorUpdater.notifyAppReady()

高度な使用例の場合、ドキュメントには実世界の例が含まれます。 [2][3]例として、次のものがあります。

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

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

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

OTAアップデートのセットアップ

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

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

Capgo をインストールするには、まず Capacitor プロジェクトにプラグインを追加してください:

npm install @capgo/capacitor-updater
npx cap sync

次に、 capacitor.config.json ファイルを更新してください。 Capgo API キーをファイルに追加してください。:

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

次に、

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

アプリのメインファイルでアップデートを検出するためにアップデータを初期化してください。

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

アップデートチャンネル設定 アップデートチャンネルを あなたの展開ニーズに合わせて

設定してください。 チャンネルタイプ 使用例
運用 安定版 一般ユーザー
テスト環境 プレリリース QAチームとベータテスター
ベータ 機能テスト 先行者

__CAPGO_KEEP_0__ __CAPGO_KEEP_1__ Capgo CLI:

npx @capgo/cli upload -c production

アップデート方法

Capgoは、以下の2つの主な方法でアップデートを取り扱います:

自動アップデート 自動アップデートを有効にするには、 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);
  }
}

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

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

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

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()を呼び出すと自動的に有効になります。
ロールバック保護 更新が失敗した場合に安定版に戻します。 更新プロセスに組み込まれています。
アクセス制御 ロールベースのパーミッションで更新を管理します。 ダッシュボードで設定します。

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

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

// 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
});

For phased rollouts, you can configure update distribution directly through the dashboard or with 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
  }
});

__CAPGO_KEEP_0__

// 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が有効であることを確認し、中断を処理するためのリトライ機構を追加してください。

  • バージョン間の競合 症状アップデートは、インストールに失敗したり、アプリのinstabilityを引き起こしたりします。 解決策アップデートのバージョン番号を明確に指定して、コンフリクトを回避し、安全性のためにロールバックオプションを実装してください。

  • インストールエラー 症状アップデートは失敗したり、自動ロールバックをトリガーしたりします。 解決策アップデート後に成功した後、を呼び出すことを確認して、ロールバックを防止してください。 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()
  });
});

By combining error logging with pre-checks, you can handle these issues effectively before focusing on compliance.

App Store Rules

アップデートはアプリストアのガイドラインに沿ったものでなければなりません。

Apple App Store Requirements:

  • ユーザーへの透明性: アップデートの内容を明確に伝え、ユーザーの同意を得る必要があります。
  • : アプリの主な機能は、レビューされた状態で維持される必要があります。: セキュアな方法でアップデートを送信する必要があります。
  • Android Implementationベストプラクティス

バージョン管理:

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

context: Page/area: Capgo marketing website. Role: Short UI label or navigation item. Message key `version_control` (バージョン管理):

  • context: Page/area: Capgo marketing website. Role: Short UI label or navigation item. Message key `version_control` (バージョン管理): OTAのアップデートを段階的に展開して、コンフリクトを減らします。
  • アップデート通知: ユーザーにわかりやすく明確なアップデートアラートを提供します。
  • セキュリティコンテキスト: Enterprise製品/価格ページ。役割: UIラベル。ページ: enterprise.astro。メッセージキー `enterprise_hero_security_label` (Enterprise Hero Security Label)。

: バンドルの完整性を検証し、データを暗号化して保護します。

概要

Capgo’s documentation provides clear instructions for integrating OTA updates into Capacitor apps while staying compliant with app store regulations.

Capgoのドキュメントは、__CAPGO_KEEP_1__アプリにOTAアップデートを統合するための明確な指示を提供し、アプリストア規制に準拠しています。 __CAPGO_KEEP_0__のリソースを使用して、開発者は次のような重要な機能を実装できます。 端末間暗号化 と、, から初期設定まで高度な構成までカバーしています。 [1].

重要な実装エリア

側面 主な焦点 どこで見つけるか
セキュリティ コンテキスト: Enterprise製品/価格設定ページ。役割: UIラベル。ページ: enterprise.astro。 暗号化と完整性のチェック セキュリティ機能
セクション 法的合致 AppleとAndroidの要件を満たす方法 ガイド
アップデート管理 バージョン管理とロールバックオプション アップデート方法 ガイド
エラー処理 ログとトラブルシューティングのステップ 問題解決ガイド

Capgoのアップデート管理システムの骨格となるのは、これらの領域です。

CapgoのCLIと分析ツールは、アプリのライフサイクル全体を通してアップデートを管理することを簡素化します。 Capgoのドキュメントを使用してOTAアップデートを実行する方法 エラー処理 [1].

サポートのために、追加のリソースを調べることができます。 API ドキュメント, サンプル プロジェクト、そして コミュニティ フォーラム [2].

「Capgo ドキュメント」を使用してOTAアップデートの方法を続けます。

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

Live updates for Capacitor apps

When a web-layer bug is live, ship the fix through Capgo instead of waiting days for app store approval. Users get the update in the background while native changes stay in the normal review path.

マーティンから人間のサポート

今すぐ始めましょう

最新のブログ

Capgo gives you the best insights you need to create a truly professional mobile app.