matthewkrupnik/docker-firestore-emulator-with-ui

Firestore模拟器Docker镜像文档

镜像概述

本镜像基于 https://github.com/matthewkrupnik/docker-firestore-emulator-with-ui 项目 fork 而来，主要改进为支持通过环境变量暴露模拟器端口。容器运行 Alpine Linux 系统，预装 Node LTS、Bash、OpenJDK11，并通过 npm 安装了 firebase-toolkit，同时集成 Firestore、PubSub、Functions 模拟器及 UI 界面。

核心功能和特性

• 多模拟器集成：包含 Firestore、PubSub、Functions 模拟器，满足 Firebase 相关服务的本地开发需求
• 端口自定义：支持通过环境变量配置各模拟器及 UI 的端口
• 轻量级基础：基于 Alpine Linux，体积小，资源占用低
• 预装依赖：包含 Node LTS、OpenJDK11 等必要运行环境
• UI 界面：内置模拟器管理界面，便于监控和操作
• 灵活配置：支持挂载自定义规则文件、索引文件及函数代码

使用场景

• 本地开发 Firebase 应用时，无需连接真实 Firebase 服务
• 测试 Firestore 数据操作、索引规则及安全规则
• 调试 PubSub 消息发布/订阅功能
• 开发和测试 Firebase Cloud Functions 云函数

使用方法

基本运行命令

默认端口映射运行：

bash
docker run -p 8080:8080 -p 4000:4000 -p 8085:8085 -p 5001:5001 -p 5005:5005 matthewkrupnik/docker-firestore-emulator-with-ui

自定义端口运行

指定 Firestore 服务端口为 8200 示例：

bash
docker run -e FIRESTORE_PORT=8200 -p 8200:8200 -p 4000:4000 -p 8085:8085 -p 5001:5001 -p 5005:5005 matthewkrupnik/docker-firestore-emulator-with-ui

环境变量与端口

挂载点

• Firestore 索引文件：firestore.indexes.json 需挂载至 /firebase/firestore.indexes.json
• Firestore 规则文件：firestore.rules 需挂载至 /firebase.rules
• 函数代码目录：函数代码需挂载至 /firestore/functions

服务配置

Firestore 配置

客户端连接 Firestore 模拟器需设置环境变量：

bash
FIRESTORE_EMULATOR_HOST="localhost:8080"  # 端口需与容器映射的 FIRESTORE_PORT 一致

PubSub 配置

客户端连接 PubSub 模拟器需设置环境变量：

bash
PUBSUB_EMULATOR_HOST="localhost:8085"  # 端口需与容器映射的 PUSUB_PORT 一致

Functions 配置

依赖要求

挂载的函数目录需包含 package.json，并安装以下依赖：

json
{
  "dependencies": {
    "firebase-admin": "^8.10.0",
    "firebase-functions": "^3.6.1"
  }
}

部署配置

容器会自动在函数目录执行 npm install，并使用以下配置：

json
"functions": {
  "predeploy": [
    "npm --prefix ./functions run lint",
    "npm --prefix ./functions run build"
  ],
  "source": "functions"
}