Cómo usar la documentación de Capgo para actualizaciones OTA

Necesita actualizar app updates sin retrasos en la tienda de aplicaciones? Capgo te permite entregar actualizaciones de Over-the-Air (OTA) seguras de inmediato a tus usuarios. Saltar las revisiones de la tienda de aplicaciones y mantener tu app actualizada con facilidad.

¿Qué es __CAPGO_KEEP_0__?

• What is Capgo? Una plataforma de código abierto para actualizaciones en vivo Capacitor apps.
• ¿Por qué las actualizaciones OTA? Ahorra tiempo, mejora la experiencia del usuario y corrige errores rápidamente.
• Aprende a empezar.
  • Instala el plugin Capgo: npm install @capgo/capacitor-updater
  • Configura tu aplicación con una clave API.
  • Utiliza canales como “producción” o “beta” para lanzamientos dirigidos.
• Características avanzadas: Cifrado de extremo a extremo, manejo de errores y integración CI/CD.

La documentación de Capgo (capgo.app/docsProporciona instrucciones paso a paso para la configuración, la seguridad y el troubleshooting. Desde la instalación hasta las configuraciones avanzadas, es tu guía para actualizaciones sin problemas.

CapgoCapacitorJs plugin para Live update

Usando Capgo Documentación

Navegar la documentación de manera efectiva es fundamental al trabajar con actualizaciones OTA. La documentación de Capgo proporciona orientación detallada para integrar actualizaciones en vivo en aplicaciones Capacitor.

Dónde encontrar la documentación

Puede acceder a la documentación de Capgo en capgo.app/docs [1]. Está organizada en secciones basadas en fines específicos:

Términos y conceptos importantes

Aquí hay algunos términos clave que encontrarás:

• CanalesEstos son los flujos de actualización utilizados para controlar la distribución de versiones. Por ejemplo, podrías configurar los canales "producción", "beta" y "staging" para atender a diferentes grupos de usuarios [4].
• Políticas de actualizaciónEstos definen cómo se entregan y aplican las actualizaciones. Las opciones incluyen descargas automáticas, horarios de instalación y solicitudes al usuario. [1].
• Escuchadores de estado de la aplicaciónEstos componentes siguen si la aplicación está en primer plano o en segundo plano [4].
• Paquetes: Archivos de actualizaciones empaquetados que contienen la nueva versión de tu aplicación, incluyendo activos, code cambios y actualizaciones de configuración [4].

Ejemplos y tutoriales de Code

La documentación proporciona ejemplos de code para simplificar la integración. Aquí tienes un ejemplo básico utilizando TypeScript/JavaScript:

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

// Initialize the updater
await CapacitorUpdater.notifyAppReady()

Para casos de uso más avanzados, la documentación incluye ejemplos reales [2][3], como:

• Cambiar canales para pruebas A/B
• Custom update flows with user prompts
• Gestionar errores e implementar rollback
• Integrar actualizaciones con pipelines CI/CD

Cada tutorial también destaca consideraciones de rendimiento y aspectos de seguridad, ayudándote a tomar decisiones informadas. La documentación se actualiza con frecuencia para incluir las últimas características y mejores prácticas [1].

Para detalles de implementación, consulta la guía de configuración siguiente.

Configuración de Actualizaciones OTA

Configura actualizaciones OTA en Capgo para simplificar tu proceso de despliegue. Sigue estos pasos y consejos para una configuración sin problemas.

Pasos Básicos de Configuración

Comience instalando el plugin Capgo en su proyecto Capacitor.

npm install @capgo/capacitor-updater
npx cap sync

Next, actualiza tu capacitor.config.json archivo con tu Capgo API clave:

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

Luego, inicialice el actualizador en el archivo principal de su aplicación para detectar actualizaciones:

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

Una vez hecho esto, puedes configurar canales para gestionar diferentes flujos de actualizaciones.

Configuración de Canales de Actualización

Organiza tus canales de actualización para satisfacer tus necesidades de despliegue:

Para subir una actualización a un canal específico, utilice el Capgo CLI:

npx @capgo/cli upload -c production

Métodos de Actualización

Capgo ofrece dos formas principales para manejar actualizaciones:

Actualizaciones Automáticas Habilite actualizaciones automáticas configurando autoUpdate: true en su configuración. Esto garantiza que las actualizaciones se apliquen en segundo plano sin ningún esfuerzo adicional de los desarrolladores.

Actualizaciones Manuales Para tener más control, puede gestionar las actualizaciones manualmente. Utilice el siguiente patrón para verificar y aplicar actualizaciones:

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

Además, puede dirigirse a grupos de usuarios específicos con IDs y canales personalizados:

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

Finalmente, asegúrese de incluir manejo de errores y opciones de rollback:

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

Con estos pasos, su sistema de actualizaciones OTA está listo para funcionar. Explore ajustes avanzados para personalizar el proceso de actualización aún más.

sbb-itb-f9944d2

Ajustes Avanzados

Mejore su Capgo actualización OTA con medidas de seguridad adicionales y configuraciones de actualización flexibles. Estas opciones garantizan una experiencia de actualización segura y suave, mientras cumple con las directrices de las tiendas de aplicaciones.

Características de Seguridad

Capgo ofrece protocolos de seguridad fuertes para proteger sus conjuntos de actualización y entregarlos de manera segura a los usuarios. La plataforma utiliza cifrado de extremo a extremo con criptografía de clave pública para todas las actualizaciones [1]A continuación, se muestra cómo habilitar características de seguridad clave:

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

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

Componentes clave del sistema de protección del paquete incluyen:

Configuración de comportamiento de actualización

Usted puede personalizar cómo se entregan y se instalan las actualizaciones utilizando escuchadores de eventos y opciones de configuración. Ajuste el tiempo y la interacción del usuario para las actualizaciones con estas configuraciones:

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

Puede configurar la distribución de actualizaciones directamente a través de la consola 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
  }
});

To handle specific version-related behaviors:

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

Estas configuraciones garantizan que las actualizaciones sean fiables mientras le permite personalizar el proceso para las necesidades de su aplicación. Siempre pruebe las actualizaciones exhaustivamente en el entorno de pruebas de Capgo antes de desplegarlas en producción [2].

Guía de Resolución de Problemas

Los registros de errores de Capgo y herramientas integradas ayudan a superar los desafíos de actualizaciones OTA mientras mantienen su aplicación conforme a los requisitos de las tiendas.

Problemas Comunes y Soluciones

Aquí se presentan algunos problemas típicos y cómo abordarlos:

• Descargas Fallidas Simptomas: Las descargas se congelan o fallan para completarse. Solución: Verifique su conexión a Internet, confirme la URL de actualización es válida y agregue mecanismos de retry para manejar interrupciones.

• Conflictos de Versión Síntomas: Las actualizaciones fallan al instalarse o causan inestabilidad en la aplicación. Solución: Utilice números de versión claros para evitar conflictos y implemente opciones de rollback para seguridad.

• Errores de Instalación Síntomas: Las actualizaciones fallan o desencadenan rollbacks automáticos. Solución: Asegúrese de llamar a notifyAppReady() después de una actualización exitosa para prevenir rollbacks.

Para actualizaciones mayores a 50MB, dividirlas en archivos más pequeños puede mejorar el rendimiento en dispositivos Android. [5].

Utilice el registro de errores detallado para detectar problemas temprano. Por ejemplo, implemente este escuchador:

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

Al combinar el registro de errores con comprobaciones previas, puede manejar estos problemas de manera efectiva antes de enfocarse en la conformidad.

Reglas de la Tienda de Aplicaciones

Las correcciones técnicas no son suficientes - sus actualizaciones también deben cumplir con las directrices de las tiendas de aplicaciones.

Requisitos de la Tienda de Aplicaciones de Apple:

• Transparencia del usuarioInforma claramente a los usuarios sobre el contenido de la actualización y obtén su consentimiento.
• Funcionalidad Principal: Ensure your app’s main features remain intact as reviewed.
• Medidas de Seguridad: Utilice métodos seguros para transmitir actualizaciones.

Implementación de Android:

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

Mejores prácticas:

• Control de versionesDesplegar actualizaciones de manera gradual para reducir conflictos.
• Notificaciones de actualizaciónProporcionar alertas de actualización claras y amigables.
• SeguridadVerificar la integridad del paquete y utilizar cifrado para proteger los datos.

Resumen

Esta sección reúne las ideas principales de la guía.

La documentación de Capgo ofrece instrucciones claras para integrar actualizaciones OTA en aplicaciones Capacitor y cumplir con las regulaciones de las tiendas de aplicaciones.

Utilizando los recursos de Capgo, los desarrolladores pueden implementar características esenciales como seguridad de extremo a extremo y integración CI/CDcobertura de todo, desde la configuración inicial hasta las configuraciones avanzadas [1].

Áreas clave de implementación

Estos áreas forman la base del sistema de gestión de actualizaciones de Capgo.

Capgo’s CLI y herramientas de análisis simplifican gestionar actualizaciones a lo largo de la vida de tu aplicación [1].

Para obtener más apoyo, puedes explorar recursos adicionales como la documentación de API, proyectos de muestra, y foros de la comunidad [2].

Sigue adelante desde Cómo usar la documentación de Capgo para actualizaciones OTA

Si estás utilizando Cómo usar la documentación de Capgo para actualizaciones OTA para planificar la seguridad y la conformidad, conecta con Encriptación para el detalle de implementación de Encriptación, Cumplimiento para el detalle de implementación de Cumplimiento, Capgo Escáner de Seguridad para el flujo de trabajo del producto en Capgo Escáner de Seguridad, Capgo Seguridad para el flujo de trabajo del producto en Capgo Seguridad, y Capgo Centro de Confianza para el flujo de trabajo del producto en Capgo Centro de Confianza.