Skip to content

Commit

Permalink
Updating documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
DennisAlund committed Feb 7, 2024
1 parent fa9b335 commit b44abd9
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 9 deletions.
34 changes: 26 additions & 8 deletions PREINSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,25 +16,43 @@ be triggered for each event. The plugin also supports multiple platforms
See [README](https://github.com/oddbit/firebase-alerts#readme) for complete list
of feature and platform support

### Configuring webhooks
# Configuring the extension
## Webhooks
The extension require at least one webhook to be defined during the installation.
At the moment you can only declare one webhook per platform.

### Additional setup
This webhook URL can be obtained by reading the apps and integrations documentation
for any of the platforms that are supported by this extension:
[Google Chat](https://developers.google.com/chat/how-tos/webhooks#create_a_webhook),
[Slack](https://slack.com/apps/A0F7XDUAZ-incoming-webhooks),
and [Discord](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks).

Before installing this extension, make sure that you've [set up a Cloud Firestore database](https://firebase.google.com/docs/firestore/quickstart) in your Firebase project.
## App information
You will be required to explicitly configure app id, bundle in order for the extension
to be able to generate URLs to Firebase console, to make direct links to crashlytics etc.

After installing this extension, you'll need to set up webhooks and complete some information about
the mobile and web apps that you have configured for your project.
### App ID
The app ID is the string that is uniquely used by Firebase to identify your application and
you can find it in the Firebase console looking something like this: `1:269808624035:android:296863cf1f5b6817c87a16`

Detailed information for these post-installation tasks are provided after you install this extension.
### Bundle ID
The bundle id is the ID that you have configured in your mobile app configuration, e.g. `id.oddbit.app.example`.


#### Billing
Although web apps do not have bundle ids, Firebase is still using
an equivalent representation for some of the console URLs. As shown in the example below,
you can find the web app's "bundle ID" on the URL looking something
like: `web:NzE5YzVlZDktZjJjOS00Y2Y2LTkzNjQtZTM0ZmJhNjU0MmY3`


![Web App Bundle ID](https://github.com/oddbit/firebase-alerts/raw/main/doc/images/web-app-bundle-id.png)



# Billing

To install an extension, your project must be on the [Blaze (pay as you go) plan](https://firebase.google.com/pricing)

- 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).
- This extension uses other Firebase and Google Cloud Platform services, which have associated charges if you exceed the service’s no-cost tier:
- Cloud Firestore
- Cloud Functions (Node.js 16+ runtime. [See FAQs](https://firebase.google.com/support/faq#extensions-pricing))
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Currently supported platforms and alerts according to [roadmap](https://github.c
| Google Chat | [](https://github.com/oddbit/firebase-alerts/issues/2) || [](https://github.com/oddbit/firebase-alerts/issues/1) ||
| Slack |||||
| Discord |||||

| MS Teams |||||

# Getting involved
If you're reading this, you're awesome!
Expand Down
Binary file removed doc/images/firestore-doc-app.png
Binary file not shown.
Binary file added doc/images/web-app-bundle-id.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit b44abd9

Please sign in to comment.