Aller directement au contenu principal

Comment utiliser Capgo Documentation pour les mises à jour OTA

Découvrez comment mettre en œuvre des mises à jour Over-the-Air sécurisées dans vos applications Capacitor avec la documentation exhaustive et les étapes détaillées de Capgo.

Martin Donadieu

Martin Donadieu

Spécialiste du contenu

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

Besoin de mises à jour d'application plus rapides sans les retards des magasins d'applications? __CAPGO_KEEP_0__ Capgo Résultats clés :

Qu'est-ce que __CAPGO_KEEP_0__?

  • 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 ? Économisez du temps, améliorez l'expérience utilisateur et réparez les bogues rapidement.
  • Comment commencer ?
    • Installez le Capgo: npm install @capgo/capacitor-updater
    • Configure your app with an API key.
    • Configurez votre application avec une
  • __CAPGO_KEEP_0__ clé. Utilisez des canaux comme “production” ou “beta” pour des déploiements ciblés.

Capgo’s documentation (capgo.app/docs) fournit des instructions étape par étape pour la mise en place, 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 mise à jour en direct

Capgo Interface de tableau de bord de mise à jour en direct

Utilisation de la documentation Capgo

La navigation dans la documentation est essentielle lors du travail avec les mises à jour OTA. La documentation de Capgo 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]. Il est organisé en sections en fonction de des buts spécifiques :

SectionObjectifSujets clés
DémarrageConfiguration initialeÉtapes d'installation, API clé de configuration
ConfigurationParamètres de baseConfiguration des plugins, configuration de l'environnement
API RéférenceDétails techniquesMéthodes, paramètres, valeurs de retour
SécuritéMesures de protectionConfiguration de l'encodage, vérification de signature
DépannageRésolution de problèmesProblèmes courants, outils de diagnostic

Termes et concepts importants

Voici quelques termes clés que vous rencontrerez :

  • Canaux: Ces flux de mise à jour sont utilisés pour contrôler la distribution de versions. Par exemple, vous pourriez configurer les canaux « production », « bêta » et « étape » pour répondre aux besoins de différents groupes d'utilisateurs [4].
  • Mises à jour des politiques: Ces éléments définissent 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].
  • Listeurs d'état d'application: Ces composants suivent si l'application est en avant-plan ou en arrière-plan [4].
  • Bundles: Fichiers de mise à jour empaquetés contenant la nouvelle version de votre application, y compris les actifs, les code modifications et les mises à jour de configuration [4].

Code Exemples et tutoriels

La documentation fournit des exemples de 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 les cas d'utilisation plus avancés, la documentation inclut des exemples du monde réel [2][3], tels que :

  • Passage 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 d'actualisations 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 en Ligne

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

É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 fichier avec votre Capgo API clé:

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

Enfin, 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 effectué, vous pouvez configurer les canaux pour gérer différents flux d'actualisation.

Configuration du canal d'actualisation

Organisez vos canaux d'actualisation pour répondre à vos besoins de déploiement :

Type de canalObjectifUtilisation
ProductionSorties stablesBase d'utilisateurs généraux
ÉtapesTests de pré-versionÉquipe de test qualité et utilisateurs bêta
BêtaTests de fonctionnalitésPionniers

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 définissant autoUpdate: true dans votre configuration. Cela garantit que les mises à jour sont appliquées en arrière-plan sans effort supplémentaire 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 leur accord 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 ID et des canaux personnalisés :

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

Finalement, assurez-vous d'inclure des options de gestion des erreurs et de rollback :

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 Capgo mise à jour OTA configuration avec des mesures de sécurité supplémentaires et des configurations de mise à jour flexibles. Ces options assurent une expérience de mise à jour sécurisée et fluide tout en respectant les directives des magasins d'applications.

Fonctionnalités de sécurité

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

// 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 d'actualisations incluent :

Fonctionnalité de sécuritéDescriptionMise en œuvre
Intégrité du paquetVérifie l'authenticité des packages avec des signatures cryptographiquesActivé automatiquement avec setVerifyBundles()
Protection de roulementRevertit à une version stable si une mise à jour échoueIntégré au processus d'actualisation
Contrôle d'accèsGère les mises à jour avec des permissions basées sur des rôlesConfiguré via le tableau de bord

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 des déploiements étalés, vous pouvez configurer la distribution de mises à 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 liés à des versions spécifiques :

// 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

Les journaux d'erreurs et les outils intégrés de Capgo aident à résoudre les défis liés aux mises à jour OTA tout en maintenant votre application conforme aux exigences des magasins.

Problèmes courants et solutions

Ici sont présentés quelques problèmes courants et comment les résoudre :

  • Téléchargements Échoués SymptômesLes téléchargements s'arrêtent ou échouent à se terminer. SolutionVérifiez votre connexion réseau, assurez-vous que l'URL de mise à jour est valide et ajoutez des mécanismes de réessai pour gérer les interruptions.

  • Conflits de Versions SymptômesLes mises à jour échouent à s'installer ou causent une instabilité de l'application. SolutionUtilisez 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 redémarrages automatiques. Solution: Assurez-vous d'appeler notifyAppReady() après une mise à jour réussie pour prévenir les redémarrages.

Pour les mises à jour supérieures à 50 Mo, 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 ce listener :

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

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

Exigences de l'App Store d'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 comme prévu.
  • 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:

  • Contrôle de version: Mettez en œuvre les mises à jour progressivement pour réduire les conflits.
  • Notifications de mise à jour: Fournissez des alertes de mise à jour claires et utilisables.
  • 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 idées principales de la guide.

Capgo’s documentation fournit des instructions claires pour intégrer les 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

AspectFocus cléOù le trouver
SécuritéVérifications d'intégrité et de chiffrementFonctionnalités de Sécurité section
ConformitéRéunir les exigences d'Apple et d'AndroidRègles de l'App Store guide
Gestion des Mises à JourContrôle de version et options de reversionMéthodes de Mise à Jour guide
Gestion des erreursÉtapes de dépannage et de journalisationGuide de résolution de problèmes

Ces zones forment la base du système de gestion des mises à jour de Capgo.

Capgo’s CLI et outils d’analytique simplifient la gestion des mises à jour au cours de la durée de vie de votre application [1].

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

Mises à jour en temps réel pour les applications Capacitor

Lorsqu'un bug de la couche web est en ligne, expédiez la correction par Capgo au lieu d'attendre des jours pour l'approbation de la boutique d'applications. Les utilisateurs reçoivent la mise à jour en arrière-plan tandis que les modifications natives restent dans la voie de revue normale.

Commencez maintenant

Dernières actualités de notre blog

Capgo vous donne les meilleures informations dont vous avez besoin pour créer une application mobile vraiment professionnelle.