Benutzerdefinierte Speicherung
Ein Setup-Vorschlag mit den Installations-Schritten und der vollständigen Markdown-Anleitung für diesen Plugin kopieren.
Capgo unterstützt benutzerdefinierte Speichersysteme für Ihre App-Bundles, sodass Sie Ihre Updates auf Ihrem eigenen Infrastruktur oder auf Diensten Dritter speichern können. Dies ist insbesondere nützlich für Organisationen mit spezifischen Sicherheitsanforderungen, Compliance-Anforderungen oder bestehender Speichereinrichtungen.
Übersicht
Abschnitt mit dem Titel „Übersicht“Benutzerdefinierte Speicherung in Capgo funktioniert, indem Sie Ihr Bundle an einen externen Ort hochladen und Capgo die URL mitteilen, über die es erreicht werden kann. Der Capgo SDK wird dann die Updates direkt von Ihrem benutzerdefinierten Speicherort herunterladen, anstatt von Capgo’s Standard-Cloud-Speicher.
Externes URL-Upload
Sektion mit dem Titel “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
Sektion mit dem Titel “Grundlegender externes URL-Upload”npx @capgo/cli@latest bundle upload --external https://your-domain.com/bundles/v1.2.3.zipDiese Anweisung sagt Capgo, dass die Bundle an der angegebenen URL verwiesen werden soll, anstatt es in Capgo’s Cloud-Speicher hochzuladen.
With 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 eine integrierte Unterstützung für Amazon S3 und S3-kompatible Speicherdienste. 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-nameKomplette S3-Konfiguration
Sektion mit dem Titel “Komplette 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
Sektion mit dem Titel “S3-Konfigurationsparameter”| Parameter | Beschreibung | Pflichtfeld |
|---|---|---|
--s3-region | Region Ihres S3-Buckets bei AWS | Ja |
--s3-apikey | S3-Zugriffschlüssel-ID | Ja |
--s3-apisecret | Name Ihres S3-Buckets | Ja |
--s3-bucket-name | URL des benutzerdefinierten S3-Endpunkts | Ja |
--s3-endpoint | Benutzerdefinierte S3-Endpunkt-URL | No |
--s3-port | SSL für S3-Upload deaktivieren | No |
--no-s3-ssl | S3-Schlüssel für den Zugriff | No |
Vorbereitung und Verschlüsselung von Paketen
Abschnitt mit dem Titel “Vorbereitung und Verschlüsselung von Paketen”Bei der Verwendung von benutzerdefinierten Speicher, insbesondere mit Verschlüsselung, müssen Sie Ihre Pakete ordnungsgemäß vorbereiten. Dies umfasst die Erstellung eines Zip-Ordners und die optionalen Verschlüsselung.
Schritt 1: Erstellen Sie ein Zip-Paket
Abschnitt mit dem Titel “Schritt 1: Erstellen Sie ein Zip-Paket”Erstellen Sie zunächst einen Zip-Ordner Ihres Anwendungs-Paketes:
npx @capgo/cli@latest bundle zip com.example.app --path ./distThe zip command will return the checksum of the zip file. You can use this checksum to encrypt the zip file if needed. Use the --json Option zur Erstellung eines strukturierten Ausgabes mit Prüfsumme.
Zip Befehlsoptionen
Schritt 2: Verschlüsselung des Paketsnpx @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 | Weg zum Ordner zum Komprimieren (Standardwert: webDir aus capacitor.config) |
--bundle | Bundle Versionsnummer zur Namensgebung des Zip-Dateis |
--name | Benutzerdefinierter Dateinamen für das Zip |
--json | Eingabeergebnisse in JSON-Format (enthält Prüfsumme) |
--no-code-check | Überspringen der Überprüfung auf notifyAppReady()-Aufruf und Indexdatei |
--key-v2 | Verschlüsselung v2 verwenden |
--package-json | Pfade zu package.json-Dateien für monorepos (getrennt durch Komma) |
Schritt 2: Verschlüsseln des Bundles (Optional)
Schritt 2: Verschlüsseln Sie das Bundle (Optional)Für eine erhöhte Sicherheit verschlüsseln Sie Ihr Zip-Bundle vor dem Hochladen:
# 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 der Prüfsumme Ihres Zip-Dateis sein. Sie können die Prüfsumme aus dem Ausgabeoutput der zip-Kommando (verwenden Sie --json Option für strukturierte Ausgabe).
Mit der Standardkonfiguration wird der Verschlüsselungsbefehl Ihre lokale private Signierungsdatei verwenden. Sie können eine benutzerdefinierte Datei mithilfe der --key oder --key-data Alternativen
Der Verschlüsselungsbefehl wird den ivSessionKey Die Verschlüsselungskommando gibt die
Verschlüsselungskommandooptionen
Sektion mit dem Titel “Verschlüsselungskommandooptionen”| 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 | Ausgabeergebnisse in JSON-Format |
Vollständige Workflow Beispiele
Abschnitt mit dem Titel „Vollständige Workflow Beispiele“Beispiel 1: Externer URL mit Verschlüsselung
Abschnitt mit dem Titel „Beispiel 1: Externer URL mit Verschlüsselung“-
Dein App erstellen:
Terminalfenster npm run build -
Erstelle ein Zip-Bundle:
Terminalfenster npx @capgo/cli@latest bundle zip com.example.app --path ./dist --bundle 1.2.3Beachten Sie den bereitgestellten Prüfsummenwert.
-
Verschlüsseln Sie das Bundle:
Terminalfenster npx @capgo/cli@latest bundle encrypt ./com.example.app-1.2.3.zip CHECKSUM_FROM_STEP_2Beachten Sie den
ivSessionKeyaus der Ausgabe. -
Hochladen in Ihr Speicher: Hochladen Sie das verschlüsselte Zip-Datei in Ihr Hosting-Service.
-
Registrieren mit 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
Abschnitt mit dem Titel “Beispiel 2: Direkter S3-Upload”-
Deine App erstellen:
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”-
Erstelle und komprimiere:
Terminalfenster npm run buildnpx @capgo/cli@latest bundle zip com.example.app --path ./dist --key-v2 -
Verschlüsseln Sie das Bundle:
Terminalfenster npx @capgo/cli@latest bundle encrypt ./com.example.app.zip CHECKSUM -
Hochladen auf S3 mit Verschlüsselung:
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 \--iv-session-key IV_SESSION_KEY_FROM_STEP_2 \--channel Production
Sicherheitsüberlegungen
Abschnitt mit dem Titel „Sicherheitsüberlegungen“Wenn Sie benutzerdefinierte Speicher verwenden, sollten Sie diese Sicherheitshinweise beachten:
Zugriffssteuerung
Abschnitt mit dem Titel „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 webbasierte Anwendungen
Verschlüsselung
Abschnitt mit dem Titel „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-Anwendungen)
Überwachung
Abschnitt mit dem Titel „Überwachung“- Überwachen Sie Zugriffsprotokolle, um ungewöhnliche Herunterlademuster zu erkennen
- Set up alerts for failed bundle downloads
- Überprüfen Sie Ihre Speicherberechtigungen regelmäßig
Fehlerbehebung
Abschnitt mit der Überschrift „Fehlerbehebung“Häufige Probleme
Abschnitt mit der Überschrift „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-Kopfzeilen für Web-Anwendungen
- Ensure the bundle format is correct
Verschlüsselungsfehler:
- Prüfen Sie die
ivSessionKeyentspricht dem verschlüsselten Bundle - Überprüfen Sie, ob das Bundle mit der richtigen Schlüssel verschlüsselt wurde
- Ensure encryption v2 is used for new bundles
S3-Upload-Fehler:
- Überprüfen Sie Ihre S3-Zugriffsdaten und -berechtigungen
- Überprüfen Sie die Bucket-Politik und die CORS-Konfiguration
- Ensure the specified region is correct
Debug-Befehle
Abschnitt mit dem Titel „Debug-Befehle“Überprüfen Sie den Status des Pakets:
npx @capgo/cli@latest app debugÜberprüfen Sie die Integrität des Pakets:
npx @capgo/cli@latest bundle listNächste Schritte
Abschnitt: Nächste Schritte- Über Kanäle um verschiedene Bereitstellungsumgebungen zu verwalten
- Entdecken Updateverhalten um die Anwendung von Updates zu personalisieren
- Einstellen CI/CD-Integration um Ihre Custom Storage-Arbeit zu automatisieren
Weitermachen von Custom Storage
Abschnitt mit dem Titel “Weitermachen von Custom Storage”Wenn Sie Custom Storage verwenden Benutzerdefinierte Speicherung um Sicherheit und Compliance zu planen, verbinden Sie es mit Verschlüsselung für die Implementierungsdetails in Verschlüsselung Einhaltung für die Implementierungsdetails in Einhaltung Capgo Sicherheits-Scanner für den Produktworkflow in Capgo Sicherheits-Scanner Capgo Sicherheit zur Produktworkflow in Capgo Sicherheit und Capgo Vertrauenszentrum zur Produktworkflow in Capgo Vertrauenszentrum.