Lompat ke konten utama

Cara Menggunakan Capgo Dokumentasi untuk Pembaruan OTA

Pelajari cara mengimplementasikan pembaruan Over-the-Air yang aman di aplikasi Capacitor Anda dengan dokumentasi dan panduan langkah demi langkah yang komprehensif dari Capgo.

Martin Donadieu

Martin Donadieu

Spesialis Konten

Cara Menggunakan Dokumentasi Capgo untuk Pembaruan OTA

Butuh pembaruan aplikasi yang lebih cepat tanpa penundaan dari toko aplikasi? __CAPGO_KEEP_0__ Capgo Poin Utama:

Apa itu __CAPGO_KEEP_0__?

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

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

Capgo, plugin CapacitorJs untuk pembaruan hidup

Capgo Dashboard Pembaruan Hidup

Menggunakan Dokumentasi Capgo

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

Di Mana Menemukan Dokumentasi

Anda dapat mengakses dokumentasi Capgo di capgo.app/docs [1]. Ini terorganisir ke dalam bagian berdasarkan tujuan tertentu:

BagianTujuanTopik Utama
MulaiPengaturan AwalLangkah-langkah instalasi, API pengaturan kunci
KonfigurasiPengaturan UtamaKonfigurasi plugin, pengaturan lingkungan
API ReferensiDetail teknisMetode, parameter, nilai kembalian
KeamananLangkah-langkah perlindunganPengaturan enkripsi, verifikasi tanda tangan
PengembanganPengembanganMasalah umum, alat diagnostik

Kata-kata kunci dan konsep penting

Berikut beberapa istilah penting 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].
  • Pengaturan Perbarui: Pengaturan ini menentukan bagaimana perbarui diterima dan diterapkan. Pilihan termasuk download otomatis, waktu instalasi, dan prompt pengguna [1].
  • Pengawas Status Aplikasi: Komponen-komponen ini mengikuti apakah aplikasi berada di latar depan atau latar belakang [4].
  • Bundel: File-file perbarui yang dikemas berisi versi aplikasi baru, termasuk aset, code perubahan, dan update konfigurasi [4].

Code Contoh dan Panduan

Dokumentasi menyediakan contoh code untuk memudahkan integrasi. Berikut adalah contoh dasar menggunakan TypeScript/JavaScript:

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

// Initialize the updater
await CapacitorUpdater.notifyAppReady()

Untuk kasus penggunaan yang lebih maju, dokumentasi mencakup contoh nyata [2][3], seperti:

  • Mengganti saluran untuk tes A/B
  • Fluks perbarui yang disesuaikan dengan prompt pengguna
  • Mengatasi kesalahan dan menerapkan pengembalian
  • Mengintegrasikan pembaruan dengan alur kerja CI/CD

Setiap tutorial juga menyoroti pertimbangan kinerja dan aspek keamanan, membantu Anda membuat keputusan yang informasi. Dokumentasi sering diperbarui untuk mencakup fitur terbaru dan praktik terbaik [1].

Untuk detail implementasi, cek panduan pengaturan berikut.

Mengatur Pembaruan OTA

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

Langkah-Langkah Pengaturan Dasar

Start by installing the Capgo plugin in your Capacitor project:

npm install @capgo/capacitor-updater
npx cap sync

Kemudian, update file Anda dengan kunci 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"
    }
  }
}

Lalu, inisialisasi pembarui di file utama aplikasi Anda untuk mendeteksi pembaruan:

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

Setelah ini selesai, Anda dapat mengatur saluran untuk mengelola aliran pembaruan yang berbeda.

Pengaturan Saluran Pembaruan

Organisir saluran pembaruan Anda untuk memenuhi kebutuhan penggunaan pengembangan:

Jenis SaluranTujuanPenggunaan
ProduksiRilis stabilBasis pengguna umum
StagingPengujian pra-rilisTim QA dan tes tester beta
BetaPengujian fiturPengguna awal

Untuk mengunggah pembaruan ke saluran tertentu, gunakan Capgo CLI:

npx @capgo/cli upload -c production

Metode Pembaruan

Capgo menyediakan dua cara utama untuk menghandle pembaruan:

Pembaruan Otomatis Aktifkan pembaruan otomatis dengan mengatur autoUpdate: true di konfigurasi Anda. Ini memastikan pembaruan diterapkan di latar belakang dengan tidak ada upaya tambahan dari pengembang.

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

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

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

Untuk pembaruan 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 kustom:

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

Terakhir, pastikan untuk mencakup pengaturan 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 pembaruan OTA Anda sudah siap. Eksplorasi pengaturan lanjutan untuk mengcustomisasi proses pembaruan lebih lanjut.

sbb-itb-f9944d2

Pengaturan Lanjutan

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

Fitur Keamanan

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

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

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

Komponen kunci dari sistem perlindungan bundle meliputi:

Fitur KeamananDeskripsiImplementasi
Integritas BundleMengverifikasi keaslian paket dengan tanda tangan kriptografiDitambahkan secara otomatis dengan setVerifyBundles()
Pengembalian Ke Versi StabilMengembalikan ke versi stabil jika pembaruan gagalTersedia dalam proses pembaruan
Pengendalian AksesMenangani pembaruan dengan izin berdasarkan peranDikonfigurasi melalui dashboard

Pengaturan perilaku pembaruan

Kamu dapat menyesuaikan bagaimana pembaruan disampaikan dan diinstal dengan menggunakan pemangku jawab dan opsi pengaturan. Sesuaikan waktu dan interaksi pengguna untuk pembaruan 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 fase, kamu dapat mengonfigurasi distribusi pembaruan 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 menangani perilaku versi terkait 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 kamu menyesuaikan proses untuk kebutuhan aplikasi kamu. Selalu lakukan tes pembaruan secara menyeluruh di lingkungan pengujian Capgo sebelum mengeluarkannya ke produksi [2].

Panduan Pemecahan Masalah

Log kesalahan Capgo dan alat bawaan membantu menangani tantangan pembaruan OTA sambil memastikan aplikasi kamu sesuai dengan persyaratan toko.

Masalah Umum dan Solusinya

Berikut adalah beberapa masalah umum dan cara menanganinya:

  • Unduhan Gagal Gejala: Unduhan beku atau gagal untuk selesai. Solusi: Periksa koneksi jaringan Anda, pastikan URL pembaruan valid, dan tambahkan mekanisme ulang untuk mengatasi gangguan.

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

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

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

Gunakan logging 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 kombinasi logging kesalahan dan pemeriksaan sebelumnya, Anda dapat menangani masalah-masalah ini secara efektif sebelum memusatkan perhatian pada konsistensi.

Aturan Toko Aplikasi

Perbaikan teknis sendiri tidak cukup - perbarui Anda juga perlu sejalan dengan pedoman aplikasi toko.

Persyaratan Toko Aplikasi Apple:

  • Transparansi Pengguna: Jelaskan dengan jelas kepada pengguna tentang isi perbarui dan dapatkan persetujuan mereka.
  • Fungsi Utama: Pastikan fitur utama aplikasi tetap utuh seperti yang diharapkan.
  • Langkah Keamanan: Gunakan metode yang aman untuk mengirimkan update.

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 update secara bertahap untuk mengurangi konflik.
  • Pemberitahuan Perbarui: Berikan pemberitahuan perbarui 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.

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

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

Area-Area Implementasi Utama

AspekFokus UtamaDimana Anda Bisa Menemukannya
KeamananEnkripsi dan pengecekan integritasFitur Keamanan bagian
Kemampuan KompatibilitasMengikuti persyaratan Apple dan AndroidPedoman Store Aplikasi pedoman
Pengelolaan PerbaruiPengendalian versi dan opsi pengembalianMetode Perbarui pedoman
Pengelolaan KesalahanLangkah-langkah Pemecahan Masalah dan PemantauanBuku Panduan Pemecahan Masalah

Daerah-daerah ini membentuk tulang punggung sistem pengelolaan update Capgo.

Alat dan tools Capgo dan analitik CLI memudahkan Pengelolaan Update selama siklus hidup aplikasi Anda [1].

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

Pembaruan hidup untuk aplikasi Capacitor

Jika ada bug layer web yang hidup, kirimkan perbaikan melalui Capgo daripada menunggu hari-hari untuk persetujuan toko aplikasi. Pengguna mendapatkan pembaruan di latar belakang sementara perubahan native tetap dalam jalur ulasan normal.

Mulai Sekarang

Terbaru dari Blog Kami

Capgo memberikan Anda wawasan terbaik yang Anda butuhkan untuk membuat aplikasi mobile yang benar-benar profesional.