Benutzerdefinierte Speicherung
Eine Einrichtungsanweisung 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 Speichereinrichtungen.
Übersicht
ÜbersichtDie benutzerdefinierte Speicherung in Capgo funktioniert, indem Ihr Bundle an eine externe Stelle hochgeladen wird und Capgo mit der URL zur Verfügung gestellt wird, um es zu erreichen. Die Capgo SDK laden dann Updates direkt aus Ihrer benutzerdefinierten Speicherungsort statt aus Capgo's Standard-Cloud-Speicher herunter.
Externer URL-Upload
ÜbersichtDie einfachste Möglichkeit, benutzerdefinierte Speicherung zu verwenden, besteht darin, Ihr Bundle an jede öffentlich zugängliche URL hochzuladen und diese URL Capgo zur Verfügung zu stellen.
Einfache externe URL-Upload
Abschnitt mit dem Titel „Einfache externe URL-Upload“npx @capgo/cli@latest bundle upload --external https://your-domain.com/bundles/v1.2.3.zipDiese Kommando sagt Capgo, dass es sich an die im angegebenen URL befindliche Bundle anstatt an Capgo’s Cloudspeicher beziehen soll.
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. Die CLI kann Ihre Bundle automatisch auf S3 hochladen und Capgo konfigurieren, um die S3-URL zu verwenden.
S3-Upload-Optionen
Sektion 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
Sektion 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
Sektion 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 | No |
--s3-port | S3-Endpunkt-Port | No |
--no-s3-ssl | S3-Upload SSL deaktivieren | No |
Vorbereitung und Verschlüsselung des Bundles
Abschnitt: Vorbereitung und Verschlüsselung des BundlesBei der Verwendung von benutzerdefinierten Speicher, insbesondere mit Verschlüsselung, müssen Sie Ihre Bundles ordnungsgemäß vorbereiten. Dazu gehört die Erstellung eines Zip-Datei und gegebenenfalls deren Verschlüsselung.
Schritt 1: Erstellen Sie ein Zip-Bundle
Abschnitt: Schritt 1: Erstellen Sie ein Zip-BundleErstellen Sie zunächst eine Zip-Datei Ihres App-Bundles:
npx @capgo/cli@latest bundle zip com.example.app --path ./distDer Befehl "zip" 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 Option, um eine strukturierte Ausgabe einschließlich der Prüfsumme zu erhalten. --json Optionen für den Zip-Befehl
Abschnitt mit dem Titel "Optionen für den Zip-Befehl"
Terminal-Fensternpx @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| Beschreibung | Pfad zum Ordner, der komprimiert werden soll (Standardwert: webDir aus __CAPGO_KEEP_0__.config) |
|---|---|
--path | Path to the folder to zip (defaults to webDir from capacitor.config) |
--bundle | Benutzerdefinierter Name für das Zip-Datei |
--name | Copy to clipboard |
--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-Kommandozeile (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 mithilfe der --key oder --key-data erforderlich für den Upload oder die Entschlüsselung.
Verschlüsselungskommandooptionen ivSessionKey Sektion mit dem Titel „Verschlüsselungskommandooptionen“
Option
Beschreibung| Pfad zum zip-Datei zum Verschlüsseln (erforderlich) | Prüfsumme der zip-Datei (erforderlich) - erhalten Sie sie mit dem zip-Kommando |
|---|---|
zipPath | Benutzerdefinierter Pfad für den privaten Signierungschlüssel (optional, verwendet lokalen Schlüssel standardmäßig) |
checksum | oder |
--key | erforderlich für den Upload oder die Entschlüsselung. |
--key-data | Private Schlüsseldaten direkt (optional) verifizieren |
--json | Ausgabe in JSON-Format |
Abschnitt mit dem Titel "Vollständige Workflow-Beispiele"
Beispiel 1: Außenliegender URL mit VerschlüsselungAbschnitt mit dem Titel "Beispiel 1: Außenliegender URL mit Verschlüsselung"
Deine App erstellen:-
Deine App erstellen:
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-Service hoch.
-
Registrieren Sie sich bei Capgo:
Terminal-Fenster 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
Sektion mit dem Titel „Beispiel 2: Direkter S3-Upload“-
Bauen Sie Ihre App:
Terminal-Fenster npm run build -
Direkt 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 \--channel Production
Beispiel 3: S3 mit Verschlüsselung
Abschnitt mit dem Titel “Beispiel 3: S3 mit Verschlüsselung”-
Build und zip:
Terminalfenster npm run buildnpx @capgo/cli@latest bundle zip com.example.app --path ./dist --key-v2 -
Das Bundle verschlüsseln:
Terminalfenster npx @capgo/cli@latest bundle encrypt ./com.example.app.zip CHECKSUM -
Mit Verschlüsselung 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 \--iv-session-key IV_SESSION_KEY_FROM_STEP_2 \--channel Production
Sicherheitsüberlegungen
Abschnitt mit dem Titel “Sicherheitsüberlegungen”Wenn Sie benutzerdefinierte Speicher verwenden, beachten Sie diese Sicherheitstipps:
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 signierte URLs oder Token-basierte Authentifizierung, wenn möglich
- Implementieren Sie die richtigen CORS-Header für Web-basierte Apps
Verschlüsselung
Abschnitt mit dem Titel “Verschlüsselung”- Verschlüsseln Sie immer sensible Pakete mit den Capgo-Verschlüsselungstools
- Speichern Sie Verschlüsselungs-Schlü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 Herunterladepattern zu erkennen
- Konfigurieren Sie Benachrichtigungen für fehlgeschlagene Bundle-Downloads
- Regelmäßig Ihre Speicherberechtigungen überprüfen
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
Verschlüsselungsfehler:
- Überprüfen Sie das
ivSessionKeyentspricht dem verschlüsselten Bundle - Stellen Sie sicher, dass das Bundle mit der richtigen Schlüssel verschlüsselt wurde
- Stellen Sie sicher, dass Verschlüsselung v2 für neue Bundle verwendet wird
S3-Uploadfehler:
- Überprüfen Sie Ihre S3-Anmeldeinformationen 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 der Bundle ü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 Updateverhalten um die Anwendung von Updates anzupassen
- Einrichten CI/CD-Integration um Ihre Custom-Storage-Arbeit zu automatisieren
Fortsetzen von Custom Storage
Abschnitt: Fortsetzen von Custom StorageWenn Sie Custom Storage verwenden Custom Storage um Sicherheit und Compliance zu planen, verbinden Sie es mit Verschlüsselung zur Implementierungsdetail in Verschlüsselung, 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.