Many settings in Metabase can be viewed and modified in the Admin Panel, or set via environment variables. The environment variables always take precedence.
Setting environment variables can be done in various ways depending on how Metabase is being run.
JAR file:
# Mac, Linux and other Unix-based systems export MB_SITE_NAME="Awesome Company" # Windows Powershell $env:MB_SITE_NAME="Awesome Company" # Windows batch/cmd set MB_SITE_NAME="Awesome Company" java -jar metabase.jar
Or set it as Java property, which works the same across all systems:
java -DMB_SITE_NAME="Awesome Company" -jar metabase.jar
Docker:
docker run -d -p 3000:3000 -e MB_SITE_NAME="Awesome Company" --name metabase metabase/metabase
MAX_SESSION_AGE
Type: integer Default: 20160
20160
Session expiration, defined in minutes (default is 2 weeks), which will log out users after the defined period and require re-authentication.
Note: This setting is not an idle/inactivity timeout. If you set this to 15 minutes, your users have to login (or re-authenticate) again every 15 minutes.
Use MB_SESSION_COOKIES to also expire sessions, when browser is closed.
Also see the Changing session expiration documentation page.
MB_ADMIN_EMAIL
Type: string Default: null
null
The email address users should be referred to if they encounter a problem.
MB_ANON_TRACKING_ENABLED
Type: boolean Default: true
true
Enable the collection of anonymous usage data in order to help Metabase improve.
MB_API_KEY
Middleware that enforces validation of the client via the request header X-Metabase-Apikey. If the header is available, then it’s validated against MB_API_KEY. When it matches, the request continues; otherwise it’s blocked with a 403 Forbidden response.
X-Metabase-Apikey
MB_APPLICATION_COLORS
Only available in Enterprise Edition Type: string Default: "{}"
"{}"
JSON object of primary colors used in charts and throughout Metabase.
MB_APPLICATION_DB_MAX_CONNECTION_POOL_SIZE
Type: integer Default: 15 Since: 0.35.0
15
Maximum number of connections to the Metabase application database.
Change this to a higher value if you notice that regular usage consumes all or close to all connections. When all connections are in use, Metabase might feel slow or unresponsive when clicking around the interface.
To see how many connections are being used, check the Metabase logs and look for lines that contains the following: … App DB connections: 12/15 …. In this example, 12 out of 15 available connections are being used.
… App DB connections: 12/15 …
See MB_JDBC_DATA_WAREHOUSE_MAX_CONNECTION_POOL_SIZE for setting maximum connections to the databases connected to Metabase.
MB_APPLICATION_FAVICON_URL
Only available in Enterprise Edition Type: string Default: "frontend_client/favicon.ico"
"frontend_client/favicon.ico"
Path or URL to favicon file.
MB_APPLICATION_LOGO_URL
Only available in Enterprise Edition Type: string Default: "app/assets/img/logo.svg"
"app/assets/img/logo.svg"
Path or URL to logo file. For best results use SVG format.
MB_APPLICATION_NAME
Only available in Enterprise Edition Type: string Default: "Metabase"
"Metabase"
Replace the word Metabase wherever it appears with the defined string.
Metabase
MB_ASYNC_QUERY_THREAD_POOL_SIZE
Type: integer Default: 50 Since: 0.35.0
50
Maximum number of async Jetty threads. If not set, then MB_JETTY_MAXTHREADS will be used, otherwise it will use the default.
MB_BREAKOUT_BIN_WIDTH
Type: double Default: 10.0
10.0
When using the default binning strategy for a field of type Coordinate (such as Latitude and Longitude), this number will be used as the default bin width (in degrees).
MB_BREAKOUT_BINS_NUM
Type: integer Default: 8
8
When using the default binning strategy and a number of bins is not provided, this number will be used as the default.
MB_CHECK_FOR_UPDATES
Identify when new versions of Metabase are available.
MB_CLIENT
Used to recognize the Mac App client, which then defaults to "OSX".
"OSX"
MB_COLORIZE_LOGS
Color log lines. When set to false it will disable log line colors. This is disabled on Windows. Related to MB_EMOJI_IN_LOGS.
false
MB_CUSTOM_FORMATTING
Type: string Default: "{}"
JSON object keyed by type, containing formatting settings.
MB_CUSTOM_GEOJSON
JSON object containing information about custom GeoJSON files for use in map visualizations instead of the default US State or World GeoJSON.
MB_DB_AUTOMIGRATE
When set to false, Metabase will print migrations needed to be done in the application database and exit. Those migrations need to be applied manually. When true, Metabase will automatically make changes to the application database. This is not related to migrating away from H2.
MB_DB_CONNECTION_TIMEOUT_MS
Type: integer Default: 5000
5000
Timeout in milliseconds for connecting to the application database.
MB_DB_CONNECTION_URI
A JDBC-style connection URI that can be used instead of most of MB_DB_* like MB_DB_HOST. Also used when certain Connection String parameters are required for the connection. The connection type requirement is the same as MB_DB_TYPE.
MB_DB_*
Example: jdbc:postgresql://db.example.com:port/mydb?user=dbuser&password=dbpassword&ssl=true&sslfactory=org.postgresql.ssl.NonValidatingFactory
jdbc:postgresql://db.example.com:port/mydb?user=dbuser&password=dbpassword&ssl=true&sslfactory=org.postgresql.ssl.NonValidatingFactory
MB_DB_DBNAME
The database name of the application database used with MB_DB_HOST.
MB_DB_FILE
Type: string Default: "metabase.db"
"metabase.db"
Location of H2 database file. Should not include the .mv.db (or .h2.db) file extension. Used when MB_DB_TYPE is set to"h2".
.mv.db
.h2.db
"h2"
Can also be used when migrating away from H2 to specify where the existing data should be read from.
MB_DB_HOST
The host name or IP address of the application database. Used when MB_DB_TYPE is different than "h2".
MB_DB_IN_MEMORY
Type: boolean Default: null
Used for testing with MB_DB_FILE.
MB_DB_PASS
The password for MB_DB_HOST.
MB_DB_PORT
Type: integer Default: null
The port for MB_DB_HOST.
MB_DB_TYPE
Type: string ("h2", "postgres", "mysql") Default: "h2"
"postgres"
"mysql"
When "h2", the application database is loaded from MB_DB_FILE, otherwise MB_DB_HOST will be used to define application database.
MB_DB_USER
The username for MB_DB_HOST.
MB_DISABLE_SESSION_THROTTLE
Type: boolean Default: false
When true, this will disable session throttling. Warning: It is not recommended to disable throttling, since it is a protective measure against brute-force attacks.
Use MB_SOURCE_ADDRESS_HEADER to set the IP address of the remote client from e.g. a reverse-proxy.
MB_EMAIL_FROM_ADDRESS
Address you want to use as the sender of emails generated by Metabase, such as pulses or account invitations.
MB_EMAIL_SMTP_HOST
The address of the SMTP server that handles your emails.
MB_EMAIL_SMTP_PASSWORD
SMTP password.
MB_EMAIL_SMTP_PORT
The port your SMTP server uses for outgoing emails.
MB_EMAIL_SMTP_SECURITY
Type: string ("tls", "ssl", "starttls", "none") Default: "none"
"tls"
"ssl"
"starttls"
"none"
SMTP secure connection protocol.
MB_EMAIL_SMTP_USERNAME
SMTP username.
MB_EMBEDDING_APP_ORIGIN
Only available in Enterprise Edition Type: string Default: null
URL of origin allowed to embed the full Metabase application.
MB_EMOJI_IN_LOGS
Emojis on log lines. When set to false it will disable log line emojis. This is disabled on Windows. Related to MB_COLORIZE_LOGS.
MB_ENABLE_EMBEDDING
Allow admins to securely embed questions and dashboards within other applications.
MB_ENABLE_NESTED_QUERIES
Allow using a saved question as the source for other queries.
MB_ENABLE_PASSWORD_LOGIN
Only available in Enterprise Edition Type: boolean Default: true
Still allow logging in by email and password when SSO login options are enabled.
MB_ENABLE_PUBLIC_SHARING
Enable admins to create publicly viewable links (and embedded iframes) for questions and dashboards.
MB_ENABLE_QUERY_CACHING
Enabling caching will save the results of queries that take a long time to run.
MB_ENABLE_TEST_ENDPOINTS
When true, this will enable /api/testing endpoint. Warning: This should never be enabled in production system.
/api/testing
MB_ENABLE_XRAYS
Allow users to explore data using X-rays.
MB_ENCRYPTION_SECRET_KEY
When set, this will encrypt database credentials stored in the application database. Requirement: minimum 16 characters base64-encoded string.
Also see documentation page Encrypting database details at rest.
MB_GOOGLE_AUTH_AUTO_CREATE_ACCOUNTS_DOMAIN
When set, allows users to automatically create their Metabase account by logging in if their Google account email address is from this domain.
MB_GOOGLE_AUTH_CLIENT_ID
Client ID for Google Auth SSO. If this is set, Google Auth is considered to be enabled.
MB_JDBC_DATA_WAREHOUSE_MAX_CONNECTION_POOL_SIZE
Maximum number of connections to the data source databases. The maximum is for each database setup in Admin Panel > Databases, not a total for all databases.
Change this to a higher value if you notice that regular usage consumes all or close to all connections. When all connections are in use then Metabase will be slower to return results for queries, since it would have to wait for an available connection before processing the next query in the queue.
See MB_APPLICATION_DB_MAX_CONNECTION_POOL_SIZE for setting maximum connections to the Metabase application database.
MB_JETTY_ASYNC_RESPONSE_TIMEOUT
Type: integer Default: 600000 Since: 0.35.0
600000
Timeout of Jetty async threads, defined in milliseconds. The default is 10 minutes. Very few things might reach that timeout, since they return some type of data before, but things like CSV downloads might.
MB_JETTY_DAEMON
Use daemon threads.
MB_JETTY_HOST
Type: string Default: localhost for JAR, 0.0.0.0 for Docker
localhost
0.0.0.0
Configure a host either as a host name or IP address to identify a specific network interface on which to listen. If set to "0.0.0.0", Metabase listens on all network interfaces. It will listen on the port specified in MB_JETTY_PORT.
"0.0.0.0"
MB_JETTY_JOIN
Blocks the thread until server ends.
MB_JETTY_MAXIDLETIME
Type: integer Default: 200000
200000
Maximum idle time for a connection, in milliseconds.
MB_JETTY_MAXQUEUED
Type: integer Default: “FIX ME”
Maximum number of requests to be queued when all threads are busy.
MB_JETTY_MAXTHREADS
Type: integer Default: 50
Maximum number of threads.
Change this to a higher value if you notice that regular usage consumes all or close to all threads. When all threads are in use Metabase might feel slow or unresponsive when clicking around the interface.
To see how many threads are being used, check the Metabase logs and look for lines that contain the following: … Jetty threads: 45/50 …, which in this case would indicate 45 out of 50 available threads are being used.
… Jetty threads: 45/50 …
Related MB_ASYNC_QUERY_THREAD_POOL_SIZE.
MB_JETTY_MINTHREADS
Minimum number of threads.
MB_JETTY_PORT
Type: integer Default: 3000
3000
Configure which port to use for HTTP. It will listen on the interface specified in MB_JETTY_HOST.
MB_JETTY_REQUEST_HEADER_SIZE
Type: integer Default: 8192 Since: 0.36.0
8192
Maximum size of a request header, in bytes. Increase this value if you are experiencing errors like “Request Header Fields Too Large”.
MB_JETTY_SSL
When set to true, will enable HTTPS with the options configured in the MB_JETTY_SSL_* variables.
MB_JETTY_SSL_*
Also see the Customizing Jetty web server documentation page.
MB_JETTY_SSL_KEYSTORE
Path to Java KeyStore file.
MB_JETTY_SSL_KEYSTORE_PASSWORD
Password for Java KeyStore file.
MB_JETTY_SSL_PORT
Configure which port to use for HTTPS. It will listen on the interface specified in MB_JETTY_HOST.
MB_JETTY_SSL_TRUSTSTORE
Path to Java TrustStore file.
MB_JETTY_SSL_TRUSTSTORE_PASSWORD
Password for Java TrustStore file.
MB_JWT_ATTRIBUTE_EMAIL
Only available in Enterprise Edition Type: string Default: "email"
"email"
Key to retrieve the JWT user’s email address.
MB_JWT_ATTRIBUTE_FIRSTNAME
Only available in Enterprise Edition Type: string Default: "first_name"
"first_name"
Key to retrieve the JWT user’s first name.
MB_JWT_ATTRIBUTE_GROUPS
Only available in Enterprise Edition Type: string Default: "groups"
"groups"
Key to retrieve the JWT user’s groups.
MB_JWT_ATTRIBUTE_LASTNAME
Key to retrieve the JWT user’s last name.
MB_JWT_ENABLED
Only available in Enterprise Edition Type: boolean Default: false
When set to true, will enable JWT authentication with the options configured in the MB_JWT_* variables.
MB_JWT_*
MB_JWT_GROUP_MAPPINGS
JSON object containing JWT to Metabase group mappings. Should be in the form: '{"groupName": [1, 2, 3]}' where keys are JWT groups and values are lists of Metabase groups IDs.
'{"groupName": [1, 2, 3]}'
MB_JWT_GROUP_SYNC
Enable group membership synchronization with JWT.
MB_JWT_IDENTITY_PROVIDER_URI
URL of JWT based login page.
MB_JWT_SHARED_SECRET
String used to seed the private key used to validate JWT messages.
MB_LANDING_PAGE
Only available in Enterprise Edition Type: string Default: ""
""
Default page to show the user.
MB_LDAP_ATTRIBUTE_EMAIL
Type: string Default: "mail"
"mail"
Attribute to use for the user’s email. Usually ‘mail’, ‘email’ or ‘userPrincipalName’.
MB_LDAP_ATTRIBUTE_FIRSTNAME
Type: string Default: "givenName"
"givenName"
Attribute to use for the user’s first name. Usually ‘givenName’.
MB_LDAP_ATTRIBUTE_LASTNAME
Type: string Default: "sn"
"sn"
Attribute to use for the user’s last name. Usually ‘sn’.
MB_LDAP_BIND_DN
The Distinguished Name to bind as (if any). This user will be used to lookup information about other users.
MB_LDAP_ENABLED
When set to true, will enable LDAP authentication with the options configured in the MB_LDAP_* variables.
MB_LDAP_*
MB_LDAP_GROUP_BASE
Search base for groups. Not required if your LDAP directory provides a ‘memberOf’ overlay. (Will be searched recursively.)
MB_LDAP_GROUP_MAPPINGS
JSON object containing LDAP to Metabase group mappings.
MB_LDAP_GROUP_SYNC
Enable group membership synchronization with LDAP.
MB_LDAP_HOST
Server hostname.
MB_LDAP_PASSWORD
The password to bind with for the lookup user.
MB_LDAP_PORT
Type: string Default: "389"
"389"
Server port, usually 389 or 636 if SSL is used.
MB_LDAP_SECURITY
Type: string ("none", "ssl", "starttls") Default: "none"
Use SSL, TLS or plain text.
MB_LDAP_SYNC_USER_ATTRIBUTES
Sync user attributes when someone logs in via LDAP.
MB_LDAP_SYNC_USER_ATTRIBUTES_BLACKLIST
Only available in Enterprise Edition Type: string Default: "userPassword,dn,distinguishedName"
"userPassword,dn,distinguishedName"
Comma-separated list of user attributes to skip syncing for LDAP users.
MB_LDAP_USER_BASE
Search base for users. (Will be searched recursively.)
MB_LDAP_USER_FILTER
Type: string Default: "(&(objectClass=inetOrgPerson)(|(uid={login})(mail={login})))"
"(&(objectClass=inetOrgPerson)(|(uid={login})(mail={login})))"
User lookup filter. The placeholder {login} will be replaced by the user supplied login.
{login}
MB_MAP_TILE_SERVER_URL
Type: string Default: "https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png"
"https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png"
The map tile server URL template used in map visualizations, for example from OpenStreetMaps or MapBox.
MB_METABOT_ENABLED
Enable MetaBot, which lets you search for and view your saved questions directly via Slack.
MB_NS_TRACE
Type: string Default: ""
Comma-separated namespaces to trace. WARNING: Could log sensitive information like database passwords.
MB_PASSWORD_COMPLEXITY
Type: string ("weak", "normal", "strong") Default: "normal"
"weak"
"normal"
"strong"
Enforce a password complexity rule to increase security for regular logins. This only applies to new users or users that are changing their password. Related MB_PASSWORD_LENGTH
weak
normal
strong
MB_PASSWORD_LENGTH
Type: integer Default: 6
6
Set a minimum password length to increase security for regular logins. This only applies to new users or users that are changing their password. Uses the length of MB_PASSWORD_COMPLEXITY if not set.
MB_PLUGINS_DIR
Type: string Default: "plugins"
"plugins"
Path of the “plugins” directory, which is used to store the Metabase database drivers. The user who is running Metabase should have permission to write to the directory. When running the JAR, the default directory is plugins, created in the same location as the JAR file. When running Docker, the default directory is /plugins.
plugins
/plugins
The location is where custom third-party drivers should be added. Then Metabase will load the driver on startup, which can be verified in the log.
MB_PREMIUM_EMBEDDING_TOKEN
Token for Enterprise Edition and Premium features.
MB_QP_CACHE_BACKEND
Type: string Default: "db"
"db"
Current cache backend. Dynamically rebindable primarily for test purposes.
MB_QUERY_CACHING_MAX_KB
Type: integer Default: 1000
1000
The maximum size of the cache, per saved question, in kilobytes.
MB_QUERY_CACHING_MAX_TTL
Type: integer Default: 8640000
8640000
The absolute maximum time to keep any cached query results, in seconds. The default value is 100 days in seconds.
MB_QUERY_CACHING_MIN_TTL
Type: integer Default: 60
60
Metabase will cache all saved questions with an average query execution time longer than this many seconds.
MB_QUERY_CACHING_TTL_RATIO
Type: integer Default: 10
10
To determine how long each saved question’s cached result should stick around, we take the query’s average execution time and multiply that by whatever you input here. So if a query takes on average 2 minutes to run, and you input 10 for your multiplier, its cache entry will persist for 20 minutes.
MB_REDIRECT_ALL_REQUESTS_TO_HTTPS
Type: boolean Default: false Since: 0.36.0
Force all traffic to use HTTPS via a redirect, if the site URL is HTTPS. Related MB_SITE_URL
MB_REDSHIFT_FETCH_SIZE
Controls the fetch size used for Redshift queries (in PreparedStatement), via the defaultRowFetchSize JDBC URL parameter.
PreparedStatement
defaultRowFetchSize
MB_REPORT_TIMEZONE
Connection timezone to use when executing queries. Defaults to system timezone.
MB_SAML_APPLICATION_NAME
This application name will be used for requests to the Identity Provider.
MB_SAML_ATTRIBUTE_EMAIL
Only available in Enterprise Edition Type: string Default: "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress"
"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress"
SAML attribute for the user’s email address.
MB_SAML_ATTRIBUTE_FIRSTNAME
Only available in Enterprise Edition Type: string Default: "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname"
"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname"
SAML attribute for the user’s first name.
MB_SAML_ATTRIBUTE_GROUP
Only available in Enterprise Edition Type: string Default: "member_of"
"member_of"
SAML attribute for group syncing.
MB_SAML_ATTRIBUTE_LASTNAME
Only available in Enterprise Edition Type: string Default: "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname"
"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname"
SAML attribute for the user’s last name.
MB_SAML_ENABLED
When set to true, will enable SAML authentication with the options configured in the MB_SAML_* variables.
MB_SAML_*
MB_SAML_GROUP_MAPPINGS
JSON object containing SAML to Metabase group mappings. Should be in the form: '{"groupName": [1, 2, 3]}' where keys are SAML groups and values are lists of Metabase groups IDs.
MB_SAML_GROUP_SYNC
Enable group membership synchronization with SAML.
MB_SAML_IDENTITY_PROVIDER_CERTIFICATE
Encoded certificate for the identity provider, provided as the content, not a file path.
MB_SAML_IDENTITY_PROVIDER_URI
This is the URL where your users go to log in to your identity provider. Depending on which IdP you’re using, this usually looks like https://your-org-name.okta.com.
https://your-org-name.okta.com
MB_SAML_KEYSTORE_ALIAS
Only available in Enterprise Edition Type: string Default: "metabase"
"metabase"
Alias for the key that Metabase should use for signing SAML requests.
MB_SAML_KEYSTORE_PASSWORD
Only available in Enterprise Edition Type: string Default: "changeit"
"changeit"
Password for opening the KeyStore.
MB_SAML_KEYSTORE_PATH
Absolute path to the KeyStore file to use for signing SAML requests.
MB_SEND_NEW_SSO_USER_ADMIN_EMAIL
Send email notifications to users in Admin group, when a new SSO users is created on Metabase.
MB_SEND_EMAIL_ON_FIRST_LOGIN_FROM_NEW_DEVICE
Send email notification to user, when they login from a new device. Set to false to stop sending “We’ve noticed a new login on your Metabase account” emails for all users.
MB_SESSION_COOKIES
When set to true, the user login session will expire when the browser is closed. The user login session will always expire after the amount of time defined in MAX_SESSION_AGE (by default 2 weeks). This overrides the “Remember me” checkbox when logging in.
MB_SETUP_TOKEN
An UUID token used to signify that an instance has permissions to create the initial User. This is created upon the first launch of Metabase, by the first instance; once used, it is cleared out, never to be used again.
MB_SHOW_HOMEPAGE_DATA
Hide the “Our data” section from the homepage by setting it to false. Show the section with true, in case it was manually removed.
MB_SHOW_HOMEPAGE_XRAYS
Hide the X-rays section from the homepage by setting it to false. Show the section with true, in case it was manually removed. Even if set to true, these will be hidden if any dashboards have been pinned in the “Our Analytics” collection.
MB_SITE_LOCALE
Type: string Default: "en"
"en"
The default language for this Metabase instance. This only applies to emails, Pulses, etc. Users’ browsers will specify the language used in the user interface.
MB_SITE_NAME
Type: string Default: "Metabase"
The name used for this instance of Metabase.
MB_SITE_URL
The base URL where users access Metabase, e.g. https://metabase.example.com or https://example.com/metabase.
https://metabase.example.com
https://example.com/metabase
MB_SITE_UUID
An UUID token used for this instance of Metabase.
MB_SLACK_TOKEN
Slack API bearer token obtained from https://api.slack.com/web#authentication
MB_SOURCE_ADDRESS_HEADER
Type: string Default: X-Forwarded-For
X-Forwarded-For
Identify the source of HTTP requests by this header’s value, instead of its remote address. Related to MB_DISABLE_SESSION_THROTTLE.
MB_SSH_HEARTBEAT_INTERVAL_SEC
Type: integer Default: 180
180
Controls how often the heartbeats are sent when an SSH tunnel is established (in seconds).
MB_SSL_CERTIFICATE_PUBLIC_KEY
Base-64 encoded public key for this sites SSL certificate. Specify this to enable HTTP Public Key Pinning. Using HPKP is no longer recommended. See http://mzl.la/1EnfqBf for more information.
MB_VERSION_INFO_URL
Type: string Default: "http://static.metabase.com/version-info.json"
"http://static.metabase.com/version-info.json"
The address used to check for newer versions of Metabase.