Skip to content

Firestore backups

We use a github action to regularly take backups of Firestore on the projects that make use of this database.

Setup

  1. Create a Google Storage Bucket, say with name: gs://firestore-backups
  2. Create a service account that has the following roles:
[1] Cloud Datastore Import Export Admin
[2] Storage Admin
  1. Create a JSON key file for the service account
  2. Use the command given below (replacing the path with the path to your downloaded keyfile) to base64 encode the keyfile
base64 path/to/your/downloaded/keyfile.json
  1. Add the base64 encoded keyfile as a secret to the github repo. Call the secret FIREBASE_BACKUP_GCLOUD_AUTH
  2. create the file .github/workflows/firestore_backup.yml in your repo
  3. Copy the below contents into that file
  4. Create a Pull Request
  5. Once the PR is approved, a Firestore backup will be taken every night at 3am.
name: Firestore backup

on:
  schedule:
    - cron: "0 3 * * *"

jobs:
  backup:
    runs-on: ubuntu-latest
    steps:
      - uses: lfdm/firestore-backup-gh-action@1.0.0
        with:
          gcloudAuth: ${{ secrets.FIREBASE_BACKUP_GCLOUD_AUTH }}
          projectId: swallow-quotes
          storageBucket: gs://firestore-backups

Questions

If you have any questions about this process, reach out to andi@wakeflow.io