You can install (andmanage) anyof the officialFirebase extensions using either theFirebase console,theFirebase CLI (command-line interface), or using anautogenerated SDK.

Make sure to review thedifferences in thesupported actions for each installation method.

To try out aFirebase Extension for the first time, we recommend that you install the extension in a test or development project.

To install or manage extensions, you must be assigned one of these roles:Owner or Editor orFirebase Admin.

To install an extension, your project must be on theBlaze (pay as yougo) plan. Although there is no charge for installing an extension, you might becharged for your use of Firebase services or Cloud services such asCloud Secret Manager, if your usage exceeds the services' freetier.

Before you begin

If you haven't already,add Firebase to your project and upgradeyour Firebase project to theBlaze (pay as you go) plan.

Step 1: View detailed information about an extension

This step is optional, but strongly recommended.

Before installing aFirebase Extension, we recommend that youreview detailed information about the extension, including:

• How the extension works, any pre-installation tasks, and details about theextension
• General identifying information and description
• Whether the extension's tasks require a billing account
• Google services (APIs) andaccess roles required foroperation
• Resources createdfor the extension (like functions)
• Descriptions of user-configurable parameters

To view an extension's detailed information:

1. Browse officialFirebase extensions in theExtensions Hub.

2. Click an extension's card to:

   • Display the detailed information for the extension.

   • Find the link to the extension's source code in theFirebase Extensions source repository.

     In the extension'sextension directory,you can view this detailed information in theREADME.

Step 2: Install an extension

During the installation process, you'll be prompted to review the basicspecifications for the extension (such as APIs enabled,resources created,access granted, etc.).You'll be notified of any billing requirements, and you'll also be prompted tospecify values for the extension's configurable parameters.

1. Browse officialFirebase extensions in theExtensions Hub.

2. Click an extension's card, then review the detailed information for theextension, which can offer specific usage instructions and anypre-installation tasks.

3. ClickInstall, then follow the on-screen instructions to installthe extension.

   Note: Deploying and provisioning an extension may take the system 3-5minutes.

Step 3: Complete post-install setup

Some extensions have required or optional steps for you to complete before usingthem. Find these instructions in your extension's post-install details page intheExtensions dashboard of theFirebase console (the specific link tothe dashboard is displayed in the terminal after installation).

You can also find these instructions in thePOSTINSTALL.md file included intheextension's source directory.

Create Firebase resources

If you configured the extension to use Firebase resources (Cloud Firestorecollections,Realtime Database paths,Cloud Storage buckets) that don't already exist,create them before using the extension.

Create Eventarc event handlers

Some extensions publish toEventarc when important events happen during execution. If an extension publishes events,and you enabled events during installation, you can write functions that reactto these events with your own custom logic. This can be useful, for example, tonotify users when long-running tasks complete, or to post-process the output ofan extension function.

See the extension's documentation for a list of events (if any) it publishes.For example, see theevent types for the Run Payments with Stripe extension.

Then, seeCustom event triggers forinformation on writing Eventarc event handlers.

Important: Enabling events can result in charges if you exceed the free quota.SeeEventarc pricing.

Install multiple extension instances

You can install the same extension more than once in the same project.Each installed instance can have its own customized configuration and its ownextension resources. You identify and refer to each installed instance using itsinstance ID, which is unique within your project.

You'llbe prompted to confirm or edit the instance ID of each additional instance ofthe extension you install.

Next Steps

• View the details and theconfigurationof your installed extension in theFirebase console.

• Monitor the activityof your installed extension, including checks on its health, usage, and logs.

• Using theFirebase console,manage yourinstalled extension. For officialFirebase extensions, you can reconfigureor uninstall your extension, as well as update your extension to the latestversion.

• As a best practice for all projects, make sure to set upbudget alertsfor your project and monitor yourUsage and billingdashboard in theFirebase console.