Type object
File match firebase.json
Schema URL https://catalog.lintel.tools/schemas/schemastore/firebase/latest.json
Source https://raw.githubusercontent.com/firebase/firebase-tools/master/schema/firebase-config.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

$schema string
apphosting object | object[]
auth object
1 nested properties
providers object
3 nested properties
anonymous boolean
emailPassword boolean
googleSignIn object
3 nested properties
authorizedRedirectUris string[]
oAuthBrandDisplayName string
supportEmail string
database DatabaseSingle | object | object[]
emulators object
16 nested properties
apphosting object
5 nested properties
host string
port number
rootDirectory string
startCommand string
startCommandOverride string
auth object
2 nested properties
host string
port number
database object
2 nested properties
host string
port number
dataconnect object
5 nested properties
dataDir string
host string
port number
postgresHost string
postgresPort number
eventarc object
2 nested properties
host string
port number
extensions object
firestore object
3 nested properties
host string
port number
websocketPort number
functions object
2 nested properties
host string
port number
hosting object
2 nested properties
host string
port number
hub object
2 nested properties
host string
port number
logging object
2 nested properties
host string
port number
pubsub object
2 nested properties
host string
port number
singleProjectMode boolean
storage object
2 nested properties
host string
port number
tasks object
2 nested properties
host string
port number
ui object
3 nested properties
enabled boolean
host string
port number
extensions object
firestore FirestoreSingle | object | object[]
hosting HostingSingle | object | object[]
remoteconfig object
3 nested properties
template string required
postdeploy string[] | string
predeploy string[] | string
storage StorageSingle | object[]

Definitions

ActiveRuntime string
AuthConfig object
providers object
3 nested properties
anonymous boolean
emailPassword boolean
googleSignIn object
3 nested properties
authorizedRedirectUris string[]
oAuthBrandDisplayName string
supportEmail string
DataConnectSingle object
source string required
postdeploy string[] | string
predeploy string[] | string
DatabaseSingle object
rules string required
postdeploy string[] | string
predeploy string[] | string
ExtensionsConfig object
FirestoreSingle object
dataAccessMode string
Values: "FIRESTORE_NATIVE" "MONGODB_COMPATIBLE"
database string
edition string
indexes string
location string
postdeploy string[] | string
predeploy string[] | string
rules string
FrameworksBackendOptions object
concurrency number

Number of requests a function can serve at once.

cors string | boolean

If true, allows CORS on requests to this function. If this is a string or RegExp, allows requests from domains that match the provided value. If this is an Array, allows requests from domains matching at least one entry of the array. Defaults to true for {@link https.CallableFunction} and false otherwise.

cpu string | number

Fractional number of CPUs to allocate to a function.

enforceAppCheck boolean

Determines whether Firebase AppCheck is enforced. Defaults to false.

ingressSettings string

Ingress settings which control where this function can be called from.

Values: "ALLOW_ALL" "ALLOW_INTERNAL_AND_GCLB" "ALLOW_INTERNAL_ONLY"
invoker string

Invoker to set access control on https functions.

Constant: "public"

User labels to set on the function.

maxInstances number

Max number of instances to be running in parallel.

memory string

Amount of memory to allocate to a function.

Values: "128MiB" "16GiB" "1GiB" "256MiB" "2GiB" "32GiB" "4GiB" "512MiB" "8GiB"
minInstances number

Min number of actual instances to be running at a given time.

omit boolean

If true, do not deploy or emulate this function.

preserveExternalChanges boolean

Controls whether function configuration modified outside of function source is preserved. Defaults to false.

region string

HTTP functions can override global options and can specify multiple regions to deploy to.

secrets string[]
serviceAccount string

Specific service account for the function to run as.

timeoutSeconds number

Timeout for the function in seconds, possible values are 0 to 540. HTTPS functions can specify a higher timeout.

vpcConnector string

Connect cloud function to specified VPC connector.

vpcConnectorEgressSettings string

Egress settings for VPC connector.

Values: "ALL_TRAFFIC" "PRIVATE_RANGES_ONLY"
FunctionConfig LocalFunctionConfig | RemoteFunctionConfig
HostingHeaders object | object | object
HostingRedirects object | object | object
HostingRewrites object | object | object | object | object | object | object | object | object | object | object | object | object | object | object
HostingSingle object
appAssociation string
Values: "AUTO" "NONE"
cleanUrls boolean
frameworksBackend object
18 nested properties
concurrency number

Number of requests a function can serve at once.

cors string | boolean

If true, allows CORS on requests to this function. If this is a string or RegExp, allows requests from domains that match the provided value. If this is an Array, allows requests from domains matching at least one entry of the array. Defaults to true for {@link https.CallableFunction} and false otherwise.

cpu string | number

Fractional number of CPUs to allocate to a function.

enforceAppCheck boolean

Determines whether Firebase AppCheck is enforced. Defaults to false.

ingressSettings string

Ingress settings which control where this function can be called from.

Values: "ALLOW_ALL" "ALLOW_INTERNAL_AND_GCLB" "ALLOW_INTERNAL_ONLY"
invoker string

Invoker to set access control on https functions.

Constant: "public"

User labels to set on the function.

maxInstances number

Max number of instances to be running in parallel.

memory string

Amount of memory to allocate to a function.

Values: "128MiB" "16GiB" "1GiB" "256MiB" "2GiB" "32GiB" "4GiB" "512MiB" "8GiB"
minInstances number

Min number of actual instances to be running at a given time.

omit boolean

If true, do not deploy or emulate this function.

preserveExternalChanges boolean

Controls whether function configuration modified outside of function source is preserved. Defaults to false.

region string

HTTP functions can override global options and can specify multiple regions to deploy to.

secrets string[]
serviceAccount string

Specific service account for the function to run as.

timeoutSeconds number

Timeout for the function in seconds, possible values are 0 to 540. HTTPS functions can specify a higher timeout.

vpcConnector string

Connect cloud function to specified VPC connector.

vpcConnectorEgressSettings string

Egress settings for VPC connector.

Values: "ALL_TRAFFIC" "PRIVATE_RANGES_ONLY"
i18n object
1 nested properties
root string required
ignore string[]
postdeploy string[] | string
predeploy string[] | string
public string
redirects HostingRedirects[]
site string
source string
target string
trailingSlash boolean
LocalFunctionConfig object
source string required
codebase string
configDir string
disallowLegacyRuntimeConfig boolean
ignore string[]
postdeploy string[] | string
predeploy string[] | string
prefix string
runtime string
Values: "dart3" "nodejs18" "nodejs20" "nodejs22" "nodejs24" "python310" "python311" "python312" "python313"
Record<string,string> object
RemoteConfigConfig object
template string required
postdeploy string[] | string
predeploy string[] | string
RemoteFunctionConfig object
remoteSource object required
3 nested properties
ref string required
repository string required
dir string
runtime string required
Values: "dart3" "nodejs18" "nodejs20" "nodejs22" "nodejs24" "python310" "python311" "python312" "python313"
codebase string
configDir string
ignore string[]
postdeploy string[] | string
predeploy string[] | string
prefix string
StorageSingle object
rules string required
postdeploy string[] | string
predeploy string[] | string
target string