Stockage personnalisé
Copiez un prompt de configuration avec les étapes d'installation et le guide Markdown complet pour ce plugin.
Capgo prend en charge les solutions de stockage personnalisées pour vos ensembles de l'application, vous permettant de héberger vos mises à jour sur votre propre infrastructure ou sur des services de stockage tiers. Cela est particulièrement utile pour les organisations ayant des exigences de sécurité spécifiques, des besoins de conformité ou une infrastructure de stockage existante.
Vue d'ensemble
Titre de la section « Vue d'ensemble »Le stockage personnalisé dans Capgo fonctionne en téléchargeant votre ensemble sur un emplacement externe et en fournissant à Capgo l'URL pour y accéder. Les Capgo SDK téléchargeront ensuite les mises à jour directement de votre emplacement de stockage personnalisé au lieu de l'infrastructure de stockage par défaut de Capgo.
Téléchargement de URL externe
Section intitulée “Téléchargement de URL externe”La manière la plus simple d'utiliser un stockage personnalisé est d'uploader votre paquet sur n'importe quelle URL accessible au public et de fournir cette URL à Capgo.
Téléchargement de URL externe de base
Section intitulée “Téléchargement de URL externe de base”npx @capgo/cli@latest bundle upload --external https://your-domain.com/bundles/v1.2.3.zipCette commande indique à Capgo de référencer le paquet à l'URL spécifiée au lieu de l'uploader dans le stockage cloud de Capgo.
Avec Chiffrement
Section intitulée “Avec Chiffrement”Pour un stockage externe sécurisé, vous pouvez chiffrer votre bundle et fournir les clés de déchiffrement :
npx @capgo/cli@latest bundle upload --external https://your-domain.com/bundles/v1.2.3.zip --iv-session-key YOUR_IV_SESSION_KEYIntégration S3
Section intitulée “Intégration S3”Capgo fournit un support intégré pour Amazon S3 et les services de stockage S3 compatibles. Le CLI peut télécharger automatiquement votre bundle sur S3 et configurer Capgo pour utiliser l'URL S3.
Options d'envoi vers S3
Section intitulée “Options d'envoi vers S3”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-nameConfiguration S3 complète
Section intitulée « Configuration S3 complète »Pour les services S3 compatibles ou les points de terminaison personnalisés :
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 SSLParamètres de la configuration S3
Section intitulée « Paramètres de la configuration S3 »| Paramètre | Description | Obligatoire |
|---|---|---|
--s3-region | Région AWS pour votre bac S3 | Oui |
--s3-apikey | __CAPGO_KEEP_0__ ID de clé d'accès S3 | Oui |
--s3-apisecret | __CAPGO_KEEP_1__ secret d'accès S3 | Oui |
--s3-bucket-name | __CAPGO_KEEP_2__ Nom de votre bac S3 | Oui |
--s3-endpoint | __CAPGO_KEEP_3__ URL de l'endpoint S3 personnalisé | Non |
--s3-port | __CAPGO_KEEP_4__ Port de l'endpoint S3 | Non |
--no-s3-ssl | __CAPGO_KEEP_5__ Désactiver SSL pour l'upload S3 | Non |
Préparation et Chiffrement du Bundle
Section intitulée “Préparation et Chiffrement du Bundle”Lorsque vous utilisez un stockage personnalisé, en particulier avec le chiffrement, vous devez préparer vos bundles correctement. Cela implique la création d'un fichier zip et le chiffrement facultatif.
Étape 1 : Créer un Bundle Zip
Section intitulée “Étape 1 : Créer un Bundle Zip”Créez d'abord un fichier zip de votre bundle d'application :
npx @capgo/cli@latest bundle zip com.example.app --path ./distLa commande zip retournera le checksum du fichier zip. Vous pouvez utiliser ce checksum pour chiffrer le fichier zip si nécessaire. Utilisez l'option pour obtenir un résultat structuré incluant le checksum. --json Options de la commande Zip
Section intitulée “Options de la commande Zip”
__CAPGO_KEEP_0__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 | Description |
|---|---|
--path | Chemin du dossier à zipper (par défaut webDir de capacitor.config) |
--bundle | Numéro de version du bundle pour nommer le fichier zip |
--name | Nom personnalisé pour le fichier zip |
--json | Résultats d'output en format JSON (inclut le checksum) |
--no-code-check | Ignorer la vérification de la fonction notifyAppReady() et du fichier index |
--key-v2 | Utiliser l'encryption v2 |
--package-json | Chemins des fichiers package.json pour les monorepos (séparés par des virgules) |
Étape 2 : Chiffrer le Bundle (Optionnel)
Étape 2 : Chiffrer le Bundle (Facultatif)Pour une sécurité renforcée, chiffrer votre bundle zip avant de l'uploader :
# 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"Le CHECKSUM ce paramètre est obligatoire et doit être le checksum de votre fichier zip. Vous pouvez obtenir le checksum à partir de la commande zip (utilisez --json option pour un affichage structuré).
Par défaut, la commande de chiffrement utilisera votre clé privée de signature locale. Vous pouvez spécifier une clé personnalisée en utilisant les --key ou --key-data options.
La commande de chiffrement retournera les ivSessionKey nécessaires pour l'upload ou la déchiffrement.
Options de commande d'encryption
Section intitulée “Options de commande d'encryption”| Option | Description |
|---|---|
zipPath | Chemin du fichier zip à chiffrer (obligatoire) |
checksum | Checksum du fichier zip (obligatoire) - obtenez-le à partir de la commande zip |
--key | Chemin personnalisé pour la clé de signature privée (facultatif, utilise la clé locale par défaut) |
--key-data | Données de la clé de signature privée directement (facultatif) |
--json | Afficher les résultats sous forme de JSON |
Exemples complets de workflow
Section intitulée “Exemples complets de workflow”Exemple 1 : URL externe avec encryption
Section intitulée “Exemple 1 : URL externe avec encryption”-
Construire votre application :
Fenêtre de terminal npm run build -
Créer un bundle zip :
Fenêtre de terminal npx @capgo/cli@latest bundle zip com.example.app --path ./dist --bundle 1.2.3Notez le checksum retourné par cette commande.
-
Chiffrer le bundle :
Fenêtre de terminal npx @capgo/cli@latest bundle encrypt ./com.example.app-1.2.3.zip CHECKSUM_FROM_STEP_2Notez le
ivSessionKeyà partir de l'output. -
Télécharger sur votre stockage : Télécharger le fichier zip chiffré sur votre service de hébergement.
-
S'inscrire avec Capgo:
Fenêtre de terminal 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
Exemple 2 : Téléchargement direct S3
Section intitulée « Exemple 2 : Téléchargement direct S3 »-
Construire votre application :
Fenêtre de terminal npm run build -
Télécharger directement sur S3 :
Fenêtre de terminal 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
Exemple 3 : S3 avec chiffrement
Section intitulée « Exemple 3 : S3 avec chiffrement »-
Construire et compresser :
Fenêtre de terminal npm run buildnpx @capgo/cli@latest bundle zip com.example.app --path ./dist --key-v2 -
Chiffrer le bundle :
Fenêtre de terminal npx @capgo/cli@latest bundle encrypt ./com.example.app.zip CHECKSUM -
Charger sur S3 avec chiffrage :
Fenêtre de terminal 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
Considérations de sécurité
Section intitulée « Considérations de sécurité »Lorsque vous utilisez un stockage personnalisé, considérez ces bonnes pratiques de sécurité :
Contrôle d'accès
Section intitulée « Contrôle d'accès »- Assurez-vous que vos URL de stockage soient accessibles à vos utilisateurs d'application mais pas découvrables publiquement
- Utilisez les URL signées ou l'authentification basée sur des jetons lorsque cela est possible
- Implémentez les en-têtes CORS appropriés pour les applications web
Chiffrement
Section intitulée « Chiffrement »- Chiffrez toujours les bundles sensibles à l'aide des outils de chiffrement Capgo
- Stockez les clés de chiffrement de manière sécurisée et les renouvelez régulièrement
- Utilisez HTTPS pour toutes les URL des bundles (obligatoire pour les applications mobiles et Electron)
Surveillance
Section intitulée « Surveillance »- Surveillez les journaux d'accès pour détecter les modèles de téléchargement inhabituels
- Configurez des alertes pour les téléchargements de bundles échoués
- Auditez régulièrement vos permissions de stockage
Résolution des problèmes
Section intitulée “Résolution des problèmes”Problèmes courants
Section intitulée “Problèmes courants”Le bundle ne télécharge pas :
- Vérifiez que l'URL est accessible au public et utilise HTTPS (obligatoire pour les applications mobiles et Electron)
- Vérifiez les en-têtes CORS pour les applications web
- Assurez-vous que le format du bundle est correct
Erreurs de chiffrement :
- Vérifiez que le
ivSessionKeycorrespond au bundle chiffré - Vérifiez que le bundle a été chiffré avec la bonne clé
- Utilisez l'encryption v2 pour les nouveaux ensembles
Échecs d'upload S3 :
- Vérifiez vos identifiants et vos autorisations S3
- Vérifiez les politiques de la boîte et la configuration CORS
- Assurez-vous que la région spécifiée est correcte
Commandes de débogage
Section intitulée “Commandes de débogage”Vérifiez l'état de l'ensemble :
npx @capgo/cli@latest app debugVérifiez l'intégrité de l'ensemble :
npx @capgo/cli@latest bundle listÉtapes suivantes
Section intitulée « Étapes suivantes »- En savoir plus sur Canaux pour gérer différents environnements de déploiement
- Explorer Mise à jour du comportement pour personnaliser la façon dont les mises à jour sont appliquées
- Configurer Intégration CI/CD pour automatiser votre flux de travail de stockage personnalisé