Einstellungen

Um eine feinere Kontrolle über das Update-System zu haben, können Sie es mit diesen Einstellungen konfigurieren:

Tip

Jede Änderung an diesen Einstellungen im capacitor.config-File erfordert die Synchronisierung der Plattform und die Freigabe im Store, damit Produktionsanwendungen sie erhalten.

Hinweis

Brauchen Sie EU-Datenspeicherung für Capgo Cloud? Setzen Sie 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 Data Location.

Um Ihren eigenen Hostnamen für updateUrl, statsUrl, und channelUrl, siehe Einstellungen für benutzerdefinierten Domänen.

allowModifyUrl

Erlauben Sie dem Plugin, die updateUrl, statsUrl und channelUrl dynamisch von der JavaScript-Seite zu ändern.

Verfügbar auf Android, iOS und Electron.

Standard: false

capacitor.config.json

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

appId

Konfigurieren Sie die App-ID für die App im Konfigurationsdatei.

Verfügbar auf Android, iOS und Electron.

Standard: undefined

capacitor.config.json

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

appReadyTimeout

Konfigurieren Sie die Anzahl der Millisekunden, die der native Plugin wartet, bevor eine Aktualisierung als ‘fehlgeschlagen’ betrachtet wird.

Verfügbar auf Android, iOS und Electron.

Standard: 10000 (10 Sekunden)

capacitor.config.json

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

autoDeleteFailed

Konfigurieren Sie, ob der Plugin automatisch fehlgeschlagene Pakete löschen soll.

Verfügbar auf Android, iOS und Electron.

Standard: true

capacitor.config.json

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

autoDeletePrevious

Konfigurieren Sie, ob der Plugin automatisch vorherige Pakete nach erfolgreicher Aktualisierung löschen soll.

Verfügbar auf Android, iOS und Electron.

Standard: true

capacitor.Konfigurationsdatei.json

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

autoSplashscreen

Erforderlich, wenn Instant-Apply-Modi verwendet werden ("atInstall", "onLaunch" oder "always"), einschließlich des veralteten directUpdate Installieren @capacitor/splash-screen und setzen launchAutoHide: false. Wenn aktiviert, versteckt das Plugin den Splashscreen nach Anwendung von Updates oder wenn kein Update erforderlich ist. Dies entfernt die Notwendigkeit, manuell auf appReady-Ereignisse zu lauschen und SplashScreen.hide() aufzurufen.

Verfügbar auf Android und iOS.

Standard: false

capacitor.config.json

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

autoUpdate

Konfigurieren Sie, wie das Plugin nach, herunterlädt und Live-Updates anwendet. Das Plugin überprüft Updates, wenn die App in den Vordergrund bewegt wird und auf einem wiederholten Timer, während die App geöffnet bleibt. periodCheckDelay steuert den Timer-Interval. Boolesche Werte werden für die Rückwärtskompatibilität noch unterstützt: true ist gleichbedeutend mit "atBackground" und false ist gleichbedeutend mit "off"Die String-Werte kombinieren die vorherigen Auto-Update- und Direkt-Update-Konfigurationen.

Optionen:

• "off" oder false: Aktualisierungsprüfungen deaktivieren
• "atBackground" oder true: Jedes Mal, wenn die Anwendung im Vordergrund ist, prüfen und herunterladen, und die Aktualisierung bei der nächsten Hintergrundübernahme anwenden
• "atInstall": Sofort nur nach einer frischen Installation oder einer nativen App-Store-Aktualisierung anwenden; andernfalls verwenden "atBackground" Verhalten
• "onLaunch": Sofort nur, wenn die Anwendung aus einem beendetem Zustand (kalter Start) in den Vordergrund gebracht wird. Nach dieser ersten Prüfung auf die "atBackground" Verhalten
• "always"Überprüfen Sie bei jeder Vordergrundübergabe und wenden Sie die Änderung sofort an, sobald ein Update verfügbar ist.
• "onlyDownload": Automatisch prüfen und herunterladen, ausgeben updateAvailable, und nie die nächste Bundle oder eine Aktualisierung automatisch setzen

Instant-Apply-Modi ("atInstall", "onLaunch", "always"Während der Wartezeit anwenden. Hochladen mit npx @capgo/cli@latest bundle upload --delta so laden nur geänderte Dateien herunter. Ein vollständiger Zip-Upload verlangsamt die Benutzererfahrung. Auf Android und iOS sind diese Modi erforderlich autoSplashscreen: true und @capacitor/splash-screen mit launchAutoHide: false.

Verfügbar auf Android, iOS und Electron.

Standard: "atBackground" (true ist immer noch akzeptiert)

capacitor.Konfigurationsdatei.json

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

channelUrl

Konfigurieren Sie die URL/Endpunkt für Kanaloperationen.

Verfügbar auf Android, iOS und Electron.

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

capacitor.Konfigurationsdatei.json

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

defaultChannel

Legen Sie die Standardkanal für die App im Konfigurationsdatei fest. Groß- und kleinschreibung beachten. Diese Einstellung überschreibt die im Cloud gesetzte Standardkanal, respektiert aber die im Cloud vorgenommenen Überschreibungen.

Verfügbar auf Android, iOS und Electron.

Standard: undefined

capacitor.Konfigurationsdatei.json

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

directUpdate

Veraltet. Verwenden Sie autoUpdate Zeichenmodi anstatt: "atInstall", "onLaunch"oder "always". Diese Option bleibt für bestehende Apps unterstützt. Instant apply sollte mit --delta so dass die Aktualisierung die Benutzererfahrung nicht verlangsamt. Diese Modi erfordern autoSplashscreen: true und @capacitor/splash-screen mit launchAutoHide: false.

Optionen:

• false: Mache keine direkten Updates
• 'atInstall': Ebenso wie autoUpdate: "atInstall"
• 'onLaunch': Ebenso wie autoUpdate: "onLaunch"
• 'always': Ebenso wie autoUpdate: "always"
• true: (veraltet) Ebenso wie "always" zurückliegende Kompatibilität

Verfügbar auf Android, iOS und Electron.

Standard: false

capacitor.Konfigurationsdatei.json

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

disableJSLogging

Deaktivieren Sie die JavaScript-Protokollierung des Plugins. Wenn wahr, wird das Plugin nicht im JavaScript-Konsolenprotokoll protokolliert. Nur das native Protokoll wird durchgeführt.

Verfügbar auf Android, iOS und Electron.

Standard: false

capacitor.Konfigurationsdatei.json

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

keepUrlPathAfterReload

Konfigurieren Sie das Plugin, um die URL-Pfad nach einem Neuladen beizubehalten.

Achtung

Wenn eine Neuladung ausgelöst wird, wird ‘window.history’ gelöscht.

Verfügbar auf Android, iOS und Electron.

Standard: false

capacitor.config.json

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

periodCheckDelay

Konfigurieren Sie die Verzögerungszeit für die Periode der Aktualisierungsprüfung. Die Einheit ist in Sekunden. Kann nicht kleiner als 600 Sekunden (10 Minuten) sein.

Verfügbar auf Android, iOS und Electron.

Standard: 600 (10 Minuten)

capacitor.config.json

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

publicKey

Konfigurieren Sie die öffentliche Schlüssel für Ende-zu-Ende-live update-Verschlüsselung Version 2.

Verfügbar auf Android, iOS und Electron.

Standard: undefined

capacitor.config.json

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

Vorsicht

publicKey Konfiguriert Verschlüsselung V2 und muss der private Schlüssel entsprechen, der während der Upload verwendet wird. Für Delta-Updates verwenden Sie V2-Verschlüsselung mit partieller Verschlüsselung aktiviert und aktivieren Sie die verschlüsselte-Bundle-Erzwisung, wenn Ihre Organisation verlangt, dass jeder Upload verschlüsselt ist. Verlassen Sie sich nicht allein auf publicKey nur als Serverseitig-Policy, die eine unverschlüsselte Delta-Version vor einer Veröffentlichung verhindert.

resetWhenUpdate

Automatisch löschen Sie die vorher heruntergeladenen Pakete, wenn ein neueres natives App-Paket auf das Gerät installiert wird.

Verfügbar auf Android, iOS und Electron.

Standard: true

capacitor.Konfigurationsdatei.json

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

responseTimeout

Konfigurieren Sie die Anzahl der Millisekunden, die der native Plugin wartet, bevor er API als Zeitüberschreitung betrachtet.

Verfügbar auf Android, iOS und Electron.

Standard: 20 (20 Sekunden)

capacitor.Konfigurationsdatei.json

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

shakeMenu

Aktivieren Sie die Erschütterungsgeste, um das Aktualisierungsmenü zum Debuggen/Überprüfen zu zeigen.

Verfügbar auf Android, iOS und Electron.

Standard: false

capacitor.Konfigurationsdatei.json

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

statsUrl

Konfigurieren Sie die URL/Endpunkt, an den Aktualisierungsstatistiken gesendet werden.

Verfügbar auf Android, iOS und Electron. Setzen Sie auf "" um explizite Statistikberichte über /stats.

Deaktivieren statsUrl Deaktiviert nicht alle Capgo-Gerätespeicher. Wenn updateUrl bleibt aktiviert, /updates speichert die Abrechnungs MAU Zeile, Geräteinventar und Update-Beschlussereignisdaten, die zum Bereitstellen von Updates und zur MAU-Zählung erforderlich sind. Siehe Zu Compliance für die Feldübersicht.

Standardmäßig: https://plugin.capgo.app/stats

capacitor.config.json

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

updateUrl

Konfigurieren Sie die URL / Endpunkt, an den Aktualisierungsprüfungen gesendet werden.

Verfügbar auf Android, iOS und Electron.

Standardmäßig: https://plugin.capgo.app/updates

capacitor.config.json

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

version

Konfigurieren Sie die aktuelle App-Version. Diese wird für den ersten Update-Antrag verwendet. Wenn nicht gesetzt, wird der Plugin die Version aus der native code abrufen.

Verfügbar auf Android, iOS und Electron.

Standard: undefined

capacitor.config.json

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

Einstellungen für die Entwicklung

localApi

Konfigurieren Sie die CLI für die Verwendung eines lokalen api für Tests.

Standard: undefined

capacitor.config.json

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

localApiFiles

Configure the CLI to use a local file api for testing.

Standard: undefined

capacitor.config.json

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

localHost

Konfigurieren Sie den CLI zur Verwendung eines lokalen Servers für die Testung oder Selbsthosting des Update-Servers.

Standard: undefined

capacitor.config.json

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

localSupa

Konfigurieren Sie den CLI für die Verwendung eines lokalen Servers zum Testen oder Selbsthosting eines Update-Servers.

Standard: undefined

capacitor.config.json

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

localSupaAnon

Konfigurieren Sie den CLI für die Verwendung eines lokalen Servers zum Testen.

Standard: undefined

capacitor.config.json

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

localWebHost

Konfigurieren Sie den CLI für die Verwendung eines lokalen Servers zum Testen oder Selbsthosting eines Update-Servers.

Standard: undefined

capacitor.config.json

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

Tip

Es gibt weitere Einstellungen im Capgo Web-App Ohne native App-Release kann diese Einstellung pro Kanal konfiguriert werden.

Abschnitt mit dem Titel 'Weitergehen von Einstellungen'

Einstellungen verwenden um das Dashboard und API-Operationen zu planen und zu verbinden Mit @capgo/capacitor-Updater zur nativen Fähigkeit in Mit @capgo/capacitor-Updater API-Übersicht zur Implementierungsdetail in API-Übersicht Einführung zur Implementierungsdetail in Einführung API-Schlüssel zur Implementierungsdetail in API-Schlüssel und Geräte zur Implementierungsdetail in Geräte