Benutzerdefinierte Speicherung
Einen Einrichtungsprompt mit den Installationsanweisungen und der vollständigen Markdown-Guideline für diesen Plugin kopieren.
Capgo unterstützt benutzerdefinierte Speichersysteme für Ihre App-Bundles, sodass Sie Ihre Updates auf Ihrer eigenen Infrastruktur oder auf Diensten von Drittanbietern hosten können. Dies ist insbesondere nützlich für Organisationen mit spezifischen Sicherheitsanforderungen, Compliance-Anforderungen oder bestehender Speichereinfrastruktur.
Übersicht
ÜbersichtDie Capgo-Speicherung funktioniert, indem Sie Ihr Bundle an eine externe Stelle hochladen und Capgo mit der URL versorgen, um es zu erreichen. Anschließend wird der Capgo SDK die Updates direkt aus Ihrer Capgo-Speicherung herunterladen, anstatt die Standard-Speicherung von Capgo zu verwenden.
Externer URL-Upload
ÜbersichtDie einfachste Möglichkeit, Capgo-Speicherung zu nutzen, besteht darin, Ihr Bundle an eine öffentlich zugängliche URL hochzuladen und diese URL an Capgo weiterzugeben.
Grundlegende externe URL-Hochladen
Abschnitt mit dem Titel „Grundlegende externe URL-Hochladen“npx @capgo/cli@latest bundle upload --external https://your-domain.com/bundles/v1.2.3.zipDiese Kommandozeilenanweisung sagt Capgo, anstatt das Bundle bei Capgo’s Cloudspeicher hochzuladen, soll sich auf das Bundle an der angegebenen URL beziehen.
Mit Verschlüsselung
Abschnitt mit dem Titel „Mit Verschlüsselung“Für sichere externe Speicherung können Sie Ihr 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_KEYS3-Integration
Abschnitt mit dem Titel „S3-Integration“Capgo bietet integrierte Unterstützung für Amazon S3 und S3-kompatible Speicherdienste. Der CLI kann Ihre Bundle automatisch auf S3 hochladen und Capgo konfigurieren, um die S3-URL zu verwenden.
S3-Upload-Optionen
Abschnitt mit dem Titel „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-nameVollständige S3-Konfiguration
Abschnitt mit dem Titel „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 SSLS3-Konfigurationsparameter
Abschnitt mit dem Titel „S3-Konfigurationsparameter“| Parameter | Beschreibung | Erforderlich |
|---|---|---|
--s3-region | AWS-Region für Ihren S3-Bucket | Ja |
--s3-apikey | S3-Zugriffschlüssel-ID | Ja |
--s3-apisecret | S3-Schlüssel | 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 | SSL für S3-Upload deaktivieren | Nein |
Vorbereitung und Verschlüsselung des Bundles
Abschnitt mit dem Titel „Vorbereitung und Verschlüsselung des Bundles“Wenn Sie eine benutzerdefinierte Speicherung verwenden, insbesondere mit Verschlüsselung, müssen Sie Ihre Bundles ordnungsgemäß vorbereiten. Dazu gehört die Erstellung eines Zip-Dateis und die optionalen Verschlüsselung.
Schritt 1: Erstellen Sie ein Zip-Bundle
Abschnitt mit dem Titel „Schritt 1: Erstellen Sie ein Zip-Bundle“Erstellen Sie zunächst eine Zip-Datei Ihres App-Bundles:
npx @capgo/cli@latest bundle zip com.example.app --path ./distDie Kommandozeile gibt den Prüfsumme des Zip-Dateis zurück. Sie können diese Prüfsumme verwenden, um das Zip-Datei zu verschlüsseln, wenn erforderlich. Verwenden Sie die --json Option, um eine strukturierte Ausgabe einschließlich der Prüfsumme zu erhalten.
Optionen für das Zip-Kommando
Abschnitt mit dem Titel “Optionen für das Zip-Kommando”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 (standardmäßig webDir aus capacitor.config) |
--bundle | Version des Bundles, um den Namen des Zip-Dateis zu bestimmen |
--name | Benutzerdefinierter Name für das Zip-Datei |
--json | Ergebnisse in JSON-Format (enthält Prüfsumme) |
--no-code-check | Überprüfung der 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)
Abschnitt mit dem Titel „Schritt 2: Verschlüsselung des Bundles (Optional)“Für eine erhöhte Sicherheit sollten Sie Ihr Zip-Bundle vor dem Hochladen verschlüsseln:
# Using default local keynpx @capgo/cli@latest bundle encrypt ./myapp.zip CHECKSUM
# Using custom key filenpx @capgo/cli@latest bundle encrypt ./myapp.zip CHECKSUM --key ./path/to/.capgo_key_v2
# Using key data directlynpx @capgo/cli@latest bundle encrypt ./myapp.zip CHECKSUM --key-data "PRIVATE_KEY_CONTENT"Der CHECKSUM Parameter ist erforderlich und sollte die Prüfsumme Ihres Zip-Dateis sein. Sie können die Prüfsumme aus der Ausgabe der zip-Kommando (mit --json Option für strukturierte Ausgabe verwenden
Standardmäßig wird die Verschlüsselungskommando die lokale private Signierungschlüssel verwenden. Sie können einen benutzerdefinierten Schlüssel mit der --key oder --key-data Alternativen
Die Verschlüsselungskommando wird die ivSessionKey erforderlich für den Upload oder die Entschlüsselung.
Verschlüsselungskommando Optionen
Sektion mit dem Titel “Verschlüsselungskommando Optionen”| Option | Beschreibung |
|---|---|
zipPath | Pfad zum zip-Datei zum Verschlüsseln (erforderlich) |
checksum | Prüfsumme der zip-Datei (erforderlich) - erhalten Sie sie mit dem zip-Kommando |
--key | Benutzerdefinierter Pfad für den privaten Signierungschlüssel (optional, verwendet lokalen Schlüssel standardmäßig) |
--key-data | Private Schlüsseldaten direkt (optional) verifizieren |
--json | Die Ergebnisse in JSON-Format ausgeben |
Beispiel 1: Außenliegende URL mit Verschlüsselung
Abschnitt mit dem Titel "Beispiel 1: Außenliegende URL mit Verschlüsselung"Ihre App erstellen:
Section titled “Example 1: External URL with Encryption”-
Build your app:
Terminalfenster npm run build -
Erstelle einen Zip-Bundle:
Terminalfenster npx @capgo/cli@latest bundle zip com.example.app --path ./dist --bundle 1.2.3Beachte den von diesem Befehl zurückgegebenen Prüfsummenwert.
-
Verschlüssle den Bundle:
Terminalfenster npx @capgo/cli@latest bundle encrypt ./com.example.app-1.2.3.zip CHECKSUM_FROM_STEP_2Beachte den
ivSessionKeyaus der Ausgabe. -
Hochladen in Ihr Speicher: Laden Sie das verschlüsselte Zip-Datei auf Ihrem Hosting-Dienst hoch.
-
Registrieren Sie sich bei Capgo:
Terminalfenster 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
Beispiel 2: Direkter S3-Upload-
Bauen Sie Ihre App:
Terminalfenster npm run build -
Direkt auf S3 hochladen:
Terminalfenster 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
Abschnitt mit dem Titel „Beispiel 3: S3 mit Verschlüsselung“-
Bauen und komprimieren:
Terminal-Fenster npm run buildnpx @capgo/cli@latest bundle zip com.example.app --path ./dist --key-v2 -
Das Bundle verschlüsseln:
Terminal-Fenster npx @capgo/cli@latest bundle encrypt ./com.example.app.zip CHECKSUM -
Mit Verschlüsselung auf S3 hochladen:
Terminal-Fenster 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
SicherheitsüberlegungenWenn Sie benutzerdefinierte Speicher verwenden, sollten Sie diese Sicherheitshinweise beachten:
Zugriffssteuerung
Sicherheitsüberlegungen: 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 die richtigen CORS-Header für Web-basierte Apps
Verschlüsselung
Sicherheitsüberlegungen: Verschlüsselung- Verschlüsseln Sie immer sensible Pakete mit den Capgo-Verschlüsselungstools
- Speichern Sie Verschlüsselungsschlüssel sicher und rotieren Sie sie regelmäßig
- Verwenden Sie HTTPS für alle Paket-URLs (erforderlich für mobile und Electron-Apps)
Überwachung
Abschnitt mit dem Titel “Überwachung”- Überwachung der Zugriffsprotokolle, um ungewöhnliche Herunterlademuster zu erkennen
- Einrichten von Warnungen für fehlgeschlagene Bundle-Downloads
- Regelmäßige Überprüfung Ihrer Speicherberechtigungen
Problembehandlung
Abschnitt mit dem Titel “Problembehandlung”Häufige Probleme
Abschnitt mit dem Titel “Häufige Probleme”Bundle wird nicht heruntergeladen:
- Überprüfen Sie, ob die URL öffentlich zugänglich und über HTTPS (für mobile und Electron-Anwendungen erforderlich) ist
- Überprüfen Sie die CORS-Header für Web-Anwendungen
- Stellen Sie sicher, dass die Bundle-Formatierung korrekt ist
Fehler bei der Verschlüsselung:
- Überprüfen Sie das
ivSessionKeyentspricht 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
Fehler bei der S3-Uploads:
- Überprüfen Sie Ihre S3-Zugriffsdaten und Berechtigungen
- Überprüfen Sie die Bucket-Politik und die CORS-Konfiguration
- Stellen Sie sicher, dass die angegebene Region korrekt ist
Debug-Befehle
Sektion mit dem Titel “Debug-Befehle”Bundle-Status überprüfen:
npx @capgo/cli@latest app debugIntegrität des Bundles überprüfen:
npx @capgo/cli@latest bundle listZukünftige Schritte
Abschnitt mit dem Titel 'Zukünftige Schritte'- Über Kanäle um verschiedene Bereitstellungsumgebungen zu verwalten
- Entdecken Aktualisierungsverhalten um die Anwendung von Updates anzupassen
- Einrichten CI/CD-Integration um Ihre Custom-Storage-Arbeit zu automatisieren
Weitermachen von Custom Storage
Wenn Sie Custom Storage verwendenCustom Storage für die Umsetzung in Encryption Encryption native_build_feature_ci_cd Custom Storage Zuverlässigkeit für die Implementierungsdetails in Zuverlässigkeit Capgo Sicherheits-Scanner für den Produktworkflow in Capgo Sicherheits-Scanner Capgo Sicherheit für den Produktworkflow in Capgo Sicherheit und Capgo Vertrauenszentrum für den Produktworkflow in Capgo Vertrauenszentrum.