Auto Update

GitHub

Eine Einrichtungsanleitung mit den Installationsanweisungen und der vollständigen Markdown-Anleitung für diesen Plugin kopieren.

Dokumentation, die erklärt, wie man seinen Auto-Update-Server ausführt.

Deinen Bundle bereitstellen

Stellen Sie sicher, dass Ihr Bundle über HTTPS bereitgestellt wird und der Server die richtigen CORS-Kopfzeilen hat, um dem App die Möglichkeit zu geben, die Aktualisierung herunterzuladen. e.g. https://myserver.com/app/updates/updates.json

Wenn Sie unbekannt sind, wie man ein Bundle bereitstellt, empfehlen wir Ihnen, es mit Capgo Cloud auszuprobieren oder ein Beispiel hier anzusehen:

Ein Bundle bereitstellen

Konfiguration

Hinzufügen Sie ein updateUrl zu Ihrem capacitor.config.json.

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

Update API

Der Plugin wird eine POST-Anfrage an Ihren API senden, sobald die App geöffnet wird, mit diesem Body:

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,
}

Der Server API sollte antworten, in JSON, auf den capacitor-Updater-Plugin. Mit dieser Daten, wenn eine Aktualisierung erforderlich ist:

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

In der Auto-Aktualisierungsmodus sollte der Server die Versionen vergleichen und die richtige zurückgeben, wenn die URL-Schlüssel vorhanden ist, startet der Plugin den Download-Prozess.

Wenn Sie die Schlüssel „message“ und „error“ hinzufügen, wird die Version nicht gesetzt und die Nachricht wird stattdessen in den Protokollen angezeigt.

version Die Schlüssel sollte in semver Format sein.

Die Zip sollte index.html als Datei am Root oder nur eine Ordner am Root mit index.html drin haben.

Sie können den Befehl von CLI verwenden, um Ihr Bundle zu komprimieren:

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

Bundle-Prüfsumme generieren

Wichtig: Sie müssen den Capgo CLI verwenden, um Ihr Bundle-Zip-Datei zu erstellen. Das Capgo-Plugin erfordert eine spezifische Zip-Format und -Struktur, die nur dann garantiert ist, wenn Sie das offizielle CLI-Tool verwenden. Standard-Zip-Utilitäten können inkompatible Archive erstellen.

Um die Prüfsumme für Ihr Bundle zu generieren, verwenden Sie den Capgo CLI-Zip-Befehl mit dem Flag: --json Flag: Prüfsumme in das Bundle aufnehmen

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

Erstellt ein Bundle mit Prüfsumme

Einen korrekt formatierten Zip-Datei erstellen, der mit dem Capgo-Plugin kompatibel ist
Generieren Sie den SHA256-Prüfsummenwert für die Integritätsüberprüfung
Bündelinformationen im JSON-Format ausgeben

Beispiel-Ausgabe:

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

Verwenden Sie den checksum Wert aus dieser Ausgabe in Ihrer API-Antwort, um sicherzustellen, dass das Plugin die Integrität des Bündels vor der Installation überprüfen kann.

Fortsetzen von Auto Update

Wenn Sie Auto Update zur Planung von Migrationen und Unternehmensoperationen verwenden, verbinden Sie es mit Auto Update zur Planung von Migrationen und Unternehmensoperationen Mit @capgo/capacitor-Updater für die native Fähigkeit in Mit @capgo/capacitor-Updater Capgo Enterprise für den Produktworkflow in Capgo Enterprise Ionic Enterprise Plugin Alternativen für den Produktworkflow in Ionic Enterprise Plugin Alternativen Capgo Alternativen für den Produktworkflow in Capgo Alternativen und Capgo Consulting für den Produktworkflow in Capgo Consulting