Actualización automática

Esta documentación explicará cómo ejecutar su servidor de actualización automática.

Servir su paquete

Guía de origen para copiar https://myserver.com/app/updates/updates.json

If no estás familiarizado con servir un paquete, te recomendamos que intentes Capgo Cloud o vea un ejemplo aquí:

Servir un Paquete

Configuración

Agregar un updateUrl a tu capacitor.config.json.

{
  "plugins": {
    "CapacitorUpdater": {
      "updateUrl": "https://myserver.com/app/updates/updates.json",
    }
  }
}

Advertencia

Cuando estás empujando una actualización autoalojada, ten en cuenta que no puedes utilizar el extremo “HTTP” ya que va en contra de las políticas de seguridad de las aplicaciones de Android, para fines de prueba puedes habilitarlo.

Actualizar API

El plugin realizará una llamada POST a su API cada vez que se abra la aplicación, con el siguiente cuerpo:

interface AppInfos {
    "platform": "ios" | "android" | "electron",
    "device_id": "UUID_of_device_unique_by_install",
    "app_id": "APPID_FROM_CAPACITOR_CONFIG",
    "custom_id": "your_custom_id_set_on_runtime",
    "plugin_version": "PLUGIN_VERSION",
    "version_build": "VERSION_NUMBER_FROM_NATIVE_CODE",
    "version_code": "VERSION_CODE_FROM_NATIVE_CODE",
    "version_name": "LAST_DOWNLOADER_VERSION" | "builtin"
    "version_os": "VERSION_OF_SYSTEM_OS",
    "is_emulator": boolean,
    "is_prod": boolean,
}

El servidor API debería responder, en formato JSON, al plugin de actualización capacitor. Con esta información si es necesario una actualización:

{
"version": "1.2.3",
"url": "https://myserver.com/app/updates/my-new-app-2.0.0.zip",
"checksum": "sha256_checksum_of_bundle"
}

En modo de actualización automática, el servidor debería comparar las versiones y devolver la correcta, si la clave URL está presente, el plugin inicia el proceso de descarga.

Si agrega las claves “mensaje” y “error”, la versión no se establecerá, y el mensaje se mostrará en los registros en su lugar.

version La clave debería estar en semver formato.

El zip debería tener index.html como archivo en la raíz, o solo una carpeta en la raíz con index.html dentro.

Puede usar el comando de CLI para comprimir su paquete:

Crear un paquete con sus archivos para servir desde su servidor

npx @capgo/cli bundle zip --path [/path/to/my/bundle]

Verificando Suma de Verificación del Paquete

Importante: Debes usar el Capgo CLI para crear su archivo zip de paquete. El plugin Capgo requiere un formato y estructura zip específicos que solo se garantizan cuando se utiliza la herramienta oficial CLI. Las utilidades de zip estándar pueden crear archivos incompatibles.

Para generar la suma de verificación para su paquete, utilice el comando Capgo CLI zip con la --json flag:

Crear paquete con información de suma de verificación

npx @capgo/cli bundle zip [appId] --json

Este comando realizará:

• Crear un archivo zip compatible con el plugin Capgo
• Generar el checksum SHA256 para la verificación de integridad
• Mostrar información del paquete en formato JSON

Ejemplo de salida:

{
  "version": "1.2.3",
  "checksum": "a1b2c3d4e5f6789...",
  "size": 1234567
}

Utilice el checksum valor de esta salida en su respuesta API para asegurarse de que el plugin pueda verificar la integridad del paquete antes de la instalación.