Zum Inhalt springen

Auto-Update

GitHub

Diese Dokumentation erklärt, wie du deinen Auto-Update-Server betreibst.

Stelle sicher, dass dein Bundle über HTTPS bereitgestellt wird und der Server die richtigen CORS-Header hat, damit die App das Update herunterladen kann. Beispiel: https://myserver.com/app/updates/updates.json

Falls dir das Serven eines Bundles unbekannt ist, empfehlen wir, Capgo Cloud zu testen oder ein Beispiel hier zu sehen:

Füge ein updateUrl in deine capacitor.config.json.

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

Das Plugin führt jedes Mal, wenn die App geöffnet wird, einen POST-Call an dein API mit diesem Body aus:

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 dem capacitor-updater-Plugin in JSON antworten. Mit diesen Daten, falls ein Update erforderlich ist:

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

Im Auto-update-Modus sollte der Server die Versionen vergleichen und die richtige zurückgeben. Wenn der URL-Schlüssel vorhanden ist, startet das Plugin den Download-Prozess.

Wenn du die Schlüssel „message“ und „error“ hinzufügst, wird die Version nicht gesetzt, und die Nachricht wird stattdessen in den Logs angezeigt.

version Der Schlüssel sollte in semver Format folgen.

Die Zip-Datei sollte index.html als Datei im Root-Verzeichnis, oder nur einen Ordner im Root-Verzeichnis mit index.html darin.

Du kannst den Befehl von CLI verwenden, um dein Bundle zu zippen:

Erstelle ein Bundle mit deinen Dateien, um sie von deinem Server aus bereitzustellen
npx @capgo/cli bundle zip --path [/path/to/my/bundle]

Wichtig: Sie müssen das Capgo CLI verwenden, um Ihre Bundle-Zip-Datei zu erstellen. Das Capgo-Plugin erfordert ein bestimmtes Zip-Format und eine bestimmte Struktur, die nur bei Verwendung des offiziellen CLI-Tools garantiert ist. Standard-Zip-Tools können inkompatible Archive erstellen.

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

Bundle mit Prüfsummeninformationen erstellen
npx @capgo/cli bundle zip [appId] --json

Dieser Befehl wird:

  • Eine korrekt formatierte Zip-Datei erstellen, die mit dem Capgo-Plugin kompatibel ist
  • Die SHA256-Prüfsumme für die Integritätsprüfung generieren
  • Bundle-Informationen im JSON-Format ausgeben

Beispielausgabe:

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

Nutze das checksum Wert aus dieser Ausgabe in Ihre API-Antwort einfügen, damit das Plugin die Integrität des Bundles vor der Installation überprüfen kann.

Wenn du es nutzt Auto-Update um Migration und Enterprise-Betrieb zu planen, verbinde es mit Verwendung von @capgo/capacitor-updater für die native Funktion in der Verwendung von @capgo/capacitor-updater, Capgo Enterprise für den Produkt-Workflow in Capgo Enterprise, Ionic Enterprise Plugin-Alternativen für den Produkt-Workflow in Ionic Enterprise Plugin-Alternativen, Capgo Alternativen für den Produkt-Workflow in Capgo Alternativen, und Capgo Beratung für den Produkt-Workflow in Capgo Consulting.