Installer une extension Firebase

Vous pouvez installer (et gérer ) n'importe laquelle des extensions Firebase officielles à l'aide de la console Firebase ou de la CLI Firebase (interface de ligne de commande).

Assurez-vous de passer en revue les différences entre les actions prises en charge pour la CLI Firebase et la console Firebase.


Pour installer ou gérer des extensions, l'un de ces rôles doit vous être attribué : Propriétaire ou Éditeur ou Administrateur Firebase .

Pour installer une extension, votre projet doit être sur le plan Blaze (pay as you go). Bien qu'il n'y ait pas de frais pour l'installation d'une extension, vous pouvez être facturé pour votre utilisation des services Firebase ou des services Cloud tels que [Cloud Secret Manager][secret-pricing], si votre utilisation dépasse le niveau gratuit des services.

Avant que tu commences

  1. Si vous ne l'avez pas déjà fait, ajoutez Firebase à votre projet .

  2. Si vous ne l'avez pas déjà fait, mettez à niveau votre projet vers le plan Blaze (pay as you go).

  3. Installez ou mettez à jour la dernière version de la CLI Firebase.

  4. Prenez note de votre ID de projet Firebase ou de l'alias de projet précédemment configuré.

    • ID de projet - Exécutez firebase projects:list depuis n'importe où sur votre ordinateur.
    • Alias ​​de projet - Exécutez firebase use à partir de votre répertoire d'application local.

Étape 1 : Afficher des informations détaillées sur une extension

Cette étape est facultative, mais fortement recommandée.

Avant d'installer une extension Firebase, nous vous recommandons de consulter les informations détaillées sur l'extension, notamment :

  • Fonctionnement de l'extension, tâches de pré-installation et détails sur l'extension
  • Informations d'identification générales et description
  • Si les tâches de l'extension nécessitent un compte de facturation
  • Services Google (API) et rôles d'accès requis pour le fonctionnement
  • Ressources créées pour l'extension (comme les fonctions)
  • Descriptions des paramètres configurables par l'utilisateur

Pour afficher les informations détaillées d'une extension :

  1. Assurez-vous d'avoir configuré votre environnement et sélectionné une extension .

  2. Exécutez la commande extension-info depuis n'importe où sur votre ordinateur :

    firebase ext:info publisher-id/extension-id

    Les arguments publisher-id et extension-id sont obligatoires et se trouvent sur la page des détails de préinstallation de l'extension .

Etape 2 : Installer une extension

Au cours du processus d'installation, vous serez invité à passer en revue les spécifications de base de l'extension (telles que les API activées, les ressources créées, l'accès accordé, etc.). Vous serez informé de toute exigence de facturation et vous serez également invité à spécifier des valeurs pour les paramètres configurables de l'extension.

  1. Assurez-vous d'avoir configuré votre environnement et sélectionné une extension .

  2. Exécutez la commande extension-install. Si vous y êtes invité, entrez les valeurs des paramètres pour personnaliser l'instance d'extension.

    firebase ext:install publisher-id/extension-id --project=projectId-or-alias

    Les arguments publisher-id et extension-id sont obligatoires et se trouvent sur la page des détails de préinstallation de l'extension .

Étape 3 : Terminez la configuration post-installation

Certaines extensions ont des étapes obligatoires ou facultatives que vous devez suivre avant de les utiliser. Retrouvez ces instructions sur la page des détails post-installation de votre extension dans le tableau de bord Extensions de la console Firebase (le lien spécifique vers le tableau de bord s'affiche dans le terminal après l'installation).

Vous pouvez également trouver ces instructions dans le fichier POSTINSTALL.md inclus dans le répertoire source de l'extension .

Créer des ressources Firebase

Si vous avez configuré l'extension pour utiliser des ressources Firebase (collections Cloud Firestore, chemins d'accès à la base de données en temps réel, buckets Cloud Storage) qui n'existent pas déjà, créez-les avant d'utiliser l'extension.

Créer des gestionnaires d'événements Eventarc

Certaines extensions publient sur Eventarc lorsque des événements importants se produisent pendant l'exécution. Si une extension publie des événements et que vous avez activé les événements lors de l'installation, vous pouvez écrire des fonctions qui réagissent à ces événements avec votre propre logique personnalisée. Cela peut être utile, par exemple, pour avertir les utilisateurs lorsque des tâches de longue durée sont terminées ou pour post-traiter la sortie d'une fonction d'extension.

Consultez la documentation de l'extension pour une liste des événements (le cas échéant) qu'elle publie.

Ensuite, consultez Déclencheurs d'événements personnalisés pour plus d'informations sur l'écriture des gestionnaires d'événements Eventarc.

Installer plusieurs instances d'extension

Vous pouvez installer plusieurs fois la même extension dans le même projet. Chaque instance installée peut avoir sa propre configuration personnalisée et ses propres ressources d'extension. Vous identifiez et faites référence à chaque instance installée à l'aide de son ID d'instance , qui est unique au sein de votre projet. Vous serez invité à confirmer ou à modifier l'ID d'instance de chaque instance supplémentaire de l'extension que vous installez.

Prochaines étapes

  • Affichez les détails et la configuration de votre extension installée dans la console Firebase.

  • Surveillez l'activité de votre extension installée, y compris les vérifications de sa santé, de son utilisation et de ses journaux.

  • À l'aide de la CLI Firebase, gérez votre extension installée. Vous pouvez reconfigurer ou désinstaller votre extension, ainsi que mettre à jour votre extension vers la dernière version.

  • À l'aide de la console Firebase, gérez votre extension installée. Pour les extensions Firebase officielles, vous pouvez reconfigurer ou désinstaller votre extension, ainsi que mettre à jour votre extension vers la dernière version.

  • Comme bonne pratique pour tous les projets, assurez-vous de configurer des alertes budgétaires pour votre projet et de surveiller votre tableau de bord d' utilisation et de facturation dans la console Firebase.