Comment utiliser la documentation de Capgo pour les mises à jour OTA

Besoin de mises à jour d'applications plus rapides sans les retards des magasins d'applications? __CAPGO_KEEP_0__ Capgo vous permet de livrer des mises à jour sécurisées Over-the-Air (OTA) instantanément à vos utilisateurs. Sauter les examens de l'App Store et maintenez votre application à jour avec facilité.

Rappels clés :

• Qu'est-ce que Capgo ? Une plateforme open-source pour les mises à jour en temps réel dans les Capacitor applications.
• Pourquoi les mises à jour OTA ? Épargnez du temps, améliorez l'expérience utilisateur et réparez les bogues rapidement.
• Comment se lancer ?
  • Installez le Capgo plugin: npm install @capgo/capacitor-updater
  • Configurez votre application avec une clé API.
  • Utilisez des canaux comme « production » ou « beta » pour des déploiements ciblés.
• Fonctionnalités avancées : La cryptage de bout en bout, la gestion des erreurs et l'intégration CI/CD.

Capgo’s documentation (capgo.app/docs) fournit des instructions étape par étape pour la configuration, la sécurité et le dépannage. De l'installation aux configurations avancées, c'est votre guide incontournable pour des mises à jour sans heurt.

Capgo, plugin CapacitorJs pour Live update

En utilisant Capgo Documentation

La navigation de la documentation est essentielle lors du travail avec les mises à jour OTA. Capgo’s documentation offre une guidance détaillée pour l'intégration des mises à jour en direct dans les applications Capacitor.

Où trouver la documentation

Vous pouvez accéder à la documentation de Capgo à capgo.app/docs [1]Elle est organisée en sections en fonction de finalités spécifiques :

Termes et concepts importants

Voici quelques termes clés que vous rencontrerez :

• Canaux : Ces flux d'informations sont utilisés pour contrôler la distribution des versions. Par exemple, vous pouvez configurer des canaux « production », « bêta » et « étape de développement » pour répondre aux besoins de différents groupes d'utilisateurs [4].
• Politiques d'actualisation : Ces définitions déterminent comment les mises à jour sont livrées et appliquées. Les options incluent les téléchargements automatiques, la programmation de l'installation et les invitations de l'utilisateur [1].
• Écouteurs d'état d'application : Ces composants suivent si l'application est en avant-plan ou en arrière-plan [4].
• Paquets : Les fichiers d'actualisation emballés contenant la nouvelle version de votre application, y compris les actifs, les modifications code et les mises à jour de configuration [4].

Exemples et tutoriels Code

La documentation fournit des exemples code pour simplifier l'intégration. Voici un exemple de base utilisant TypeScript/JavaScript :

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

// Initialize the updater
await CapacitorUpdater.notifyAppReady()

Pour des cas d'utilisation plus avancés, la documentation inclut des exemples concrets de la vie réelle [2][3], tel que :

• Passer entre les canaux pour les tests A/B
• Flux de mise à jour personnalisés avec des invitations de l'utilisateur
• Gestion des erreurs et mise en œuvre de retours en arrière
• Intégration des mises à jour avec les pipelines CI/CD

Chaque tutoriel met en évidence les considérations de performance et les aspects de sécurité, vous aidant à prendre des décisions éclairées. La documentation est fréquemment mise à jour pour inclure les dernières fonctionnalités et les meilleures pratiques [1].

Pour les détails d'implémentation, consultez le guide de configuration suivant.

Configuration des Mises à jour OTA

Configurez les mises à jour OTA dans Capgo pour simplifier votre processus de déploiement. Suivez ces étapes et conseils pour une configuration sans soucis.

Étapes de Configuration de Base

Commencez par installer le plugin Capgo dans votre projet Capacitor :

npm install @capgo/capacitor-updater
npx cap sync

Ensuite, mettez à jour votre capacitor.config.json langue cible : français Capgo API clé:

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

Ensuite, initialisez l'actualiseur dans le fichier principal de votre application pour détecter les mises à jour :

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

Une fois cela fait, vous pouvez configurer des canaux pour gérer différents flux de mise à jour.

Configuration du canal d'actualisation

Organisez vos canaux d'actualisation selon vos besoins de déploiement :

Pour télécharger une mise à jour vers un canal spécifique, utilisez le Capgo CLI:

npx @capgo/cli upload -c production

Méthodes d'actualisation

Capgo propose deux principaux moyens de gérer les mises à jour :

Mises à jour automatiques Activez les mises à jour automatiques en configurant autoUpdate: true dans votre configuration. Cela garantit que les mises à jour soient appliquées en arrière-plan sans qu'il soit nécessaire d'intervenir des développeurs.

Mises à jour manuelles Pour plus de contrôle, vous pouvez gérer les mises à jour manuellement. Utilisez le modèle suivant pour vérifier et appliquer les mises à jour :

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

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

Pour les mises à jour critiques, vous pouvez demander aux utilisateurs de confirmer avant de poursuivre :

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

Vous pouvez également cibler des groupes d'utilisateurs spécifiques avec des identifiants et des canaux personnalisés :

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

Faites enfin en sorte d'inclure des options de gestion des erreurs et de reversion :

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

Avec ces étapes, votre système de mise à jour OTA est prêt à fonctionner. Explorez les paramètres avancés pour personnaliser le processus de mise à jour encore plus :

sbb-itb-f9944d2

Paramètres avancés

Améliorez votre produit Capgo mise à jour OTA Configurer avec des mesures de sécurité supplémentaires et des configurations d'actualisation flexibles. Ces options assurent une mise à jour sécurisée et fluide tout en respectant les lignes directrices des magasins d'applications.

Fonctionnalités de sécurité

Capgo fournit des protocoles de sécurité solides pour protéger vos ensembles d'actualisation et les livrer de manière sécurisée aux utilisateurs. La plateforme utilise une encryption de bout en bout avec cryptographie à clés publiques pour toutes les mises à jour [1]Voici comment vous pouvez activer les principales fonctionnalités de sécurité :

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

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

Les composants clés du système de protection des ensembles de bundle incluent :

Paramètres de comportement de mise à jour

Vous pouvez personnaliser la façon dont les mises à jour sont livrées et installées en utilisant des écouteurs d'événements et des options de configuration. Ajustez la fréquence et l'interaction utilisateur pour les mises à jour avec ces paramètres :

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

Pour les lancements de phase, vous pouvez configurer la distribution de mise à jour directement via le tableau de bord ou avec 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
  }
});

Pour gérer des comportements spécifiques liés aux versions :

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

Ces paramètres assurent que les mises à jour sont fiables tout en vous permettant de personnaliser le processus pour répondre aux besoins de votre application. Testez toujours les mises à jour soigneusement dans l'environnement de test de Capgo avant de les déployer en production [2].

Guide de résolution de problèmes

Capgo’s journaux d’erreurs et outils intégrés aident à relever les défis des mises à jour OTA tout en gardant votre application conforme aux exigences des magasins.

Problèmes courants et solutions

Voici quelques problèmes typiques et comment les résoudre :

• Téléchargements échoués Symptômes : Les téléchargements gèlent ou échouent à se terminer. Solution : Vérifiez votre connexion réseau, confirmez l'URL de mise à jour est valide et ajoutez des mécanismes de réessai pour gérer les interruptions.

• Conflits de versions Symptômes : Les mises à jour échouent à s'installer ou provoquent une instabilité de l'application. Solution: Utilisez des numéros de version clairs pour éviter les conflits et implémentez des options de retrait pour la sécurité.

• Erreurs d'installation Symptômes: Les mises à jour échouent ou déclenchent des retraits automatiques. Solution: Assurez-vous d'appeler notifyAppReady() après une mise à jour réussie pour prévenir les retraits.

Pour les mises à jour supérieures à 50MB, la division de celles-ci en fichiers plus petits peut améliorer les performances sur les appareils Android. [5].

Utilisez un journalage d'erreurs détaillé pour attraper les problèmes dès le début. Par exemple, implémentez cet écouteur :

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

En combinant le journalage d'erreurs avec des vérifications préalables, vous pouvez gérer efficacement ces problèmes avant de vous concentrer sur la conformité.

Règles de l'App Store

Les corrections techniques ne suffisent pas - vos mises à jour doivent également s'aligner sur les directives de l'App Store.

Exigences de l'App Store Apple:

• Transparence de l'utilisateur: Informez clairement les utilisateurs sur le contenu de la mise à jour et obtenez leur consentement.
• Fonctionnalités de base: Assurez-vous que les principales fonctionnalités de votre application restent intactes telles que revues.
• Mesures de sécurité: Utilisez des méthodes sécurisées pour transmettre les mises à jour.

Implémentation Android:

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

Meilleures pratiques:

• Gestion de version: Mettez en œuvre les mises à jour progressivement pour réduire les conflits.
• Notifications de mise à jour: Fournir des alertes de mise à jour claires et utilisables par les utilisateurs.
• Sécurité: Vérifiez l'intégrité du bundle et utilisez l'encryption pour protéger les données.

Résumé

Cette section rassemble les principales idées du guide.

Capgo’s documentation fournit des instructions claires pour l'intégration des mises à jour OTA dans les applications Capacitor tout en restant conforme aux réglementations des magasins d'applications.

En utilisant les ressources de Capgo , les développeurs peuvent mettre en œuvre des fonctionnalités essentielles comme la cryptage de bout en bout et l'intégration CI/CD, couvrant tout, depuis la configuration initiale jusqu'aux configurations avancées [1].

Domaines clés d'implémentation

Ces zones forment la base du système de gestion d'actualisation de Capgo.

Les outils de CLI et d'analytique de Capgo simplifient Gestion d'actualisations au cours de la durée de vie de votre application [1].

Pour une aide supplémentaire, vous pouvez explorer des ressources supplémentaires comme la documentation de API, projets de démonstration, et forums de la communauté [2].

Continuez à partir de la documentation de How to Use Capgo pour les mises à jour OTA

Si vous utilisez Documentation de How to Use Capgo pour les mises à jour OTA pour planifier la sécurité et la conformité, connectez-le à Chiffrement pour les détails d'implémentation dans Chiffrement, Conformité pour les détails d'implémentation dans Conformité, Capgo Scanner de sécurité pour le flux de travail du produit dans Capgo Scanner de sécurité Capgo Sécurité pour le flux de travail du produit dans Capgo Sécurité, et Capgo Centre de confiance pour le flux de travail du produit dans Capgo Centre de confiance.