Cara Menggunakan Capgo Dokumentasi untuk Pembaruan OTA

Butuh pembaruan aplikasi yang lebih cepat Pembaruan Aplikasi tanpa penundaan toko aplikasi? Capgo mengizinkan Anda mengirimkan pembaruan Over-the-Air (OTA) yang aman secara instan kepada pengguna Anda. Lebihkan ulasan toko aplikasi dan pastikan aplikasi Anda tetap terupdate dengan mudah.

Poin Utama:

• Apa itu Capgo? Platform terbuka untuk pembaruan hidup di Capacitor aplikasi.
• Mengapa Pembaruan OTA? Simpan waktu, perbaiki pengalaman pengguna, dan perbaiki bug dengan cepat.
• Cara Mulai?
  • Pasang Capgo plugin: npm install @capgo/capacitor-updater
  • Konfigurasi aplikasi Anda dengan kunci API.
  • Gunakan saluran seperti “produksi” atau “beta” untuk peluncuran yang sasaran.
• Fitur Lanjutan: Enkripsi akhir ke akhir, pengelolaan kesalahan, dan integrasi CI/CD.

Capgo’s dokumentasi (capgo.app/docs) menyediakan instruksi langkah demi langkah untuk pengaturan, keamanan, dan troubleshooting. Dari instalasi hingga pengaturan yang canggih, itu adalah panduan Anda untuk pembaruan yang lancar.

Capgo, Plugin Live Update CapacitorJs untuk pembaruan langsung

Menggunakan Capgo Dokumentasi

Mengembara di dokumentasi dengan efektif sangat penting ketika bekerja dengan OTA updates. Dokumentasi Capgo menawarkan panduan yang rinci untuk mengintegrasikan pembaruan hidup ke dalam aplikasi Capacitor.

Di Mana Anda Bisa Menemukan Dokumentasi

Anda bisa mengakses dokumentasi Capgo di capgo.app/docs [1]. Dokumentasi ini diatur berdasarkan tujuan tertentu:

Kata-kata kunci dan istilah penting

Berikut beberapa istilah utama yang akan Anda temui:

• Saluran: Ini adalah aliran pembaruan yang digunakan untuk mengontrol distribusi versi. Misalnya, Anda mungkin mengatur "produksi", "beta", dan "staging" saluran untuk menangani kelompok pengguna yang berbeda [4].
• Kebijakan Pembaruan: Ini menentukan bagaimana pembaruan disampaikan dan diterapkan. Pilihan termasuk download otomatis, waktu instalasi, dan tanda-tanda pengguna [1].
• Pengamat Status Aplikasi: Komponen ini mengikuti apakah aplikasi berada di latar depan atau latar belakang [4].
• Bundel: File pembaruan yang dikemas yang berisi versi aplikasi baru, termasuk aset, code perubahan, dan update konfigurasi [4].

Code Contoh dan Tutorial

Dokumentasi menyediakan contoh code untuk memudahkan integrasi.

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

// Initialize the updater
await CapacitorUpdater.notifyAppReady()

Berikut adalah contoh dasar menggunakan TypeScript/JavaScript: [2][3]Untuk kasus penggunaan yang lebih maju, dokumentasi mencakup contoh nyata dunia nyata

• seperti:
• Mengganti saluran untuk tes A/B
• Fluktuasi pembaruan kustom dengan permintaan pengguna
• Mengatasi kesalahan dan menerapkan rollback

Mengintegrasikan pembaruan dengan aliran CI/CD [1].

Setiap tutorial juga menyoroti aspek kinerja dan keamanan, membantu Anda membuat keputusan yang tepat.

Dokumentasi sering diperbarui untuk mencakup fitur terbaru dan praktik terbaik

Set up OTA updates in Capgo to streamline your deployment process. Follow these steps and tips for a hassle-free configuration.

Mengatur Pembaruan OTA secara Otomatis

Mulai dengan menginstal plugin Capgo di proyek Capacitor Anda:

npm install @capgo/capacitor-updater
npx cap sync

Kemudian, update file Anda dengan kunci __CAPGO_KEEP_0__ __CAPGO_KEEP_1__ Anda: capacitor.config.json Lalu, inisialisasi pembarui di file utama aplikasi Anda untuk mendeteksi pembaruan: Capgo API key:

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

Pengaturan Saluran Pembaruan

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

Organisir saluran pembaruan Anda untuk memenuhi kebutuhan pengiriman Anda:

Tipe Saluran

Tujuan Saluran Pembaruan Jenis Saluran

__CAPGO_KEEP_0__ __CAPGO_KEEP_1__ Capgo CLI:

npx @capgo/cli upload -c production

Metode Perbarui

Capgo menyediakan dua cara utama untuk mengelola perbarui:

Perbarui Otomatis Aktifkan perbarui otomatis dengan mengatur autoUpdate: true di konfigurasi Anda. Hal ini memastikan perbarui diterapkan di latar belakang dengan tidak ada upaya tambahan dari pengembang.

Perbarui Manual Untuk kontrol yang lebih baik, Anda dapat mengelola perbarui secara manual. Gunakan pola berikut untuk memeriksa dan menerapkan perbarui:

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

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

Untuk perbarui kritis, Anda dapat meminta pengguna sebelum melanjutkan:

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

Anda juga dapat menargetkan kelompok pengguna tertentu dengan ID dan saluran yang disesuaikan:

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

Terakhir, pastikan untuk mencakup pengelolaan kesalahan dan opsi rollback:

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

Dengan langkah-langkah ini, sistem perbarui OTA Anda sudah siap digunakan. Eksplorasi pengaturan lanjutan untuk mengcustomisasi proses perbarui lebih lanjut.

sbb-itb-f9944d2

Pengaturan Lanjutan

Perbaiki pengaturan Anda dengan menambahkan pengamanan dan konfigurasi pembaruan yang fleksibel. Opsi-opsi ini memastikan pengalaman pembaruan yang aman dan lancar sambil memenuhi pedoman toko aplikasi. Capgo Pembaruan OTA Pengaturan dengan pengamanan tambahan dan konfigurasi pembaruan yang fleksibel untuk memastikan pengalaman pembaruan yang aman dan lancar.

Fitur Keamanan

Capgo menyediakan protokol keamanan yang kuat untuk melindungi bundle pembaruan Anda dan mengirimkannya secara aman kepada pengguna. Platform ini menggunakan enkripsi akhir-ke-akhir dengan kriptografi kunci publik untuk semua pembaruan [1]Berikut adalah cara mengaktifkan fitur keamanan utama:

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

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

Komponen utama dari sistem perlindungan bundle meliputi:

Pengaturan perilaku update

Anda dapat menyesuaikan cara update diinstal dan diaktifkan dengan menggunakan pemangku jawab dan opsi pengaturan. Sesuaikan waktu dan interaksi pengguna untuk update dengan pengaturan ini:

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

Untuk peluncuran berfasa, Anda dapat mengonfigurasi distribusi update secara langsung melalui dashboard atau dengan 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
  }
});

Untuk mengatasi perilaku versi tertentu:

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

Pengaturan ini memastikan pembaruan dapat diandalkan sambil memungkinkan Anda menyesuaikan proses dengan kebutuhan aplikasi Anda. Selalu tes pembaruan secara menyeluruh di lingkungan pengujian Capgo sebelum mengimplementasikannya ke produksi [2].

Petunjuk Penyelesaian Masalah

Capgo’s log kesalahan dan alat bawaan membantu menangani tantangan pembaruan OTA sambil memastikan aplikasi Anda sesuai dengan persyaratan toko.

Masalah Umum dan Solusi

Berikut beberapa masalah umum dan cara menanganinya:

• Pembaruan Gagal Gejala: Pembaruan mengalami kegagalan atau beku. Solusi: Periksa koneksi jaringan, pastikan URL pembaruan valid, dan tambahkan mekanisme ulang untuk mengatasi gangguan.

• Konflik Versi Gejala: Perbarui gagal terpasang atau menyebabkan ketidakstabilan aplikasi. Solusi: Gunakan nomor versi yang jelas untuk menghindari konflik dan implementasikan opsi rollback untuk keselamatan.

• Masalah Pemasangan Gejala: Perbarui gagal atau memicu rollbacks otomatis. Solusi: Pastikan Anda memanggil notifyAppReady() setelah perbarui sukses untuk mencegah rollbacks.

Untuk perbarui yang lebih besar dari 50MB, membaginya menjadi file yang lebih kecil dapat meningkatkan kinerja pada perangkat Android. [5].

Gunakan log kesalahan yang rinci untuk menangkap masalah-masalah sejak awal. Misalnya, implementasikan listener ini:

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

Dengan menggabungkan log kesalahan dengan pre-checks, Anda dapat menangani masalah-masalah ini secara efektif sebelum fokus pada kinerja.

Aturan App Store

Perubahan tidak hanya perlu dilakukan secara teknis - Anda juga perlu memastikan bahwa perubahan tersebut sesuai dengan pedoman app store.

Persyaratan App Store Apple:

• Transparansi Pengguna: Jelaskan dengan jelas kepada pengguna tentang isi perubahan dan dapatkan persetujuan mereka.
• Fungsi Utama: Pastikan fitur utama aplikasi Anda tetap utuh seperti yang telah diverifikasi.
• Tindakan Keamanan: Gunakan metode yang aman untuk mengirimkan perubahan.

Implementasi Android:

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

Praktik Terbaik:

• Pengendalian Versi: Rilis pembaruan secara bertahap untuk mengurangi konflik.
• Pemberitahuan Perbarui: Berikan pemberitahuan pembaruan yang jelas dan ramah pengguna.
• Keamanan: Verifikasi integritas bundle dan gunakan enkripsi untuk melindungi data.

Ringkasan

Bagian ini menyatukan ide-ide utama dari panduan ini.

Capgo’s dokumentasi menyediakan instruksi yang jelas untuk mengintegrasi pembaruan OTA ke dalam Capacitor aplikasi sambil tetap memenuhi regulasi toko aplikasi.

Dengan menggunakan sumber daya Capgo , pengembang dapat menerapkan fitur penting seperti enkripsi akhir-ke-akhir dan integrasi CI/CDMeliputi segala hal dari pengaturan awal hingga konfigurasi lanjutan [1].

Area-Implementasi Utama

Bidang-bidang ini membentuk tulang punggung sistem pengelolaan update Capgo.

Capgo’s CLI dan alat analitis memudahkan mengelola update selama siklus hidup aplikasi Anda [1].

Untuk dukungan lebih lanjut, Anda dapat menjelajahi sumber daya tambahan seperti API dokumentasi, projek contoh, dan forum komunitas [2].