Instale (e gerencie) qualquer extensão oficial do Firebase usando o Console do Firebase ou a CLI do Firebase (interface de linha de comando).
Revise as diferenças das ações disponíveis na CLI e no Console do Firebase.
Para instalar ou gerenciar extensões, é necessário atribuir um destes papéis: Proprietário ou Editor ou Administrador do Firebase.
Para instalar uma extensão, o projeto precisa estar no plano Blaze (pagamento por utilização). Não há cobrança pela instalação de uma extensão, mas você poderá receber cobranças pelo uso de serviços do Firebase ou do Cloud, como o Cloud Secret Manager, se o uso exceder o Nível gratuito dos serviços.
Antes de começar
Adicione o Firebase ao seu projeto, caso ainda não tenha feito isso.
Faça upgrade do seu projeto para o plano Blaze (pagamento por utilização), se ainda não tiver feito isso.
Instale ou atualize para a versão mais recente da CLI do Firebase
Anote o ID do projeto do Firebase ou o alias do projeto configurado anteriormente.
- ID do projeto: execute
firebase projects:list
de qualquer lugar no computador. - Alias do projeto: execute
firebase use
no diretório local de apps.
- ID do projeto: execute
Etapa 1: visualizar informações detalhadas sobre uma extensão
Esta etapa é opcional, mas altamente recomendada.
Antes de instalar uma extensão do Firebase, recomendamos que você analise informações detalhadas sobre ela, incluindo:
- Como a extensão funciona, as tarefas de pré-instalação e os detalhes sobre ela
- Informações gerais de identificação e descrição
- Se as tarefas da extensão exigem uma conta de faturamento
- Serviços do Google (APIs) e papéis de acesso necessários para operação
- Recursos criados para a extensão (como funções)
- Descrições de parâmetros configuráveis pelo usuário
Para visualizar as informações detalhadas de uma extensão:
Verifique se você configurou seu ambiente e selecionou uma extensão.
Execute o comando extension-info em qualquer lugar no seu computador:
firebase ext:info publisher-id/extension-id
Os argumentos
publisher-id
eextension-id
são obrigatórios e podem ser encontrados na página de detalhes da pré-instalação da extensão.
Etapa 2: instalar uma extensão
Durante o processo de instalação, será solicitado que você analise as especificações básicas da extensão (como APIs ativadas, recursos criados, acesso concedido, etc.). Você será notificado sobre os requisitos de faturamento e solicitado a especificar valores para os parâmetros configuráveis da extensão.
Verifique se você configurou seu ambiente e selecionou uma extensão.
No diretório local do Firebase, execute o comando extension-install. Se solicitado, insira valores de parâmetro para personalizar a instância de extensão.
firebase ext:install publisher-id/extension-id --project=projectId-or-alias
Os argumentos
publisher-id
eextension-id
são obrigatórios e podem ser encontrados na página de detalhes da pré-instalação da extensão.A execução desse comando adiciona uma instância ao manifesto de extensões.
Em seguida, para implantar em um projeto do Firebase as extensões no manifesto, execute:
firebase deploy --only extensions --project=projectId-or-alias
Etapa 3: concluir a configuração pós-instalação
Algumas extensões têm etapas obrigatórias ou opcionais para você concluir antes de usá-las. Encontre essas instruções na página de detalhes de pós-instalação da extensão no painel "Extensões" do Console do Firebase (o link específico para o painel é exibido no terminal após a instalação).
Essas instruções também podem ser encontradas no arquivo POSTINSTALL.md
incluído no
diretório de origem da extensão.
Criar recursos do Firebase
Se você configurou a extensão para usar recursos do Firebase (coleções do Cloud Firestore, caminhos do Realtime Database e buckets do Cloud Storage) que ainda não existem, crie-os antes de usar a extensão.
Criar manipuladores de eventos do Eventarc
Algumas extensões são publicadas no Eventarc quando eventos importantes acontecem durante a execução. Se uma extensão publicar eventos e você tiver ativado eventos durante a instalação, será possível escrever funções que reagem a esses eventos com sua própria lógica personalizada. Isso pode ser útil, por exemplo, para notificar os usuários quando tarefas de longa duração forem concluídas ou para pós-processar a saída de uma função de extensão.
Consulte a documentação da extensão para ver uma lista dos eventos publicados (se houver).
Em seguida, consulte Acionadores de evento personalizados para ver informações sobre como criar manipuladores de eventos do Eventarc.
Instalar várias instâncias de extensões
É possível instalar a mesma extensão mais de uma vez no mesmo projeto. Cada instância instalada pode ter sua própria configuração personalizada e recursos de extensão. Identifique e faça referência a cada instância instalada usando o ID da instância exclusivo do projeto. Você precisará confirmar ou editar o ID de cada instância adicional da extensão que instalar.
Próximas etapas
Veja os detalhes e a configuração da extensão instalada no Console do Firebase.
Monitore a atividade da extensão instalada, incluindo verificações de integridade, uso e registros.
Usando a CLI do Firebase, gerencie a extensão instalada. É possível reconfigurar ou desinstalar sua extensão, bem como atualizar sua extensão para a versão mais recente.
Usando o Console do Firebase, gerencie sua extensão instalada. Para extensões oficiais do Firebase, é possível reconfigurar ou desinstalar sua extensão, além de atualizá-la para a versão mais recente.
Como prática recomendada para todos os projetos, configure alertas de orçamento para seu projeto e monitore o Painel de uso e faturamento no Console do Firebase.