Come usare la documentazione Capgo per gli aggiornamenti OTA

Vuoi aggiornamenti app più veloci senza i ritardi degli store? Capgo ti permette di inviare istantaneamente aggiornamenti Over-the-Air (OTA) sicuri ai tuoi utenti. Salta le revisioni degli store e tieni la tua app sempre aggiornata con facilità.

Punti chiave:

• Cos'è Capgo? Una piattaforma open-source per i live updates in Capacitor app.
• Perché usare gli OTA Updates? Risparmia tempo, migliora l'UX e correggi i bug velocemente.
• Come iniziare?
  • Installa il plugin Capgo: npm install @capgo/capacitor-updater
  • Configura la tua app con una chiave API.
  • Usa i canali come “production” o “beta” per rollout mirati.
• Funzionalità avanzate: Crittografia end-to-end, gestione degli errori e integrazione CI/CD.

La documentazione di Capgo (capgo.app/docs) offre istruzioni passo dopo passo per setup, sicurezza e troubleshooting. Dall'installazione alle configurazioni avanzate, è la tua guida per aggiornamenti senza intoppi.

Capgo, plugin CapacitorJs per Live update

Come usare la documentazione di Capgo

Navigare bene nella documentazione è essenziale quando si lavora con gli aggiornamenti OTA. La documentazione di Capgo offre guide dettagliate per integrare i Live Update nelle app Capacitor.

Dove trovare la documentazione

Puoi accedere alla documentazione di Capgo su capgo.app/docs [1]. È organizzata in sezioni in base all'uso:

Termini e concetti chiave

Ecco alcuni dei termini principali che incontrerai:

• Canali: Sono stream di aggiornamento usati per gestire la distribuzione delle versioni. Ad esempio, puoi creare i canali “production”, “beta” e “staging” per diversi gruppi di utenti [4].
• Politiche di Update: Definiscono come vengono erogati e applicati gli aggiornamenti. Le opzioni includono il download automatico, la tempistica di installazione e i prompt per l'utente. [1].
• Listener dello stato dell'app: Questi componenti monitorano se l'app è in foreground o in background [4].
• Bundle: File di aggiornamento pacchettizzati con la nuova versione della tua app, inclusi asset, modifiche al code e aggiornamenti di configurazione [4].

Esempi e Tutorial Code

La documentazione fornisce campioni di code per semplificare l'integrazione. Ecco un esempio base in TypeScript/JavaScript:

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

// Initialize the updater
await CapacitorUpdater.notifyAppReady()

Per casi d'uso più avanzati, la documentazione include esempi reali [2][3], come ad esempio:

• Cambio di canale per A/B testing
• Custom update flows with user prompts
• Gestione degli errori e implementazione dei rollback
• Integrazione degli aggiornamenti nelle pipeline CI/CD

Ogni tutorial evidenzia anche aspetti di sicurezza e performance, aiutandoti a prendere decisioni consapevoli. La documentazione viene aggiornata spesso con le ultime feature e best practice. [1].

Per i dettagli sull'implementazione, consulta la guida alla configurazione.

Configurazione degli OTA Updates

Configura gli OTA updates in Capgo per ottimizzare il tuo processo di deployment. Segui questi passaggi e consigli per una configurazione senza intoppi.

Passaggi base per la configurazione

Inizia installando il plugin Capgo nel tuo progetto Capacitor:

npm install @capgo/capacitor-updater
npx cap sync

Successivamente, aggiorna il tuo capacitor.config.json file con il tuo chiave Capgo API:

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

Poi, inizializza l'updater nel file principale della tua app per rilevare gli aggiornamenti:

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

Una volta fatto, puoi configurare i canali per gestire diversi flussi di aggiornamento.

Setup canali di aggiornamento

Organizza i tuoi canali di aggiornamento in base alle tue esigenze di deployment:

Per caricare un update su un canale specifico, usa Capgo CLI:

npx @capgo/cli upload -c production

Metodi di Update

Capgo offre due modi principali per gestire gli update:

Update Automatici Abilita gli update automatici impostando autoUpdate: true nella tua configurazione. Questo assicura che gli aggiornamenti vengano applicati in background senza sforzi extra per gli sviluppatori.

Aggiornamenti manuali Per un controllo maggiore, puoi gestire gli aggiornamenti manualmente. Usa questo pattern per controllare e applicare gli update:

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

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

Per gli aggiornamenti critici, puoi mostrare un prompt agli utenti prima di procedere:

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

Puoi anche mirare a gruppi di utenti specifici tramite ID e canali personalizzati:

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

Infine, assicurati di includere la gestione degli errori e le opzioni di rollback:

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

Con questi passaggi, il tuo sistema di aggiornamento OTA è pronto. Esplora le impostazioni avanzate per personalizzare ulteriormente il processo.

sbb-itb-f9944d2

Impostazioni avanzate

Migliora il tuo Aggiornamento OTA con Capgo setup con misure di sicurezza aggiuntive e configurazioni di update flessibili. Queste opzioni garantiscono un'esperienza di aggiornamento sicura e fluida, rispettando le linee guida degli app store.

Funzionalità di sicurezza

Capgo offre protocolli di sicurezza avanzati per proteggere i tuoi bundle di aggiornamento e consegnarli in modo sicuro agli utenti. La piattaforma utilizza la crittografia end-to-end con crittografia a chiave pubblica per tutti gli aggiornamenti [1]. Ecco come abilitare le principali funzioni di sicurezza:

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

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

I componenti chiave del sistema di protezione dei bundle includono:

Impostazioni del comportamento degli update

Puoi personalizzare la consegna e l'installazione degli update tramite event listener e opzioni di configurazione. Regola i tempi e l'interazione dell'utente con queste impostazioni:

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

Per i rollout graduali, puoi configurare la distribuzione degli update direttamente dalla dashboard o con 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
  }
});

Per gestire comportamenti specifici legati alla versione:

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

Queste impostazioni garantiscono update affidabili, permettendoti di adattare il processo alle esigenze della tua app. Testa sempre gli update nell'ambiente di staging di Capgo prima del rilascio in produzione [2].

Guida al troubleshooting

Gli error logs e gli strumenti integrati di Capgo aiutano a risolvere i problemi degli update OTA, mantenendo l'app conforme ai requisiti degli store.

Problemi comuni e soluzioni

Ecco alcuni problemi comuni e come risolverli:

• Download falliti Sintomi: I download si bloccano o non vengono completati. Soluzione: Controlla la connessione, verifica l'URL dell'update e aggiungi meccanismi di retry per gestire le interruzioni.

• Conflitti di versione Sintomi: Gli update non si installano o causano instabilità nell'app. Soluzione: Usa numeri di versione chiari per evitare conflitti e implementa opzioni di rollback per sicurezza.

• Errori di installazione Sintomi: Gli aggiornamenti falliscono o attivano rollback automatici. Soluzione: Assicurati di chiamare notifyAppReady() dopo un aggiornamento riuscito per evitare rollback.

Per aggiornamenti superiori a 50MB, dividerli in file più piccoli può migliorare le performance sui dispositivi Android [5].

Usa un logging dettagliato degli errori per individuare i problemi in anticipo. Ad esempio, implementa questo listener:

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

Combinando il logging degli errori con dei pre-check, puoi gestire questi problemi efficacemente prima di concentrarti sulla compliance.

Regole App Store

Le sole correzioni tecniche non bastano: i tuoi aggiornamenti devono anche rispettare le linee guida degli store.

Requisiti Apple App Store:

• Trasparenza per l'utente: Informa chiaramente gli utenti sul contenuto dell'update e ottieni il loro consenso.
• Funzionalità Core: Ensure your app’s main features remain intact as reviewed.
• Misure di SicurezzaUsa metodi sicuri per la trasmissione degli update.

Implementazione Android:

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

Best practice:

• Controllo di versioneRilascia gli update gradualmente per ridurre i conflitti.
• Notifiche di UpdateFornisci alert di update chiari e user-friendly.
• Sicurezza: Verifica l'integrità del bundle e usa la crittografia per proteggere i dati.

Riassunto

Questa sezione riassume i concetti principali della guida.

La documentazione di Capgo offre istruzioni chiare per integrare gli aggiornamenti OTA nelle app Capacitor, rispettando le regole degli app store.

Utilizzando le risorse di Capgo, gli sviluppatori possono implementare funzionalità essenziali come crittografia end-to-end e Integrazione CI/CD, coprendo tutto, dal setup iniziale alle configurazioni avanzate [1].

Aree chiave di implementazione

Queste aree costituiscono il cuore del sistema di gestione degli update di Capgo.

Gli strumenti di CLI e analytics di Capgo semplificano la gestione degli update durante l'intero ciclo di vita della tua app [1].

Per ulteriore supporto, puoi consultare risorse come la documentazione di API, progetti di esempio, e forum della community [2].

Continua da Come usare la documentazione Capgo per gli OTA Updates

Se stai usando Come usare la documentazione Capgo per gli OTA Updates per pianificare sicurezza e compliance, collegalo a Crittografia per i dettagli di implementazione in Encryption, Conformità per i dettagli di implementazione in Compliance, Scanner di sicurezza Capgo per il workflow di Capgo Security Scanner, Sicurezza Capgo per il workflow di Capgo Security, e Trust Center di Capgo per il workflow di Capgo Trust Center.