Benutzerdefinierte Speicherung

Capgo unterstützt benutzerdefinierte Speichersysteme für Ihre App-Bundles, sodass Sie Ihre Updates auf Ihrer eigenen Infrastruktur oder auf Diensten Dritter hosten können. Dies ist insbesondere nützlich für Organisationen mit spezifischen Sicherheitsanforderungen, Compliancebedürfnissen oder bestehender Speichereinrichtungen.

Übersicht

Benutzerdefinierte Speicherung in Capgo funktioniert, indem Sie Ihr Bundle an eine externe Stelle hochladen und Capgo die URL mitteilen, über die es abgerufen werden kann. Die Capgo SDK laden dann die Updates direkt aus Ihrer benutzerdefinierten Speicherort anstatt von Capgo’s Standard-Cloud-Speicher.

Tipps

Benutzerdefinierte Speicherung ist ideal für:

• Organisationen mit strengen Anforderungen an die Datenverteilung
• Teams mit bestehender CDN- oder Speicherinfrastruktur
• Anwendungen, die zusätzliche Sicherheitsschichten benötigen
• Kostenoptimierung für große Bundle-Größen

Externes URL-Upload

Die einfachste Möglichkeit, benutzerdefinierte Speicher zu verwenden, besteht darin, Ihr Bundle an jede öffentlich zugängliche URL hochzuladen und diese URL Capgo bereitzustellen.

Grundlegender externes URL-Upload

npx @capgo/cli@latest bundle upload --external https://your-domain.com/bundles/v1.2.3.zip

Mit diesem Befehl wird Capgo angewiesen, die Bundle an der angegebenen URL zu referenzieren und nicht auf Capgo’s Cloud-Speicher hochzuladen.

Mit Verschlüsselung

Für sichere externe Speicherung können Sie Ihren Bundle verschlüsseln und die Entschlüsselungsschlüssel bereitstellen:

npx @capgo/cli@latest bundle upload --external https://your-domain.com/bundles/v1.2.3.zip --iv-session-key YOUR_IV_SESSION_KEY

S3-Integration

Capgo bietet eine integrierte Unterstützung für Amazon S3 und S3-kompatible Speicherdienste. CLI kann Ihren Bundle automatisch auf S3 hochladen und Capgo konfigurieren, um die S3-URL zu verwenden.

S3-Upload-Optionen

npx @capgo/cli@latest bundle upload \
  --s3-region us-east-1 \
  --s3-apikey YOUR_ACCESS_KEY \
  --s3-apisecret YOUR_SECRET_KEY \
  --s3-bucket-name your-bucket-name

Vollständige S3-Konfiguration

Für S3-kompatible Dienste oder benutzerdefinierte Endpunkte:

npx @capgo/cli@latest bundle upload \
  --s3-region us-east-1 \
  --s3-apikey YOUR_ACCESS_KEY \
  --s3-apisecret YOUR_SECRET_KEY \
  --s3-endpoint https://s3.your-provider.com \
  --s3-bucket-name your-bucket-name \
  --s3-port 443 \
  --no-s3-ssl  # Only if your endpoint doesn't support SSL

S3-Konfigurationsparameter

Parameter	Beschreibung	Erforderlich
--s3-region	AWS-Region für Ihren S3-Bucket	Ja
--s3-apikey	S3-Zugriffsschlüssel-ID	Ja
--s3-apisecret	__CAPGO_KEEP_0__	Ja
--s3-bucket-name	Name Ihres S3-Buckets	Ja
--s3-endpoint	Benutzerdefinierter S3-Endpunkt-URL	Nein
--s3-port	Port für S3-Endpunkt	Nein
--no-s3-ssl	Deaktivieren Sie SSL für S3-Upload	Nein

Vorbereitung und Verschlüsselung von Bundeln

Wenn Sie benutzerdefinierte Speicher verwenden, insbesondere mit Verschlüsselung, müssen Sie Ihre Bundel ordnungsgemäß vorbereiten. Dazu gehört die Erstellung eines Zip-Dateis und gegebenenfalls deren Verschlüsselung.

Schritt 1: Erstellen Sie ein Zip-Bundle

Erstellen Sie zunächst ein Zip-Datei Ihres App-Bundles:

npx @capgo/cli@latest bundle zip com.example.app --path ./dist

Der Befehl zip gibt den Prüfsumme der Zip-Datei zurück. Sie können diese Prüfsumme verwenden, um die Zip-Datei zu verschlüsseln, wenn erforderlich. Verwenden Sie die Option, um eine strukturierte Ausgabe einschließlich der Prüfsumme zu erhalten. --json Optionen für den Befehl zip

Abschnitt mit dem Titel “Optionen für den Befehl zip”

npx @capgo/cli@latest bundle zip [appId] \
  --path ./dist \
  --bundle 1.2.3 \
  --name myapp-v1.2.3 \
  --json \
  --no-code-check \
  --key-v2 \
  --package-json ../../package.json,./package.json

Option	Beschreibung
--path	Pfad zum Ordner, der komprimiert werden soll (Standardwert: webDir aus capacitor.config)
--bundle	Bundelversionnummer zur Namensgebung des Zip-Dateis
--name	Benutzerdefinierter Name für das Zip-Datei
--json	Ergebnisse in JSON-Format ausgeben (enthält Prüfsumme)
--no-code-check	Überprüfung auf notifyAppReady()-Aufruf und Indexdatei auslassen
--key-v2	Verschlüsselung v2 verwenden
--package-json	Pfade zu package.json-Dateien für monorepos (getrennt durch Komma)

Schritt 2: Verschlüsselung des Bundles (Optional)

Für eine erhöhte Sicherheit, verschlüsseln Sie Ihr Zip-Bündel, bevor Sie es hochladen:

# Using default local key
npx @capgo/cli@latest bundle encrypt ./myapp.zip CHECKSUM

# Using custom key file
npx @capgo/cli@latest bundle encrypt ./myapp.zip CHECKSUM --key ./path/to/.capgo_key_v2

# Using key data directly
npx @capgo/cli@latest bundle encrypt ./myapp.zip CHECKSUM --key-data "PRIVATE_KEY_CONTENT"

Der CHECKSUM Parameter ist erforderlich und sollte der Prüfsumme Ihres Zip-Dateis sein. Sie können die Prüfsumme aus der Ausgabe des zip-Befehls (mit --json Option für strukturierte Ausgabe) erhalten.

Standardmäßig wird der Verschlüsselungsbefehl Ihre lokale private Signierungsdatei verwenden. Sie können eine benutzerdefinierte Datei mithilfe der --key oder --key-data Optionen angeben.

Der Verschlüsselungsbefehl gibt die ivSessionKey zurück, die für das Hochladen oder die Entschlüsselung erforderlich sind.

Verschlüsselungsbefehlsoptionen

Option	Beschreibung
zipPath	Pfad zum zip-Datei zum Verschlüsseln (erforderlich)
checksum	Prüfsumme der zip-Datei (erforderlich) - erhalten Sie sie mit dem zip-Befehl
--key	Benutzerdefinierter Pfad für die private Signierungsdatei (optional, verwendet lokale Datei standardmäßig)
--key-data	Private Signierungsdatei-Daten direkt (optional)
--json	Ergebnisse in JSON-Format ausgeben

Vorsicht

Das Verschlüsselungskommando wird ein ivSessionKey das Sie bei der Hochladen mit dem --iv-session-key Option.

Vollständiges Workflow-Beispiel

Beispiel 1: Aufruf einer externen URL mit Verschlüsselung

1. Deine App erstellen:

   npm run build

2. Eine Zip-Bundle erstellen:

   npx @capgo/cli@latest bundle zip com.example.app --path ./dist --bundle 1.2.3

   Beachte den von diesem Befehl zurückgegebenen Checksummenwert.

3. Das Bundle verschlüsseln:

   npx @capgo/cli@latest bundle encrypt ./com.example.app-1.2.3.zip CHECKSUM_FROM_STEP_2

   Beachten Sie ivSessionKey aus der Ausgabe.

4. Hochladen in Ihr Speicher: Das verschlüsselte Zip-Datei hochladen Sie in Ihr Hosting-Dienst.

5. Registrieren Sie sich bei Capgo:

   npx @capgo/cli@latest bundle upload \
     --external https://your-cdn.com/bundles/com.example.app-1.2.3.zip \
     --iv-session-key IV_SESSION_KEY_FROM_STEP_3

Beispiel 2: Direkter S3-Upload

1. Ihre App erstellen:

   npm run build

2. Direkt auf S3 hochladen:

   npx @capgo/cli@latest bundle upload \
     --s3-region us-west-2 \
     --s3-apikey YOUR_ACCESS_KEY \
     --s3-apisecret YOUR_SECRET_KEY \
     --s3-bucket-name your-app-bundles \
     --channel Production

Beispiel 3: S3 mit Verschlüsselung

1. Erstellen und zippen:

   npm run build
   npx @capgo/cli@latest bundle zip com.example.app --path ./dist --key-v2

2. Das Bundle verschlüsseln:

   npx @capgo/cli@latest bundle encrypt ./com.example.app.zip CHECKSUM

3. Mit Verschlüsselung hochladen:

   npx @capgo/cli@latest bundle upload \
     --s3-region us-west-2 \
     --s3-apikey YOUR_ACCESS_KEY \
     --s3-apisecret YOUR_SECRET_KEY \
     --s3-bucket-name your-app-bundles \
     --iv-session-key IV_SESSION_KEY_FROM_STEP_2 \
     --channel Production

Sicherheitsüberlegungen

Wenn Sie benutzerdefinierte Speicher verwenden, sollten Sie diese Sicherheitshinweise beachten:

Zugriffssteuerung

• Stellen Sie sicher, dass Ihre Speicher-URLs für Ihre App-Benutzer zugänglich sind, aber nicht öffentlich auffindbar sind
• Verwenden Sie bei Bedarf signierte URLs oder Token-basierte Authentifizierung
• Implementieren Sie korrekte CORS-Header für webbasierte Anwendungen

Verschlüsselung

• Verschlüsseln Sie immer sensible Bundles mit den Capgo-Verschlüsselungstools
• Speichern Sie Verschlüsselungsschlüssel sicher und rotieren Sie sie regelmäßig
• Verwenden Sie HTTPS für alle Bundle-URLs (erforderlich für mobile und Electron-Anwendungen)

Überwachung

• Überwachen Sie Zugriffsprotokolle, um ungewöhnliche Downloadmuster zu erkennen
• Konfigurieren Sie Benachrichtigungen für fehlgeschlagene Bundle-Downloads
• Überprüfen Sie regelmäßig Ihre Speicherberechtigungen

Fehlersuche

Häufige Probleme

Bundle wird nicht heruntergeladen:

• Stellen Sie sicher, dass die URL öffentlich zugänglich und über HTTPS (erforderlich für mobile und Electron-Anwendungen) ist
• Überprüfen Sie die CORS-Kopfzeilen für Web-Anwendungen
• Stellen Sie sicher, dass die Bundle-Formatierung korrekt ist

Verschlüsselungsfehler:

• Stellen Sie sicher, dass die ivSessionKey entspricht dem verschlüsselten Bundle
• Überprüfen Sie, ob das Bundle mit der richtigen Schlüssel verschlüsselt wurde
• Stellen Sie sicher, dass Verschlüsselung v2 für neue Bundle verwendet wird

S3-Upload-Fehler:

• Überprüfen Sie Ihre S3-Zugriffsberechtigungen und -berechtigungen
• Überprüfen Sie die Bucket-Politik und die CORS-Konfiguration
• Stellen Sie sicher, dass die angegebene Region korrekt ist

Debug-Befehle

Überprüfen Sie den Status des Bundles:

npx @capgo/cli@latest app debug

Überprüfen Sie die Integrität des Bundles:

npx @capgo/cli@latest bundle list

Weitere Schritte

• Erfahren Sie mehr über Kanäle um verschiedene Bereitstellungsumgebungen zu verwalten
• Erkunden Sie Aktualisierungsverhalten um die Anwendung von Aktualisierungen anzupassen
• Konfigurieren Sie CI/CD-Integration um Ihre benutzerdefinierte Speicherablaufverwaltung zu automatisieren