Einstellungen

Um eine präzisere Kontrolle über das Update-System zu erhalten, kannst du es mit diesen Einstellungen konfigurieren:

Tipp

Änderungen an diesen Einstellungen in der capacitor.config erfordern ein Syncing der Plattform und ein Release im Store, damit Produktions-Apps diese erhalten.

Hinweis

Benötigst du EU-Data-Residency für Capgo Cloud? Wähle updateUrl zu https://plugin.eu.capgo.app/updates, statsUrl zu https://plugin.eu.capgo.app/stats, und channelUrl zu https://plugin.eu.capgo.app/channel_self. Siehe Datenstandort.

Um einen eigenen Hostnamen zu nutzen, updateUrl, statsUrl, und channelUrlsiehe Custom Domain Setup.

allowModifyUrl

Ermöglicht dem Plugin, updateUrl, statsUrl und channelUrl dynamisch über JavaScript zu ändern.

Verfügbar für Android, iOS und Electron.

Standard: false

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "allowModifyUrl": true
    }
  }
}

appId

Konfiguriere die App-ID für deine App in der Config.

Verfügbar für Android, iOS und Electron.

Standard: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "appId": "com.example.app"
    }
  }
}

appReadyTimeout

Lege fest, wie viele Millisekunden das native Plugin warten soll, bevor ein Update als „fehlgeschlagen“ gilt.

Verfügbar für Android, iOS und Electron.

Standard: 10000 (10 Sekunden)

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "appReadyTimeout": 1000
    }
  }
}

autoDeleteFailed

Konfiguriere, ob das Plugin fehlgeschlagene Bundles automatisch löschen soll.

Verfügbar für Android, iOS und Electron.

Standard: true

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "autoDeleteFailed": false
    }
  }
}

autoDeletePrevious

Konfiguriere, ob das Plugin nach einem erfolgreichen Update alte Bundles automatisch löschen soll.

Verfügbar für Android, iOS und Electron.

Standard: true

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "autoDeletePrevious": false
    }
  }
}

autoSplashscreen

Erforderlich bei Instant-Apply-Modi ("atInstall", "onLaunch", oder "always"), einschließlich der veralteten directUpdate Werte. Installiere @capacitor/splash-screen und setze launchAutoHide: false. Wenn aktiviert, blendet das Plugin den Splashscreen aus, sobald Updates angewendet wurden oder kein Update nötig ist. Dadurch entfällt das manuelle Abfangen von appReady-Events und der Aufruf von SplashScreen.hide().

Verfügbar für Android und iOS.

Standard: false

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "autoUpdate": "atInstall",
      "autoSplashscreen": true
    },
    "SplashScreen": {
      "launchAutoHide": false
    }
  }
}

autoUpdate

Konfiguriere, wie das Plugin nach Live Updates sucht, diese herunterlädt und anwendet. Das Plugin prüft auf Updates, wenn die App in den Vordergrund wechselt, sowie in regelmäßigen Abständen, solange die App geöffnet ist. periodCheckDelay steuert dieses Timer-Intervall. Boolean-Werte werden aus Gründen der Abwärtskompatibilität weiterhin unterstützt: true entspricht "atBackground" und false entspricht "off". String-Werte führen die vorherige Auto Update- und Direct Update-Konfiguration zusammen.

Optionen:

• "off" oder false: Automatische Update-Checks deaktivieren
• "atBackground" oder true: Bei jedem Foreground-Check automatisch prüfen und herunterladen, dann das Update beim nächsten Wechsel in den Hintergrund anwenden
• "atInstall": Wird nur direkt nach einer Neuinstallation oder einem Native App Store Update angewendet; ansonsten wird "atBackground" behavior
• "onLaunch": Wird nur angewendet, wenn die App aus einem beendeten Zustand in den Vordergrund geholt wird (Cold Start). Danach erfolgt der Fallback auf "atBackground" behavior
• "always": Bei jedem Wechsel in den Vordergrund prüfen und sofort anwenden, sobald ein Update verfügbar ist
• "onlyDownload": Automatisch prüfen und herunterladen, ausgeben updateAvailable, und niemals das nächste Bundle oder ein Update automatisch setzen

Instant-Apply-Modi ("atInstall", "onLaunch", "always") werden angewendet, während der Nutzer wartet. Upload mit npx @capgo/cli@latest bundle upload --delta , sodass nur geänderte Dateien heruntergeladen werden. Ein vollständiger ZIP-Upload verlangsamt die User Experience. Auf Android und iOS erfordern diese Modi autoSplashscreen: true und @capacitor/splash-screen mit launchAutoHide: false.

Verfügbar für Android, iOS und Electron.

Standard: "atBackground" (true wird weiterhin akzeptiert)

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "autoUpdate": "onlyDownload"
    }
  }
}

channelUrl

Konfiguriere die URL / den Endpoint für Channel-Operationen.

Verfügbar für Android, iOS und Electron.

Standard: https://plugin.capgo.app/channel_self

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "channelUrl": "https://example.com/api/channel"
    }
  }
}

defaultChannel

Setze den Standard-Channel für die App in der Config. Case-sensitive. Diese Einstellung überschreibt den in der Cloud gesetzten Standard-Channel, lässt aber Cloud-Overrides weiterhin gelten.

Verfügbar für Android, iOS und Electron.

Standard: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "defaultChannel": "production"
    }
  }
}

directUpdate

Veraltet. Nutze stattdessen autoUpdate statt String-Modi: "atInstall", "onLaunch", oder "always". This option remains supported for existing apps. Instant apply should be uploaded with --delta damit das Update die User Experience nicht verlangsamt. Diese Modi erfordern autoSplashscreen: true und @capacitor/splash-screen mit launchAutoHide: false.

Optionen:

• false: Führe niemals direkte Updates durch
• 'atInstall': Identisch mit autoUpdate: "atInstall"
• 'onLaunch': Identisch mit autoUpdate: "onLaunch"
• 'always': Identisch mit autoUpdate: "always"
• true: (veraltet) Identisch mit "always" zur Abwärtskompatibilität

Verfügbar für Android, iOS und Electron.

Standard: false

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "autoUpdate": "atInstall"
    }
  }
}

disableJSLogging

Deaktiviert das JavaScript-Logging des Plugins. Wenn true, schreibt das Plugin nichts in die JavaScript-Konsole. Es wird nur noch nativ geloggt.

Verfügbar für Android, iOS und Electron.

Standard: false

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "disableJSLogging": true
    }
  }
}

keepUrlPathAfterReload

Konfiguriert das Plugin so, dass der URL-Pfad nach einem Reload erhalten bleibt.

Achtung

Wenn ein Reload ausgelöst wird, wird ‘window.history’ geleert.

Verfügbar für Android, iOS und Electron.

Standard: false

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "keepUrlPathAfterReload": true
    }
  }
}

periodCheckDelay

Konfiguriert die Verzögerung für die periodische Update-Prüfung. Die Einheit ist in Sekunden. Darf nicht weniger als 600 Sekunden (10 Minuten) betragen.

Verfügbar für Android, iOS und Electron.

Standard: 600 (10 Minuten)

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "periodCheckDelay": 600 // (10 minutes)
    }
  }
}

publicKey

Konfiguriert den Public Key für die End-to-End live update Verschlüsselung Version 2.

Verfügbar für Android, iOS und Electron.

Standard: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "publicKey": "YOUR_PUBLIC_KEY"
    }
  }
}

Achtung

publicKey konfiguriert Encryption V2 und muss mit dem beim Upload verwendeten Private Key übereinstimmen. Nutze für Delta Updates V2-Verschlüsselung mit aktivierter Teilverschlüsselung. Aktiviere encrypted-bundle enforcement, falls deine Organisation bei jedem Upload Verschlüsselung vorschreibt. Verlasse dich nicht nur auf publicKey als serverseitige Policy, um die Veröffentlichung unverschlüsselter Delta Updates zu verhindern.

resetWhenUpdate

Löscht automatisch zuvor heruntergeladene Bundles, sobald ein neuerer Native App Bundle auf dem Gerät installiert wird.

Verfügbar für Android, iOS und Electron.

Standard: true

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "resetWhenUpdate": false
    }
  }
}

responseTimeout

Konfiguriere die Millisekunden, die das Native Plugin warten soll, bevor ein API Timeout ausgelöst wird.

Verfügbar für Android, iOS und Electron.

Standard: 20 (20 Sekunden)

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "responseTimeout": 10 // (10 seconds)
    }
  }
}

shakeMenu

Aktiviert die Shake-Geste, um das Update-Menü zum Debuggen oder Testen anzuzeigen.

Verfügbar für Android, iOS und Electron.

Standard: false

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "shakeMenu": true
    }
  }
}

statsUrl

Konfiguriere die URL / den Endpoint, an den Update-Statistiken gesendet werden.

Verfügbar für Android, iOS und Electron. Setze den Wert auf "", um das explizite Reporting über /stats.

Deaktivieren statsUrl deaktiviert nicht den gesamten Capgo Gerätespeicher. Wenn updateUrl aktiviert bleibt, /updates werden weiterhin die Abrechnungs-MAU-Zeile, das Device-Inventory und die Update-Decision-Event-Daten gespeichert, die für Updates und MAU-Zählungen nötig sind. Siehe Compliance für die detaillierte Aufschlüsselung der Felder.

Standard: https://plugin.capgo.app/stats

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "statsUrl": "https://example.com/api/stats"
    }
  }
}

updateUrl

Konfiguriere die URL / den Endpoint, an den Update-Checks gesendet werden.

Verfügbar für Android, iOS und Electron.

Standard: https://plugin.capgo.app/updates

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "updateUrl": "https://example.com/api/auto_update"
    }
  }
}

version

Konfiguriere die aktuelle Version der App. Diese wird für die erste Update-Anfrage verwendet. Falls nicht gesetzt, liest das Plugin die Version aus dem nativen code aus.

Verfügbar für Android, iOS und Electron.

Standard: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "version": "1.0.0"
    }
  }
}

Entwicklungseinstellungen

localApi

Konfiguriere CLI, um zum Testen eine lokale api zu nutzen.

Standard: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "localApi": "http://localhost:54321/functions/v1"
    }
  }
}

localApiFiles

Konfiguriere CLI, um zum Testen eine lokale Datei api zu nutzen.

Standard: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "localApiFiles": "http://localhost:54321/functions/v1/files"
    }
  }
}

localHost

Konfiguriere CLI, um für Tests einen lokalen Server oder einen selbst gehosteten Update-Server zu nutzen.

Standard: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "localHost": "http://localhost:5173"
    }
  }
}

localSupa

Konfiguriere CLI, um für Tests einen lokalen Server oder einen selbst gehosteten Update-Server zu nutzen.

Standard: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "localSupa": "http://localhost:54321"
    }
  }
}

localSupaAnon

Konfiguriere CLI, um für Tests einen lokalen Server zu nutzen.

Standard: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "localSupaAnon": "YOUR_LOCAL_ANON_KEY"
    }
  }
}

localWebHost

Konfiguriere CLI, um für Tests einen lokalen Server oder einen selbst gehosteten Update-Server zu nutzen.

Standard: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "localWebHost": "http://localhost:5173"
    }
  }
}

Tipp

Weitere Einstellungen sind verfügbar in den Capgo Web-App die pro Channel konfiguriert werden können, ohne dass ein neues Native Build erforderlich ist.

Weiter zu den Einstellungen

Wenn du es nutzt Einstellungen um Dashboard- und API-Operationen zu planen, verbinde es mit Verwendung von @capgo/capacitor-updater für die native Funktion in der Verwendung von @capgo/capacitor-updater, API Übersicht für Details zur Implementierung im API Overview, Einführung für die Implementierungsdetails in der Einleitung, API Schlüssel für das Implementierungsdetail in API Keys und Geräte für das Implementierungsdetail in Devices.