210 lines
8.6 KiB
Plaintext
210 lines
8.6 KiB
Plaintext
# ==============================================================================
|
|
# 0. METABASE DEVELOPMENT ENVIRONMENT
|
|
# ==============================================================================
|
|
#
|
|
# Central configuration for local Metabase development.
|
|
# Copy to .env and uncomment/modify values as needed.
|
|
#
|
|
# Usage:
|
|
# op inject --in-file .env.example --out-file .env (populate using CLI)
|
|
# cp .env.example .env (populate manually)
|
|
#
|
|
# Hint: Auto-load environment variables with mise or direnv:
|
|
# mise - mise.toml: [settings] env_file = ".env" (https://mise.jdx.dev)
|
|
# direnv - Create .envrc with: dotenv .env (https://direnv.net)
|
|
#
|
|
# Full Metabase environment configuration reference:
|
|
# https://www.metabase.com/docs/latest/configuring-metabase/environment-variables
|
|
#
|
|
# ⚠️ Make sure the same var is not exported multiple times in different contexts.
|
|
|
|
|
|
# ==============================================================================
|
|
# 1. GLOBAL CONTEXT
|
|
# ==============================================================================
|
|
#
|
|
# Shared credentials and tokens used across multiple dev workflows.
|
|
|
|
# GitHub - For gh CLI, API access, and CI integrations
|
|
# https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens
|
|
# GITHUB_TOKEN=your-PAT
|
|
|
|
# AWS - For S3, Athena, Redshift, and other AWS services
|
|
# https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-envvars.html
|
|
# AWS_ACCESS_KEY_ID=your-access-key
|
|
# AWS_SECRET_ACCESS_KEY=your-secret-key
|
|
# AWS_REGION=us-east-1
|
|
|
|
# Docker Hub - Avoid rate limits when pulling images
|
|
# https://docs.docker.com/security/for-developers/access-tokens/
|
|
# DOCKER_USERNAME=your-username
|
|
# DOCKER_PASSWORD=your-access-token
|
|
|
|
# ==============================================================================
|
|
# 2. LOCAL METABASE DEVELOPMENT
|
|
# ==============================================================================
|
|
#
|
|
# Settings for running Metabase locally. Most have sensible defaults—only
|
|
# configure what you need.
|
|
|
|
# 2.1 Application Database
|
|
# ------------------------------------------------------------------------------
|
|
# Where Metabase stores its own data (dashboards, users, settings, etc.).
|
|
# https://www.metabase.com/docs/latest/installation-and-operation/configuring-application-database
|
|
|
|
# Option A: Individual connection parameters
|
|
# MB_DB_TYPE="postgres"
|
|
# MB_DB_HOST="localhost"
|
|
# MB_DB_PORT=5432
|
|
# MB_DB_DBNAME="metabase"
|
|
# MB_DB_USER="<username>"
|
|
# MB_DB_PASS="<password>"
|
|
|
|
# Option B: Single connection URI (overrides individual params)
|
|
# MB_DB_CONNECTION_URI="jdbc:postgresql://localhost:5432/metabase?user=<username>&password=<password>"
|
|
|
|
# 2.2 Server & Integrations
|
|
# ------------------------------------------------------------------------------
|
|
# https://www.metabase.com/docs/latest/configuring-metabase/customizing-jetty-webserver
|
|
|
|
# Jetty server (defaults: localhost:3000)
|
|
# MB_JETTY_HOST="localhost"
|
|
# MB_JETTY_PORT=3000
|
|
|
|
# SMTP for testing email notifications (use with maildev/maildev container)
|
|
MB_EMAIL_SMTP_HOST="localhost"
|
|
MB_EMAIL_SMTP_PORT=1025
|
|
MB_EMAIL_SMTP_USERNAME="admin"
|
|
MB_EMAIL_SMTP_PASSWORD="admin"
|
|
|
|
# 2.3 Feature Flags & Tokens
|
|
# ------------------------------------------------------------------------------
|
|
|
|
# Use staging server for license validation (avoids hitting production)
|
|
METASTORE_DEV_SERVER_URL="https://token-check.staging.metabase.com"
|
|
|
|
# Metabase license token
|
|
# Uncomment this line only when running local dev and NEVER when running Cypress
|
|
# Tests need to start from zero, and set different tokens programmatically (on-demand)
|
|
# MB_PREMIUM_EMBEDDING_TOKEN="op://Shared/Metabase License Dev Tokens/Licenses/MB_ALL_FEATURES_TOKEN"
|
|
|
|
# Skip embedding SDK build for faster frontend compilation
|
|
# SKIP_EMBEDDING_SDK="true"
|
|
|
|
|
|
# ==============================================================================
|
|
# 3. E2E / CYPRESS TESTING
|
|
# ==============================================================================
|
|
#
|
|
# Configuration for running Cypress end-to-end tests locally.
|
|
#
|
|
# The whole environment is already orchestrated via deps.edn using :e2e alias.
|
|
# Treat it as a source of truth for JVM flags and ENVs whether you decide to run
|
|
# backend on your own, or using `bun run test-cypress` (local test runner).
|
|
#
|
|
# You don't _have to_ export any of these vars (except for the tokens below).
|
|
# Things will still work.
|
|
|
|
# 3.1. E2E Application Database (H2 required)
|
|
# ------------------------------------------------------------------------------
|
|
|
|
# Whether to run the enterprise or the open-source Metabase version
|
|
MB_EDITION="ee"
|
|
|
|
# Which file to use for the ephemeral testing application database?
|
|
# MB_DB_FILE="./e2e/tmp/cypress-test.db"
|
|
|
|
# Where does Cypress go to look for the application? (defaults: localhost:4000)
|
|
# MB_JETTY_HOST="localhost"
|
|
# MB_JETTY_PORT=4000
|
|
|
|
# Frontend dev server port (for hot reload). Must match the port used by `yarn build-hot`.
|
|
# MB_FRONTEND_DEV_PORT=8080
|
|
|
|
# Frontend dev server bind address. Defaults to 127.0.0.1; set 0.0.0.0 to reach it from other devices.
|
|
# MB_FRONTEND_DEV_HOST=127.0.0.1
|
|
|
|
# 3.2 E2E Local Runner Setup
|
|
# ------------------------------------------------------------------------------
|
|
|
|
# Whether to run true e2e test suite, or SDK component tests (e2e | component)
|
|
CYPRESS_TESTING_TYPE="e2e"
|
|
|
|
# Whether to start Cypress in an interactive (open) mode with full GUI
|
|
CYPRESS_GUI="true"
|
|
|
|
# Whether to generate application database dumps (colloquially "snapshots")
|
|
# Keep this enabled unless you're experimenting, or know what you're doing.
|
|
GENERATE_SNAPSHOTS="true"
|
|
|
|
# E2E tests run the backend from source by default.
|
|
# To run tests against a JAR instead, set the JAR_PATH variable.
|
|
#
|
|
# Hint: build the JAR with ./bin/build.sh
|
|
# JAR_PATH="target/uberjar/metabase.jar"
|
|
|
|
# 3.3 E2E Tokens
|
|
# ------------------------------------------------------------------------------
|
|
#
|
|
# These make sense for Metabase core devs only
|
|
# op inject --in-file .env.example --out-file .env
|
|
|
|
CYPRESS_MB_ALL_FEATURES_TOKEN="op://Shared/Metabase License Dev Tokens/Licenses/MB_ALL_FEATURES_TOKEN"
|
|
CYPRESS_MB_STARTER_CLOUD_TOKEN="op://Shared/Metabase License Dev Tokens/Licenses/MB_STARTER_CLOUD_TOKEN"
|
|
CYPRESS_MB_PRO_CLOUD_TOKEN="op://Shared/Metabase License Dev Tokens/Licenses/MB_PRO_CLOUD_TOKEN"
|
|
CYPRESS_MB_PRO_SELF_HOSTED_TOKEN="op://Shared/Metabase License Dev Tokens/Licenses/MB_PRO_SELF_HOSTED_TOKEN"
|
|
|
|
# 3.4 E2E Misc.
|
|
# ------------------------------------------------------------------------------
|
|
|
|
# To make Node.js match the instance tz
|
|
TZ="US/Pacific"
|
|
|
|
# Export this environment variable when running tests on Apple Silicon.
|
|
# DO NOT USE Docker Desktop. Use Orbstack instead. Metabase will fail to connect
|
|
# to the dockerized Mongo QA database otherwise.
|
|
EXPERIMENTAL_DOCKER_DESKTOP_FORCE_QEMU=1
|
|
|
|
|
|
# ==============================================================================
|
|
# 4. BACKEND DRIVER TESTS
|
|
# ==============================================================================
|
|
#
|
|
# Connection details for running backend tests against a driver, e.g.
|
|
# ./bin/test-agent --drivers=snowflake :only '[metabase.foo-test]'
|
|
|
|
# 4.1 BigQuery
|
|
# ------------------------------------------------------------------------------
|
|
# Service account with BigQuery access in the project. The test user creates and drops the test-data datasets itself.
|
|
# https://cloud.google.com/iam/docs/keys-create-delete
|
|
|
|
# MB_BIGQUERY_CLOUD_SDK_TEST_PROJECT_ID="<project-id>"
|
|
# MB_BIGQUERY_CLOUD_SDK_TEST_SERVICE_ACCOUNT_JSON='{"type": "service_account", ...}'
|
|
# Only for database routing tests
|
|
# MB_BIGQUERY_CLOUD_SDK_TEST_SERVICE_ACCOUNT_JSON_ROUTING='{"type": "service_account", ...}'
|
|
|
|
# 4.2 Redshift
|
|
# ------------------------------------------------------------------------------
|
|
# Test data is loaded into a unique schema per test run.
|
|
|
|
# MB_REDSHIFT_TEST_HOST="<cluster>.<id>.<region>.redshift.amazonaws.com"
|
|
# Comma-separated hosts to pick one at random from, instead of MB_REDSHIFT_TEST_HOST
|
|
# MB_REDSHIFT_TEST_HOSTS=""
|
|
# MB_REDSHIFT_TEST_PORT=5439
|
|
# MB_REDSHIFT_TEST_DB="testdb"
|
|
# MB_REDSHIFT_TEST_USER="metabase_ci"
|
|
# MB_REDSHIFT_TEST_PASSWORD="<password>"
|
|
# Only for database routing tests
|
|
# MB_REDSHIFT_TEST_DB_ROUTING="dev"
|
|
|
|
# 4.3 Snowflake
|
|
# ------------------------------------------------------------------------------
|
|
# Key-pair authentication. The test user creates and drops the test-data databases itself.
|
|
# https://docs.snowflake.com/en/user-guide/key-pair-auth
|
|
|
|
# MB_SNOWFLAKE_TEST_ACCOUNT="<orgname>-<accountname>"
|
|
# MB_SNOWFLAKE_TEST_USER="<username>"
|
|
# MB_SNOWFLAKE_TEST_PRIVATE_KEY="-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----"
|
|
# MB_SNOWFLAKE_TEST_WAREHOUSE="<warehouse>"
|
|
# MB_SNOWFLAKE_TEST_ADDITIONAL_OPTIONS=""
|