Skip to content

Commit

Permalink
Update service account roles documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
cjwhitsitt committed Dec 7, 2022
1 parent 2f9a42d commit 3393749
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,14 @@ _**Response has been removed for now as it caused loads of issues in the bash sc

## Environment variables

* `GCP_SA_KEY` - **Required if FIREBASE_TOKEN is not set**. A **normal** service account key(json format) or a **base64 encoded** service account key with the needed permissions for what you are trying to deploy/update.
If you're deploying functions, you would also need the `Cloud Functions Developer` role, and the `Cloud Scheduler Admin` for scheduled functions.
Since the deploy service account is using the App Engine default service account in the deploy process, it also
needs the `Service Account User` role.
If you're only doing Hosting, `Firebase Hosting Admin` is enough.
https://firebase.google.com/docs/hosting/github-integration
* `GCP_SA_KEY` - **Required if FIREBASE_TOKEN is not set**. A **normal** service account key (json format) or a **base64 encoded** service account key with the needed permissions for what you are trying to deploy/update.
* If deploying functions, you would also need the `Cloud Functions Developer` role.
* If the deploy has scheduled functions, include the `Cloud Scheduler Admin` rol.
* Since the service account is using the App Engine default service account in the deploy process, it also needs the `Service Account User` role.
* If updating Firestore Rules, include the `Firebase Rules Admin` role.
* If updating Firestore Indexes, include the `Cloud Datastore Index Admin` role.
* If deplying Hosting files, include the `Firebase Hosting Admin` role.
* For more details: https://firebase.google.com/docs/hosting/github-integration

* `FIREBASE_TOKEN` - **Required if GCP_SA_KEY is not set**. _**This method will soon be deprecated, use `GCP_SA_KEY` instead**_. The token to use for authentication. This token can be aquired through the `firebase login:ci` command.

Expand Down

0 comments on commit 3393749

Please sign in to comment.