Comment utiliser la documentation Capgo pour les mises à jour OTA

Need faster mises à jour d'app sans les délais des stores ? Capgo vous permet de livrer instantanément des mises à jour Over-the-Air (OTA) sécurisées à vos utilisateurs. Évitez les révisions des stores et maintenez votre application à jour en toute simplicité.

Points clés :

• Qu'est-ce que le Capgo ? Une plateforme open source pour les live update dans Capacitor les apps.
• Pourquoi les mises à jour OTA ? Gagnez du temps, améliorez l'expérience utilisateur et corrigez les bugs rapidement.
• Comment démarrer ?
  • Installez le plugin Capgo: npm install @capgo/capacitor-updater
  • Configurez votre app avec une clé API.
  • Utilisez des canaux comme « production » ou « beta » pour des déploiements progressifs ciblés.
• Fonctionnalités avancées : Chiffrement de bout en bout, gestion des erreurs et intégration CI/CD.

La documentation de Capgo (capgo.app/docs) propose 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 de référence pour des mises à jour fluides.

Capgo, le plugin CapacitorJs pour Live update

Utiliser la documentation Capgo

Naviguer efficacement dans la documentation est essentiel lors de l'utilisation des live updates. La documentation de Capgo offre un guide détaillé pour intégrer les live updates dans vos applications Capacitor.

Où trouver la documentation

Vous pouvez accéder à la documentation de Capgo sur capgo.app/docs [1]. Elle est organisée en sections selon des objectifs précis :

Termes et concepts importants

Voici quelques termes clés que vous rencontrerez :

• Canaux: Ce sont des flux de mises à jour utilisés pour contrôler la distribution des versions. Par exemple, vous pouvez configurer des canaux « production », « beta » et « staging » pour différents groupes d'utilisateurs [4].
• Politiques de mise à jour: Ils définissent comment les mises à jour sont livrées et appliquées. Les options incluent le téléchargement automatique, le moment de l'installation et les prompts utilisateur. [1].
• Écouteurs d'état de l'app: Ces composants suivent si l'app est au premier plan ou en arrière-plan [4].
• Les bundles: Fichiers de mise à jour packagés contenant la nouvelle version de votre app, incluant les assets, les changements code et les mises à jour de configuration [4].

Exemples et tutoriels Code

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

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

// Initialize the updater
await CapacitorUpdater.notifyAppReady()

Pour des cas d'usage plus avancés, la documentation inclut des exemples concrets [2][3], tels que :

• Changer de canal pour l'A/B testing
• Custom update flows with user prompts
• Gestion des erreurs et implémentation des rollbacks
• Intégration des mises à jour aux pipelines CI/CD

Chaque tutoriel met aussi en avant les considérations de performance et les aspects de sécurité, pour vous aider à prendre des décisions éclairées. La documentation est régulièrement mise à jour pour inclure les dernières fonctionnalités et bonnes 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 optimiser votre processus de déploiement. Suivez ces étapes et conseils pour une configuration sans accroc.

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

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

Then, initialize the updater in your app’s main file to detect updates:

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

Une fois cette étape terminée, vous pouvez configurer des canaux pour gérer différents flux de mises à jour.

Configuration du canal de mise à jour

Organisez vos canaux de mise à jour pour répondre à vos besoins de déploiement :

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

npx @capgo/cli upload -c production

Méthodes de mise à jour

Capgo propose deux méthodes principales pour 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 sont appliquées en arrière-plan sans effort supplémentaire pour les 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);
}

For critical updates, you can prompt users before proceeding:

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

You can also target specific user groups with custom IDs and channels:

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

Enfin, pensez à inclure la gestion des erreurs et des options 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. Explorez les paramètres avancés pour personnaliser davantage le processus de mise à jour.

sbb-itb-f9944d2

Paramètres avancés

Améliorez votre configuration Capgo OTA avec des mesures de sécurité renforcées et des configurations de mise à jour flexibles. Ces options garantissent une expérience de mise à jour fluide et sécurisée tout en respectant les directives des stores.

Fonctionnalités de sécurité

Capgo propose des protocoles de sécurité robustes pour protéger vos bundles de mise à jour et les livrer en toute sécurité aux utilisateurs. La plateforme utilise un chiffrement de bout en bout avec une cryptographie à clé publique pour toutes les mises à jour [1]. Voici comment 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 bundles incluent :

Paramètres de comportement des mises à jour

Vous pouvez personnaliser la manière dont les mises à jour sont livrées et installées en utilisant des écouteurs d'événements et des options de configuration. Ajustez le timing et l'interaction utilisateur 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 déploiements progressifs, vous pouvez configurer la distribution des mises à jour directement via le dashboard 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 à une version :

// 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 garantissent la fiabilité des mises à jour tout en vous permettant d'adapter le processus aux besoins de votre app. Testez toujours vos mises à jour en profondeur dans l'environnement de staging de Capgo avant de les déployer en production [2].

Guide de résolution de problèmes

Les logs d'erreur et les outils intégrés de Capgo aident à résoudre les problèmes de mise à jour OTA tout en garantissant la conformité de votre application aux exigences des stores.

Problèmes courants et solutions

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

• Échecs de téléchargement Symptômes: Les téléchargements se figent ou ne se terminent pas. Solution: Vérifiez votre connexion réseau, confirmez que l'URL de mise à jour est valide et ajoutez des mécanismes de retry pour gérer les interruptions.

• Conflits de version Symptômes: Les mises à jour ne s'installent pas ou causent une instabilité de l'app. Solution: Utilisez des numéros de version clairs pour éviter les conflits et implémentez des options de rollback par sécurité.

• Erreurs d'installation Symptômes: Updates fail or trigger automatic rollbacks. Solution: Assurez-vous d'appeler notifyAppReady() après une mise à jour réussie pour éviter les rollbacks.

Pour les mises à jour de plus de 50 Mo, les diviser en fichiers plus petits peut améliorer les performances sur les appareils Android [5].

Utilisez des logs d'erreur détaillés pour détecter les problèmes tôt. 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 les logs d'erreur avec des vérifications préalables, vous pouvez gérer ces problèmes efficacement avant de vous concentrer sur la conformité.

Règles des stores

Les correctifs techniques ne suffisent pas : vos mises à jour doivent aussi respecter les directives des stores.

Exigences de l'App Store d'Apple:

• Transparence utilisateur: Informez clairement les utilisateurs du contenu de la mise à jour et obtenez leur consentement.
• Fonctionnalités clés: Ensure your app’s main features remain intact as reviewed.
• Mesures de sécurité: Utilisez des méthodes sécurisées pour transmettre les mises à jour.

Implémentation sur Android:

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

Bonnes pratiques:

• Gestion des versions: Déployez les mises à jour progressivement pour réduire les conflits.
• Notifications de mise à jour: Proposez des alertes de mise à jour claires et intuitives.
• Sécurité: Vérifiez l'intégrité du bundle et utilisez le chiffrement pour protéger les données.

Résumé

Cette section synthétise les idées principales du guide.

La documentation de Capgo fournit des instructions claires pour intégrer les Live Updates dans vos applications Capacitor tout en respectant les règles des stores.

Using Capgo’s resources, developers can implement essential features like chiffrement de bout en bout et Intégration CI/CD, couvrant tout, de la configuration initiale aux réglages avancés [1].

Domaines d'implémentation clés

Ces sections constituent le cœur du système de gestion des mises à jour de Capgo.

Les outils CLI et d'analytics de Capgo simplifient gérer les mises à jour tout au long du cycle de vie de votre application [1].

Pour obtenir plus d'aide, vous pouvez consulter d'autres ressources comme la documentation API, des projets d'exemple, et forums de la communauté [2].

Continuer depuis « Comment utiliser la documentation Capgo pour les mises à jour OTA »

Si vous utilisez Comment utiliser la documentation Capgo pour les mises à jour OTA pour planifier la sécurité et la conformité, connectez-l’à Chiffrement pour les détails d'implémentation du chiffrement, Conformité pour les détails d'implémentation de la conformité, Scanner de sécurité Capgo pour le workflow produit dans Capgo Security Scanner, Capgo et la sécurité pour le workflow produit dans Capgo Security, et Capgo Centre de confiance pour le workflow produit dans Capgo Trust Center.