Einstieg

Installation

npm

bun add @capgo/capacitor-updater
bunx cap sync

yarn

yarn add @capgo/capacitor-updater
bunx cap sync

pnpm

pnpm add @capgo/capacitor-updater
bunx cap sync

bun

bun add @capgo/capacitor-updater
bunx cap sync

Schnellstart

Für die meisten Benutzer empfehlen wir, sich anhand des Haupt-Schnellstartanleitungs zu orientieren, der sowohl die Plugin-Installation als auch Capgo die Cloudintegration abdeckt.

Diese Anleitung zur Einführung konzentriert sich auf die technischen Plugin-Details für fortgeschrittene Benutzer, die die zugrunde liegenden Mechanismen verstehen möchten oder selbst gehostete Updates implementieren möchten.

Übersicht

Der Capacitor-Updater-Plugin ermöglicht über das Internet (OTA) Updates für Ihre Capacitor-Anwendungen. Dies ermöglicht es Ihnen, Updates an Ihre App ohne die Überprüfung durch das App-Store zu pushen.

Wie es funktioniert

1. Bundle-DownloadDer Plugin herunterlädt Update-Bundles (ZIP-Dateien, die Ihre Web-Assets enthalten)
2. ExtraktionBundles werden auf das Gerätespeicher extrahiert
3. Hot-ReloadDie App wechselt zu dem neuen Bundle ohne eine Neustart zu erfordern
4. Fallback: Wenn ein Update fehlschlägt, kehrt die App zur vorherigen funktionierenden Version zurück

Verwendungsmöglichkeiten

1. Automatischer Update-Modus (Empfohlen)

Der einfachste Weg, das Plugin mit automatischer Update-Verwaltung zu verwenden:

import { CapacitorUpdater } from '@capgo/capacitor-updater';

// Plugin handles everything automatically
// Configure in capacitor.config.ts

Hinzufügen zu deinem capacitor.config.ts:

{
  plugins: {
    CapacitorUpdater: {
      autoUpdate: true,
      updateUrl: 'https://your-update-server.com/api/updates'
    }
  }
}

2. Manueller Modus

Für eine fortgeschrittene Kontrolle über den Update-Prozess:

import { CapacitorUpdater } from '@capgo/capacitor-updater';

// Download an update
const bundle = await CapacitorUpdater.download({
  url: 'https://your-server.com/updates/v1.0.1.zip',
  version: '1.0.1'
});

// Set the bundle (will be used on next app start)
await CapacitorUpdater.set({
  id: bundle.id
});

// Or reload immediately
await CapacitorUpdater.reload();

Plattform-Konfiguration

iOS

Keine weitere Konfiguration erforderlich. Der Plugin funktioniert direkt aus der Box.

Android

Keine weitere Konfiguration erforderlich. Der Plugin funktioniert direkt aus der Box.

Grundlegende API Verwendung

Download einer Aktualisierung

import { CapacitorUpdater } from '@capgo/capacitor-updater';

const bundle = await CapacitorUpdater.download({
  url: 'https://example.com/update.zip',
  version: '1.0.1'
});

console.log('Downloaded bundle:', bundle.id);

Aktives Bundle setzen

// Set bundle to be used on next app start
await CapacitorUpdater.set({
  id: bundle.id
});

Mit neuem Bundle neu laden

// Reload app immediately with new bundle
await CapacitorUpdater.reload();

Bundles auflisten

const { bundles } = await CapacitorUpdater.list();
console.log('Available bundles:', bundles);

Ein Bundle löschen

await CapacitorUpdater.delete({
  id: 'bundle-id'
});

Aktuelles Bundle abrufen

const { bundle } = await CapacitorUpdater.current();
console.log('Current bundle:', bundle.version);

Ereignis-Listener

Für Aktualisierungsereignisse abrufen:

import { CapacitorUpdater } from '@capgo/capacitor-updater';

// Listen for download progress
CapacitorUpdater.addListener('download', (info) => {
  console.log('Download progress:', info.percent);
});

// Listen for download completion
CapacitorUpdater.addListener('downloadComplete', (bundle) => {
  console.log('Download complete:', bundle.version);
});

// Listen for update failures
CapacitorUpdater.addListener('updateFailed', (error) => {
  console.error('Update failed:', error);
});

// Listen for successful updates
CapacitorUpdater.addListener('updateAvailable', (info) => {
  console.log('Update available:', info.version);
});

Konfigurationsoptionen

Konfigurieren Sie das Plugin in Ihrem capacitor.config.ts:

{
  plugins: {
    CapacitorUpdater: {
      // Auto-update settings
      autoUpdate: true,
      updateUrl: 'https://api.example.com/updates',

      // Update behavior
      resetWhenUpdate: true,
      directUpdate: false,

      // Version settings
      version: '1.0.0',

      // Security
      allowModifyUrl: false,

      // Stats collection
      statsUrl: 'https://api.example.com/stats',

      // Channel (for Capgo cloud)
      defaultChannel: 'production'
    }
  }
}

Integrationsschemata

Mit Capgo Cloud

Der einfachste Weg, loszulegen:

// Install the Capgo CLI
bun add -g @capgo/cli

// Login to Capgo
npx @capgo/cli login

// Upload your first bundle
npx @capgo/cli bundle upload

// The plugin auto-updates from Capgo cloud

Siehe den Haupt-Quickstart-Leitfaden für Details.

Selbstgehostete Updates

Ihr eigenen Update-Server hosten:

// Configure your update endpoint
{
  plugins: {
    CapacitorUpdater: {
      autoUpdate: true,
      updateUrl: 'https://your-server.com/api/check-update'
    }
  }
}

Ihr Server sollte folgendes zurückgeben:

{
  "version": "1.0.1",
  "url": "https://your-server.com/updates/1.0.1.zip"
}

Siehe Selbstgeführter Modus für weitere Details.

Manueller Update-Flow

Vollständige Kontrolle über Updates:

import { CapacitorUpdater } from '@capgo/capacitor-updater';

async function checkAndUpdate() {
  // Check for updates from your server
  const response = await fetch('https://api.example.com/check-update');
  const { version, url } = await response.json();

  // Download the update
  const bundle = await CapacitorUpdater.download({
    url,
    version
  });

  // Notify bundle is ready
  await CapacitorUpdater.notifyAppReady();

  // Set as next version
  await CapacitorUpdater.set({ id: bundle.id });

  // Reload when ready
  await CapacitorUpdater.reload();
}

Gute Praktiken

• Rufen Sie immer auf notifyAppReady() wenn Ihre App erfolgreich geladen wird
• Testen Sie Updates gründlich, bevor Sie sie in die Produktion puschen
• Implementieren Sie eine ordnungsgemäße Fehlerbehandlung für Netzwerkfehler
• Verwenden Sie Versionsnummern konsistent
• Halten Sie die Größe der Pakete klein, um die Herunterladegeschwindigkeit zu erhöhen
• Überwachen Sie die Erfolgsraten von Updates

Weitere Schritte

• Plugin API-Referenz - Fertigstellen Sie die API-Dokumentation
• Einstellungen für Plugins - Alle Konfigurationsoptionen
• Events - Verfügbare Aktualisierungsereignisse
• Eigenständiger Modus - Führen Sie Ihren eigenen Update-Server aus
• Lokale Entwicklung - Testen Sie Updates lokal
• Fehlersuche - Fehlersuchleitfaden

Support

• Known Issues - Gemeinsame Probleme und Lösungen
• GitHub Diskussionen - Gemeinschaftsunterstützung
• Discord - Echtzeit-Chat