Passer à la navigation principale

How to Use Capgo Documentation for OTA Updates

Learn how to implement secure Over-the-Air updates in your Capacitor apps with Capgo's comprehensive documentation and step-by-step guidance.

Apprenez à mettre en œuvre des mises à jour Over-the-Air sécurisées dans vos applications __CAPGO_KEEP_0__ avec la documentation complète et étape par étape de __CAPGO_KEEP_1__

Martin Donadieu

Martin Donadieu

How to Use Capgo Documentation for OTA Updates

Comment utiliser la documentation de __CAPGO_KEEP_0__ pour les mises à jour OTA Besoin de mises à jour d'applications plus rapides Sans les retards de l'App Store ? Capgo Vous permet de livrer des mises à jour sécurisées Over-the-Air (OTA) instantanément à vos utilisateurs. Évitez les examens de l'App Store et mettez votre application à jour avec facilité.

Principaux points à retenir :

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

La documentation de Capgo (« capgo.app/docs) fournit des instructions étape par étape pour la mise en place, la sécurité et la dépannage. De l'installation aux configurations avancées, c'est votre guide incontournable pour des mises à jour sans heurts.

Capgoplugin CapacitorJs pour les mises à jour en direct

Interface de l'interface de mise à jour en direct Capgo

Utiliser la documentation de Capgo

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

Section Objectif context : Page/zone : Site web de marketing Capgo. Rôle : Étiquette de navigation ou élément UI court. Clé de message `subprocessors_table_purpose` (Objectif de la table des sous-traitants).
Sujets clés Prise en main Configuration initiale API clé de configuration
Configuration Paramètres de base Configuration des plugins, paramétrage de l'environnement
API Référence Détails techniques Méthodes, paramètres, valeurs de retour
Sécurité Mesures de protection Configuration de l'encryption, vérification de signature
Résolution de problèmes Problèmes de dépannage Problèmes courants, outils de diagnostic

Termes et concepts importants

Voici quelques termes clés que vous rencontrerez :

  • Canauxcontext : nom du canal de mise à jour de Capgo. Page/zone : page de marketing des solutions de Capgo. Rôle : étiquette de navigation ou élément de menu court. Voir dans : page solutions/white-label.astro. Clé de message `solutions_white_label_visual_cell2_value` (Valeur de cellule visuelle de Solutions White Label). [4].
  • : Ces sont des flux d'actualisation utilisés pour contrôler la distribution de versions. Par exemple, vous pouvez configurer des canaux « production », « beta » et « staging » pour répondre aux besoins de différents groupes d'utilisateursPolitiques d'actualisation [1].
  • : Ces 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Écouteurs d'état d'application [4].
  • : Ces composants suivent si l'application est en avant-plan ou en arrière-plan: Packaged update files containing your app’s new version, including assets, code changes, and configuration updates [4].

: Fichiers d'actualisation emballés contenant la nouvelle version de votre application, y compris les actifs, les modifications de Code et les mises à jour de configuration : 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 des cas d'utilisation plus avancés, la documentation inclut des exemples du monde réel [2][3], tels que :

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

Chaque tutoriel met également 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 de 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 encombre.

Étapes de Configuration de Base

Commencez par installer le Capgo plugin 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"
    }
  }
}

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 effectué, vous pouvez configurer des canaux pour gérer différents flux de mise à jour.

Mise à jour du canal

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

Type de canal Objectif Utilisation
Production Sorties stables Base d'utilisateurs généraux
Étape de test Équipe de test qualité et utilisateurs bêta Bêta
Test de fonctionnalités Premiers adoptants Pour télécharger une mise à jour vers un canal spécifique, utilisez le

__CAPGO_KEEP_0__ __CAPGO_KEEP_1__ 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 qu'il soit nécessaire d'intervenir des développeurs.

Mises à jour manuelles Pour un contrôle plus approfondi, 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 à l'utilisateur 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');

Enfin, assurez-vous d'inclure un traitement d'erreur et des options de retrait :

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

En suivant ces étapes, votre système d'actualisation OTA est prêt à l'emploi. Explorez les paramètres avancés pour personnaliser le processus d'actualisation.

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 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 de mise à jour 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 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 de l'ensemble de la mise à jour incluent :

Fonctionnalité de Sécurité Description Mise en œuvre
Intégrité de l'Ensemble Vérifie l'authenticité du package avec des signatures cryptographiques Activé automatiquement avec setVerifyBundles()
Protection de Rollback Revenu à une version stable si une mise à jour échoue Intégré au processus de mise à jour
Gestion des accès Gère les mises à jour avec des permissions basées sur les rôles Configuré 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 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 liés aux 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
  }
});

Ceux-ci s'assurent que les mises à jour soient fiables tout en vous permettant de personnaliser le processus en fonction des besoins de votre application. Testez toujours les mises à jour de manière approfondie dans l'environnement de pré-production 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 à relever les défis liés aux mises à jour OTA tout en gardant votre application conforme aux exigences des magasins.

Problèmes courants et solutions

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

  • Téléchargements échoués Symptômes: Les téléchargements s'arrêtent ou échouent à se terminer. Solutions: 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ômesLes mises à jour échouent soit à l'installation, soit entraînent 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ômesLes mises à jour échouent ou déclenchent des retours automatiques. SolutionAssurez-vous d'appeler notifyAppReady() après une mise à jour réussie pour prévenir les retours.

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 tôt. 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 être conformes aux lignes directrices 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.

Mise en œuvre 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: Déployez les mises à jour progressivement pour réduire les conflits.
  • Notifications de mise à jour: Fournissez des avertissements de mise à jour clairs et utilisateurs.
  • Sécuritécontext

Page/zone : Page de produit/prix d'entreprise. Rôle : Étiquette de l'IHM. Voir dans : page enterprise.astro. Message clé `enterprise_hero_security_label` (Étiquette de sécurité de l'héros de l'entreprise).

: Vérifiez l'intégrité du bundle et utilisez l'encryption pour protéger les données.

Capgo’s documentation provides clear instructions for integrating OTA updates into Capacitor apps while staying compliant with app store regulations.

Using Capgo’s resources, developers can implement essential features like La documentation de __CAPGO_KEEP_0__ fournit des instructions claires pour intégrer les mises à jour OTA dans les applications __CAPGO_KEEP_1__ tout en restant conforme aux réglementations des magasins d'applications. En utilisant les ressources de __CAPGO_KEEP_0__, les développeurs peuvent mettre en œuvre des fonctionnalités essentielles comme chiffrement de bout en bout, couvrant tout, depuis la mise en place initiale jusqu'à des configurations avancées [1].

Domaines clés d'implémentation

Aspect Focus clé Où le trouver
Sécurité Cryptage et vérifications d'intégrité Fonctionnalités de sécurité Sous-section
Conformité Réunir les exigences d'Apple et d'Android Règles de l'App Store guide
Gestion des Mises à Jour Contrôle de version et options de reversion Méthodes de Mise à Jour guide
Gestion des Erreurs Étapes de journalisation et de dépannage Guide de Résolution de Problèmes

Ces domaines 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 un soutien supplémentaire, vous pouvez explorer des ressources supplémentaires comme API documentation, projets d'exemple, et forums de la communauté [2].

Continuez à partir de Comment utiliser Capgo Documentation pour les mises à jour OTA

Si vous utilisez Comment utiliser Capgo Documentation pour les mises à jour OTA pour planifier la sécurité et la conformité, connectez-l’à Encryption pour les détails d'implémentation dans Encryption, Compliance pour les détails d'implémentation dans Compliance, 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.

Mises à jour instantanées pour les applications Capacitor

When a web-layer bug is live, ship the fix through Capgo instead of waiting days for app store approval. Users get the update in the background while native changes stay in the normal review path.

Lorsqu'un bug de couche web est en ligne, expédiez la correction par le biais de __CAPGO_KEEP_0__ au lieu de attendre des jours pour l'approbation de l'App Store. Les utilisateurs reçoivent l'actualisation en arrière-plan tandis que les modifications natives restent dans le chemin de revue normal.

Contexte : Page/zone : Site web de marketing Capgo. Rôle : Paragraphe de description ou de métadescription de soutien. Vu dans : composant GetStarted.astro. Préservons les termes de produit/marque et les termes de développeur exactement. Clé de message `instant_updates_for_capacitor_apps_description` (Description des mises à jour instantanées pour les applications Capacitor).

Les dernières actualités de notre Blog

Capgo vous offre les meilleures informations nécessaires pour créer une application mobile véritablement professionnelle.