A Google Cloud Firestore Emulator container image. The image is meant to be used for creating an standalone emulator for testing.
The following environment variables must be set:
FIRESTORE_PROJECT_ID
: The ID of the Google Cloud project for the emulator.
The following environment variables need to be set so your application connects to the emulator instead of the production Cloud Firestore environment:
FIRESTORE_EMULATOR_HOST
: The listen address used by the emulator (ie.firestore-emulator:8080
)FIRESTORE_PROJECT_ID
: The ID of the Google Cloud project used by the emulator.
This image contains a script named start-firestore
(included in the PATH). This script is used to initialize the Datastore emulator.
By default, the following command is called:
start-firestore
This image comes with options. Check Firestore Emulator GCloud Wide Flags. --legacy
, --data-dir
and --host-port
are not supported by this image.
The easiest way to create an emulator with this image is by using Docker Compose. The following snippet can be used as a docker-compose.yml
for a firestore emulator:
version: "2"
services:
firestore:
image: perrystallings/cloud-firestore-emulator
environment:
- FIRESTORE_PROJECT_ID=project-test
app:
image: your-app-image
environment:
- FIRESTORE_EMULATOR_HOST=firestore
- FIRESTORE_PROJECT_ID=project-test