Nuxt Firebase

Configuration

export interface ModuleOptions {
  config?: FirebaseOptions | string,
  configEnvPrefix?: string
  adminSDKCredential?: string | ServiceAccount
  recaptchaSiteKey?: string
  vapidKey?: string  
  useAdminSDK?: boolean
  useAuthSSR?: boolean      
  useDevtools?: boolean
  useMessagingServiceWorker?: boolean
}

const DEFAULTS: ModuleOptions = {
  useAdminSDK: false,
  useAuthSSR: true,  
  useMessagingServiceWorker: false,
  useDevtools: true
}

config and configEnvPrefix

client SDK options.

  • If FIREBASE_CONFIG env is available, parse the value as JSON and pass it to initializeSDK(config).
  • If config (as Object) is provided, pass the original value to initializeSDK(config).
  • If config (as String) is provided, parse the value as JSON and pass it to initializeSDK(config).
  • If configEnvPrefix is provided, read the config from environment variables. For example: (configEnvPrefix=FIREBASE_)
FIREBASE_API_KEY=value
FIREBASE_AUTH_DOMAIN=value
FIREBASE_PROJECT_ID=value
FIREBASE_STORAGE_BUCKET=value
FIREBASE_MESSAGING_SENDER_ID=value
FIREBASE_APP_ID=value
FIREBASE_DATABASE_URL=value
FIREBASE_MEASUREMENT_ID=value

You might be able to omit some options which are for the service you don't use.

You can also use .env.

adminSDKCredential

The credential of Admin SDK or its path.

The way to determine which credential to use:

  1. Use Application Default Credentials if undefined (Read the file defined in GOOGLE_APPLICATION_CREDENTIALS)
  2. Parse this value as JSON
  3. Parse this value as the file path of the JSON file
  4. Use this value as the credential

If you use Admin SDK, be careful not to publish the credential file. Make sure that the file is gitignored.

recaptchaSiteKey

reCAPTCHA site key.
If this option is provided, automatically enable AppCheck.

If configEnvPrefix is provided, read the value from ${configPrefix}RECAPTCHA_SITE_KEY

vapidKey

VAPID (Voluntary Application Server Identification) key for Cloud Messaging If configEnvPrefix is provided, read the value from ${configPrefix}VAPID_KEY

useAdminSDK

Whether to enable Admin SDK. Even if the credential is available, disabling this parameter makes SDK disabled.
If firebase-admin is not installed, disabled automatically.

useAuthSSR

Whether to use Service Worker for the authenticate session management.
This option can be used without Admin SDK, but some features would be disabled.
For security reasons, it is highly recommended to set Admin SDK credential, too.

TIP

If you do Static Site Generation (nuxi generate), this option will automatically disabled.

useDevtools

Whether to enable DevTools. If you want to use this, you should also install @nuxt/devtoolsopen in new window.

useMessagingServiceWorker

Whether to use builtin service worker for Cloud Messaging.