Install a Firebase Extension

You can install (and manage) any of the official Firebase extensions using either the Firebase console or the Firebase CLI (command-line interface).

Make sure to review the differences in the supported actions for the Firebase CLI and Firebase console.

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

Also, to install an extension, your project must be on the Blaze (pay as you go) plan. You will be charged a small amount (typically around $0.01/month) for the Firebase resources required by this extension (even if it is not used), in addition to any charges associated with its usage.

Before you begin

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

Step 1: View detailed information about an extension

This step is optional, but strongly recommended.

Before installing a Firebase Extension, we recommend that you review detailed information about the extension, including:

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

To view an extension's detailed information:

  1. Browse official Firebase extensions from the following sources:

  2. Click an extension's card to:

Step 2: Install an extension

During the installation process, you'll be prompted to review the basic specifications 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 to specify values for the extension's configurable parameters.

  1. Browse official Firebase extensions from the following sources:

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

  3. Click Install, then follow the on-screen instructions to install the extension.

  4. After installation, click Get started in the installed extension's card in your Extensions dashboard.
    Review the extension's post-installation information in the How this extension works section. This information describes specific usage instructions and any further integration requirements.

    You can check out the post-installation information anytime — visit the installed extension's detail page in the Extensions dashboard of the Firebase console.

  5. (Optional) To test out your extension right away, you can follow the See it in action steps displayed in the console.

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 own extension resources. You identify and refer to each installed instance using its instance ID, which is unique within your project. You'll be prompted to confirm or edit the instance ID of each additional instance of the extension you install.

Next Steps

  • View the details and the configuration of your installed extension in the Firebase console.

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

  • Using the Firebase console, manage your installed extension. For official Firebase extensions, you can reconfigure or uninstall your extension, as well as update your extension to the latest version.

  • As a best practice for all projects, make sure to set up budget alerts for your project and monitor your Usage and billing dashboard in the Firebase console.