Skip to content

Latest commit

 

History

History
50 lines (35 loc) · 2.56 KB

POSTINSTALL.md

File metadata and controls

50 lines (35 loc) · 2.56 KB
Raw

⚠️ If you're having troubles during installation ⚠️

The installation of v2 functions might fail for projects that have never used v2 functions.

It will eventually be fixed on Firebase side, but for now, if you run into errors during install run these commands (or perform equivalent actions via cloud console) and try again:

gcloud services enable compute.googleapis.com

gcloud projects add-iam-policy-binding <PROJECT ID> --member serviceAccount:<PROJECT NUMBER>-compute@developer.gserviceaccount.com --role roles/eventarc.eventReceiver

Configuring your webhooks

Read the official documentation for each of the platforms on how to configure webhooks.

There is a square Firebase icon under the /icons/ folder that you can use for your webhook avatar. Use this permalink to the image: https://github.com/oddbit/firebase-alerts/raw/main/icons/firebase.png

Configuring apps

Configure your apps with useful information in order for the extension to be able to provide useful actions such as quickly creating Github issues and to be able to link directly to a Crashlytics issue.

Create one document for each of your Firebase app ids in a collection named {extension-id}-apps. Use the app id as the document id

  • appId - Firebase app id
  • bundleId - Application bundle id (e.g. id.oddbit.helloworldapp)
  • github - Optional object for github info
    • repo - Repository owner and name (e.g. oddbit/firebase-alerts)

For web apps, the bundleId is a random string that you will have to look for in URL when you are selecting the web app in the Firebase settings page.

Look for the last part of the URL where web-app-bundle-id is your web app's bundleId for the sake of functional equivalent to mobile apps.

https://console.firebase.google.com/project/{project}/settings/general/web:{web-app-bundle-id}

App configuration Firestore Doc

⚠️ Cost of document reads

Please note that there will be a small cost of reading your app documents for each alert that is being triggered. Each event trigger will read all app information documents once per alert. The number of webhooks is not causing additional document reads.