Getting Started

Pemasangan

Anda dapat menggunakan Setup yang Dibantu AI kami untuk menginstal plugin. Tambahkan Capgo kemampuan ke alat AI Anda menggunakan perintah berikut:

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Lalu gunakan prompt berikut:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-updater` plugin in my project.

Jika Anda lebih suka Setup Manual, instal plugin dengan menjalankan perintah-perintah berikut dan ikuti instruksi spesifik platform di bawah:

npm

bun add @capgo/capacitor-updater
bunx cap sync

yarn

yarn add @capgo/capacitor-updater
bunx cap sync

pnpm

pnpm add @capgo/capacitor-updater
bunx cap sync

bun

bun add @capgo/capacitor-updater
bunx cap sync

Mulai Cepat

Bagi pengguna kebanyakan, kami merekomendasikan mengikuti panduan Quickstart utama yang mencakup baik instalasi plugin dan Capgo integrasi cloud.

Panduan ini membantu pengguna memahami detail teknis plugin untuk pengguna lanjutan yang ingin memahami mekanisme dasar atau mengimplementasikan pembaruan self-hosted.

Ringkasan

Plugin Pembaruan Capacitor memungkinkan pembaruan perangkat keras (OTA) untuk aplikasi-aplikasi Capacitor Anda. Ini memungkinkan Anda untuk membarui aplikasi Anda tanpa harus melewati tinjauan toko aplikasi.

Cara Kerjanya

1. Unduh Paket: Plugin mengunduh paket pembaruan (file ZIP yang berisi aset web Anda)
2. Ekstraksi: Paket dipisahkan ke penyimpanan perangkat
3. Hot Reload: Aplikasi beralih ke paket baru tanpa memerlukan restart
4. Jatuh Kembali: Jika pembaruan gagal, aplikasi kembali ke versi yang berfungsi sebelumnya

Mode Penggunaan

1. Mode Pembaruan Otomatis (Dianjurkan)

Cara termudah untuk menggunakan plugin dengan manajemen pembaruan otomatis:

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

// Plugin handles everything automatically
// Configure in capacitor.config.ts

Tambahkan ke capacitor.config.ts:

{
  plugins: {
    CapacitorUpdater: {
      autoUpdate: 'atBackground',
      updateUrl: 'https://your-update-server.com/api/updates'
    }
  }
}

2. Mode Manual

Untuk kontrol yang lebih lanjut atas proses pembaruan:

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

// Download an update
const bundle = await CapacitorUpdater.download({
  url: 'https://your-server.com/updates/v1.0.1.zip',
  version: '1.0.1'
});

// Set the bundle (will be used on next app start)
await CapacitorUpdater.set({
  id: bundle.id
});

// Or reload immediately
await CapacitorUpdater.reload();

Konfigurasi Platform

iOS

Tidak diperlukan konfigurasi tambahan. Plugin ini berfungsi secara otomatis.

Android

Tidak diperlukan konfigurasi tambahan. Plugin ini berfungsi secara otomatis.

Penggunaan Dasar API

Unduh Perbaruan

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

const bundle = await CapacitorUpdater.download({
  url: 'https://example.com/update.zip',
  version: '1.0.1'
});

console.log('Downloaded bundle:', bundle.id);

Atur Paket Aktif

// Set bundle to be used on next app start
await CapacitorUpdater.set({
  id: bundle.id
});

Muat Ulang dengan Paket Baru

// Reload app immediately with new bundle
await CapacitorUpdater.reload();

Daftar Paket

const { bundles } = await CapacitorUpdater.list();
console.log('Available bundles:', bundles);

Hapus Paket

await CapacitorUpdater.delete({
  id: 'bundle-id'
});

Ambil Paket Saat Ini

const { bundle } = await CapacitorUpdater.current();
console.log('Current bundle:', bundle.version);

Pengguna Event

Tunggu peristiwa update:

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

// Listen for download progress
CapacitorUpdater.addListener('download', (info) => {
  console.log('Download progress:', info.percent);
});

// Listen for download completion
CapacitorUpdater.addListener('downloadComplete', (bundle) => {
  console.log('Download complete:', bundle.version);
});

// Listen for update failures
CapacitorUpdater.addListener('updateFailed', (error) => {
  console.error('Update failed:', error);
});

// Listen for successful updates
CapacitorUpdater.addListener('updateAvailable', (info) => {
  console.log('Update available:', info.version);
});

Opsi Konfigurasi

Konfigurasi plugin di dalam Anda capacitor.config.ts:

{
  plugins: {
    CapacitorUpdater: {
      // Auto-update settings
      autoUpdate: 'atBackground',
      updateUrl: 'https://api.example.com/updates',

      // Update behavior
      resetWhenUpdate: true,

      // Version settings
      version: '1.0.0',

      // Security
      allowModifyUrl: false,

      // Stats collection
      statsUrl: 'https://api.example.com/stats',

      // Channel (for Capgo cloud)
      defaultChannel: 'production'
    }
  }
}

Polanya Integrasi

Dengan Capgo Cloud

Cara termudah untuk memulai:

// Install the Capgo CLI
bun add -g @capgo/cli

// Login to Capgo
npx @capgo/cli login

// Upload your first bundle
npx @capgo/cli bundle upload

// The plugin auto-updates from Capgo cloud

Lihat panduan Quickstart utama untuk detailnya.

Pembaruan Diri Sendiri

Host your sendiri update server:

// Configure your update endpoint
{
  plugins: {
    CapacitorUpdater: {
      autoUpdate: 'atBackground',
      updateUrl: 'https://your-server.com/api/check-update'
    }
  }
}

Server Anda harus mengembalikan:

{
  "version": "1.0.1",
  "url": "https://your-server.com/updates/1.0.1.zip"
}

Lihat Mode Diri Sendiri untuk detail lengkap.

Alur Update Manual

Kontrol lengkap atas update:

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

async function checkAndUpdate() {
  // Check for updates from your server
  const response = await fetch('https://api.example.com/check-update');
  const { version, url } = await response.json();

  // Download the update
  const bundle = await CapacitorUpdater.download({
    url,
    version
  });

  // Notify bundle is ready
  await CapacitorUpdater.notifyAppReady();

  // Set as next version
  await CapacitorUpdater.set({ id: bundle.id });

  // Reload when ready
  await CapacitorUpdater.reload();
}

Praktik Terbaik

• Selalu panggil notifyAppReady() ketika aplikasi Anda berhasil dimuat
• Uji coba perbarui secara menyeluruh sebelum memasukkannya ke produksi
• Implementasikan penanganan kesalahan yang tepat untuk kegagalan jaringan
• Gunakan nomor versi secara konsisten
• Tetapkan ukuran bundle kecil untuk download yang lebih cepat
• Monitor tingkat keberhasilan perbarui

Langkah-Langkah Selanjutnya

• Referensi Plugin API - Dokumentasi lengkap API
• Pengaturan Plugin - Semua opsi pengaturan
• Event - Acara pembaruan tersedia
• Pengaturan Sendiri - Jalankan server pembaruan sendiri
• Pengembangan Lokal - Tes pembaruan secara lokal
• Pengembangan Debug - Panduan troubleshooting

Bantuan

• Masalah yang Dikenal - Masalah umum dan solusi
• GitHub Diskusi - Bantuan komunitas
• Discord - Percakapan waktu nyata

Teruskan dari Getting Started

Jika Anda menggunakan Getting Started untuk merencanakan pekerjaan plugin native, hubungkannya dengan Menggunakan @capgo/capacitor-pembaruan untuk kemampuan asli dengan menggunakan @capgo/capacitor-updater, Direktori Plugin Capgo untuk alur kerja produk di Direktori Plugin Capgo, Plugin-Plugin Capacitor oleh Capgo untuk detail implementasi di Plugin-Plugin Capacitor oleh Capgo, Menambahkan atau Mengupdate Plugin untuk detail implementasi di Menambahkan atau Mengupdate Plugin, dan Alternatif Plugin Enterprise Ionic untuk alur kerja produk di Alternatif Plugin Enterprise Ionic.