Newer
Older
# Environment variables
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.
# Mac, Linux and other Unix-based systems
# Windows Powershell
$env:MB_SITE_NAME="Awesome Company"
# Windows batch/cmd
set MB_SITE_NAME="Awesome Company"
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<br>
Default: `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](#mb_session_cookies) to also expire sessions, when browser is closed.
Also see the [Changing session expiration](changing-session-expiration.md) documentation page.
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
#### `MB_ADMIN_EMAIL`
Type: string<br>
Default: `null`
The email address users should be referred to if they encounter a problem.
#### `MB_ANON_TRACKING_ENABLED`
Type: boolean<br>
Default: `true`
Enable the collection of anonymous usage data in order to help Metabase improve.
#### `MB_API_KEY`
Type: string<br>
Default: `null`
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.
#### `MB_APPLICATION_COLORS`
Only available in Enterprise Edition<br>
Type: string<br>
Default: `"{}"`
JSON object of primary colors used in charts and throughout Metabase.
#### `MB_APPLICATION_DB_MAX_CONNECTION_POOL_SIZE`
Type: integer<br>
Default: `15`<br>
Since: 0.35.0
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.
See [MB_JDBC_DATA_WAREHOUSE_MAX_CONNECTION_POOL_SIZE](#mb_jdbc_data_warehouse_max_connection_pool_size) for setting maximum connections to the databases connected to Metabase.
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
#### `MB_APPLICATION_FAVICON_URL`
Only available in Enterprise Edition<br>
Type: string<br>
Default: `"frontend_client/favicon.ico"`
Path or URL to favicon file.
#### `MB_APPLICATION_LOGO_URL`
Only available in Enterprise Edition<br>
Type: string<br>
Default: `"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<br>
Type: string<br>
Default: `"Metabase"`
Replace the word `Metabase` wherever it appears with the defined string.
#### `MB_ASYNC_QUERY_THREAD_POOL_SIZE`
Type: integer<br>
Default: `50`<br>
Since: 0.35.0
Maximum number of async Jetty threads. If not set, then [MB_JETTY_MAXTHREADS](#mb_jetty_maxthreads) will be used, otherwise it will use the default.
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
#### `MB_BREAKOUT_BIN_WIDTH`
Type: double<br>
Default: `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<br>
Default: `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`
Type: boolean<br>
Default: `true`
Identify when new versions of Metabase are available.
#### `MB_CLIENT`
Type: string<br>
Default: `null`
Used to recognize the Mac App client, which then defaults to `"OSX"`.
#### `MB_COLORIZE_LOGS`
Type: boolean<br>
Default: `true`
Color log lines. When set to `false` it will disable log line colors. This is disabled on Windows. Related to [MB_EMOJI_IN_LOGS](#mb_emoji_in_logs).
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
#### `MB_CUSTOM_FORMATTING`
Type: string<br>
Default: `"{}"`
JSON object keyed by type, containing formatting settings.
#### `MB_CUSTOM_GEOJSON`
Type: string<br>
Default: `"{}"`
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`
Type: boolean<br>
Default: `true`
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<br>
Default: `5000`
Timeout in milliseconds for connecting to the application database.
#### `MB_DB_CONNECTION_URI`
Type: string<br>
Default: `null`
A JDBC-style connection URI that can be used instead of most of `MB_DB_*` like [MB_DB_HOST](#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_type).
Example: `jdbc:postgresql://db.example.com:port/mydb?user=dbuser&password=dbpassword&ssl=true&sslfactory=org.postgresql.ssl.NonValidatingFactory`
#### `MB_DB_DBNAME`
Type: string<br>
Default: `null`
The database name of the application database used with [MB_DB_HOST](#mb_db_host).
#### `MB_DB_FILE`
Type: string<br>
Default: `"metabase.db"`
Location of H2 database file. Should not include the `.mv.db` (or `.h2.db`) file extension. Used when [MB_DB_TYPE](#mb_db_type) is set to`"h2"`.
Can also be used when migrating away from H2 to specify where the existing data should be read from.
#### `MB_DB_HOST`
Type: string<br>
Default: `null`
The host name or IP address of the application database. Used when [MB_DB_TYPE](#mb_db_type) is different than `"h2"`.
#### `MB_DB_IN_MEMORY`
Type: boolean<br>
Default: `null`
Used for testing with [MB_DB_FILE](#mb_db_file).
#### `MB_DB_PASS`
Type: string<br>
Default: `null`
The password for [MB_DB_HOST](#mb_db_host).
#### `MB_DB_PORT`
Type: integer<br>
Default: `null`
The port for [MB_DB_HOST](#mb_db_host).
#### `MB_DB_TYPE`
Type: string (`"h2"`, `"postgres"`, `"mysql"`)<br>
Default: `"h2"`
When `"h2"`, the application database is loaded from [MB_DB_FILE](#mb_db_file), otherwise [MB_DB_HOST](#mb_db_host) will be used to define application database.
#### `MB_DB_USER`
Type: string<br>
Default: `null`
The username for [MB_DB_HOST](#mb_db_host).
#### `MB_DISABLE_SESSION_THROTTLE`
Type: boolean<br>
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](#mb_source_address_header) to set the IP address of the remote client from e.g. a reverse-proxy.
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
#### `MB_EMAIL_FROM_ADDRESS`
Type: string<br>
Default: `null`
Address you want to use as the sender of emails generated by Metabase, such as pulses or account invitations.
#### `MB_EMAIL_SMTP_HOST`
Type: string<br>
Default: `null`
The address of the SMTP server that handles your emails.
#### `MB_EMAIL_SMTP_PASSWORD`
Type: string<br>
Default: `null`
SMTP password.
#### `MB_EMAIL_SMTP_PORT`
Type: integer<br>
Default: `null`
The port your SMTP server uses for outgoing emails.
#### `MB_EMAIL_SMTP_SECURITY`
Type: string (`"tls"`, `"ssl"`, `"starttls"`, `"none"`)<br>
Default: `"none"`
SMTP secure connection protocol.
#### `MB_EMAIL_SMTP_USERNAME`
Type: string<br>
Default: `null`
SMTP username.
#### `MB_EMBEDDING_APP_ORIGIN`
Only available in Enterprise Edition<br>
Type: string<br>
Default: `null`
URL of origin allowed to embed the full Metabase application.
#### `MB_EMOJI_IN_LOGS`
Type: boolean<br>
Default: `true`
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_colorize_logs).
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
#### `MB_ENABLE_EMBEDDING`
Type: boolean<br>
Default: `false`
Allow admins to securely embed questions and dashboards within other applications.
#### `MB_ENABLE_NESTED_QUERIES`
Type: boolean<br>
Default: `true`
Allow using a saved question as the source for other queries.
#### `MB_ENABLE_PASSWORD_LOGIN`
Only available in Enterprise Edition<br>
Type: boolean<br>
Default: `true`
Still allow logging in by email and password when SSO login options are enabled.
#### `MB_ENABLE_PUBLIC_SHARING`
Type: boolean<br>
Default: `false`
Enable admins to create publicly viewable links (and embedded iframes) for questions and dashboards.
#### `MB_ENABLE_QUERY_CACHING`
Type: boolean<br>
Default: `false`
Enabling caching will save the results of queries that take a long time to run.
#### `MB_ENABLE_TEST_ENDPOINTS`
Type: boolean<br>
Default: `null`
When `true`, this will enable `/api/testing` endpoint. **Warning:** This should never be enabled in production system.
#### `MB_ENABLE_XRAYS`
Type: boolean<br>
Default: `true`
Allow users to explore data using X-rays.
#### `MB_ENCRYPTION_SECRET_KEY`
Type: string<br>
Default: `null`
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](encrypting-database-details-at-rest.md).
#### `MB_GOOGLE_AUTH_AUTO_CREATE_ACCOUNTS_DOMAIN`
Type: string<br>
Default: `null`
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`
Type: string<br>
Default: `null`
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`
Type: integer<br>
Default: `15`<br>
Since: 0.35.0
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](#mb_application_db_max_connection_pool_size) for setting maximum connections to the Metabase application database.
#### `MB_JETTY_ASYNC_RESPONSE_TIMEOUT`
Type: integer<br>
Default: `600000`<br>
Since: 0.35.0
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`
Type: boolean<br>
Default: `false`
Use daemon threads.
#### `MB_JETTY_HOST`
Type: string<br>
Default: `localhost` for JAR, `0.0.0.0` for Docker
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](#mb_jetty_port).
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
#### `MB_JETTY_JOIN`
Type: boolean<br>
Default: `true`
Blocks the thread until server ends.
#### `MB_JETTY_MAXIDLETIME`
Type: integer<br>
Default: `200000`
Maximum idle time for a connection, in milliseconds.
#### `MB_JETTY_MAXQUEUED`
Type: integer<br>
Default: _"FIX ME"_
Maximum number of requests to be queued when all threads are busy.
#### `MB_JETTY_MAXTHREADS`
Type: integer<br>
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.
Related [MB_ASYNC_QUERY_THREAD_POOL_SIZE](#mb_async_query_thread_pool_size).
#### `MB_JETTY_MINTHREADS`
Type: integer<br>
Default: `8`
Minimum number of threads.
#### `MB_JETTY_PORT`
Type: integer<br>
Default: `3000`
Configure which port to use for HTTP. It will listen on the interface specified in [MB_JETTY_HOST](#mb_jetty_host).
#### `MB_JETTY_REQUEST_HEADER_SIZE`
Type: integer<br>
Default: `8192`<br>
Since: 0.36.0
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`
Type: boolean<br>
Default: `null`
When set to `true`, will enable HTTPS with the options configured in the `MB_JETTY_SSL_*` variables.
Also see the [Customizing Jetty web server](customizing-jetty-webserver.md) documentation page.
#### `MB_JETTY_SSL_CLIENT_AUTH`
Type: boolean<br>
Default: `null`
Configure Java SSL client authentication. When set to `true`, client certificates are required and verified by the certificate authority in the TrustStore.
#### `MB_JETTY_SSL_KEYSTORE`
Type: string<br>
Default: `null`
Path to Java KeyStore file.
#### `MB_JETTY_SSL_KEYSTORE_PASSWORD`
Type: string<br>
Default: `null`
Password for Java KeyStore file.
#### `MB_JETTY_SSL_PORT`
Type: integer<br>
Default: `null`
Configure which port to use for HTTPS. It will listen on the interface specified in [MB_JETTY_HOST](#mb_jetty_host).
#### `MB_JETTY_SSL_TRUSTSTORE`
Type: string<br>
Default: `null`
Path to Java TrustStore file.
#### `MB_JETTY_SSL_TRUSTSTORE_PASSWORD`
Type: string<br>
Default: `null`
Password for Java TrustStore file.
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
#### `MB_JWT_ATTRIBUTE_EMAIL`
Only available in Enterprise Edition<br>
Type: string<br>
Default: `"email"`
Key to retrieve the JWT user's email address.
#### `MB_JWT_ATTRIBUTE_FIRSTNAME`
Only available in Enterprise Edition<br>
Type: string<br>
Default: `"first_name"`
Key to retrieve the JWT user's first name.
#### `MB_JWT_ATTRIBUTE_GROUPS`
Only available in Enterprise Edition<br>
Type: string<br>
Default: `"groups"`
Key to retrieve the JWT user's groups.
#### `MB_JWT_ATTRIBUTE_LASTNAME`
Only available in Enterprise Edition<br>
Type: string<br>
Default: `"groups"`
Key to retrieve the JWT user's last name.
#### `MB_JWT_ENABLED`
Only available in Enterprise Edition<br>
Type: boolean<br>
Default: `false`
When set to `true`, will enable JWT authentication with the options configured in the `MB_JWT_*` variables.
#### `MB_JWT_GROUP_MAPPINGS`
Only available in Enterprise Edition<br>
Type: string<br>
Default: `"{}"`
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.
#### `MB_JWT_GROUP_SYNC`
Only available in Enterprise Edition<br>
Type: boolean<br>
Default: `false`
Enable group membership synchronization with JWT.
#### `MB_JWT_IDENTITY_PROVIDER_URI`
Only available in Enterprise Edition<br>
Type: string<br>
Default: `null`
URL of JWT based login page.
#### `MB_JWT_SHARED_SECRET`
Only available in Enterprise Edition<br>
Type: string<br>
Default: `null`
String used to seed the private key used to validate JWT messages.
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
#### `MB_LANDING_PAGE`
Only available in Enterprise Edition<br>
Type: string<br>
Default: `""`
Default page to show the user.
#### `MB_LDAP_ATTRIBUTE_EMAIL`
Type: string<br>
Default: `"mail"`
Attribute to use for the user's email. Usually 'mail', 'email' or 'userPrincipalName'.
#### `MB_LDAP_ATTRIBUTE_FIRSTNAME`
Type: string<br>
Default: `"givenName"`
Attribute to use for the user's first name. Usually 'givenName'.
#### `MB_LDAP_ATTRIBUTE_LASTNAME`
Type: string<br>
Default: `"sn"`
Attribute to use for the user's last name. Usually 'sn'.
#### `MB_LDAP_BIND_DN`
Type: string<br>
Default: `null`
The Distinguished Name to bind as (if any). This user will be used to lookup information about other users.
#### `MB_LDAP_ENABLED`
Type: boolean<br>
Default: `false`
When set to `true`, will enable LDAP authentication with the options configured in the `MB_LDAP_*` variables.
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
#### `MB_LDAP_GROUP_BASE`
Type: string<br>
Default: `null`
Search base for groups. Not required if your LDAP directory provides a 'memberOf' overlay. (Will be searched recursively.)
#### `MB_LDAP_GROUP_MAPPINGS`
Type: string<br>
Default: `"{}"`
JSON object containing LDAP to Metabase group mappings.
#### `MB_LDAP_GROUP_SYNC`
Type: boolean<br>
Default: `false`
Enable group membership synchronization with LDAP.
#### `MB_LDAP_HOST`
Type: string<br>
Default: `null`
Server hostname.
#### `MB_LDAP_PASSWORD`
Type: string<br>
Default: `null`
The password to bind with for the lookup user.
#### `MB_LDAP_PORT`
Type: string<br>
Default: `"389"`
Server port, usually 389 or 636 if SSL is used.
#### `MB_LDAP_SECURITY`
Type: string (`"none"`, `"ssl"`, `"starttls"`)<br>
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
Default: `"none"`
Use SSL, TLS or plain text.
#### `MB_LDAP_SYNC_USER_ATTRIBUTES`
Only available in Enterprise Edition<br>
Type: boolean<br>
Default: `true`
Sync user attributes when someone logs in via LDAP.
#### `MB_LDAP_SYNC_USER_ATTRIBUTES_BLACKLIST`
Only available in Enterprise Edition<br>
Type: string<br>
Default: `"userPassword,dn,distinguishedName"`
Comma-separated list of user attributes to skip syncing for LDAP users.
#### `MB_LDAP_USER_BASE`
Type: string<br>
Default: `null`
Search base for users. (Will be searched recursively.)
#### `MB_LDAP_USER_FILTER`
Type: string<br>
Default: `"(&(objectClass=inetOrgPerson)(|(uid={login})(mail={login})))"`
User lookup filter. The placeholder `{login}` will be replaced by the user supplied login.
#### `MB_MAP_TILE_SERVER_URL`
Type: string<br>
Default: `"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`
Type: boolean<br>
Default: `false`
Enable MetaBot, which lets you search for and view your saved questions directly via Slack.
#### `MB_NS_TRACE`
Type: string<br>
Default: `""`
Comma-separated namespaces to trace. **WARNING:** Could log sensitive information like database passwords.
#### `MB_PASSWORD_COMPLEXITY`
Type: string (`"weak"`, `"normal"`, `"strong"`)<br>
Default: `"normal"`
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](#mb_password_length)
- `weak` requires length of 6 characters
- `normal` requires at least 1 digit and length of 6 characters
- `strong` requires at least 2 lowercase and 2 uppercase and 1 digit and 1 symbol and length of 8 characters.
#### `MB_PASSWORD_LENGTH`
Type: integer<br>
Default: `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](#mb_password_complexity) if not set.
#### `MB_PLUGINS_DIR`
Type: string<br>
Default: `"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`.
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`
Type: string<br>
Default: `null`
Token for Enterprise Edition and Premium features.
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
#### `MB_QP_CACHE_BACKEND`
Type: string<br>
Default: `"db"`
Current cache backend. Dynamically rebindable primarily for test purposes.
#### `MB_QUERY_CACHING_MAX_KB`
Type: integer<br>
Default: `1000`
The maximum size of the cache, per saved question, in kilobytes.
#### `MB_QUERY_CACHING_MAX_TTL`
Type: integer<br>
Default: `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<br>
Default: `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<br>
Default: `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<br>
Default: `false`<br>
Since: 0.36.0
Force all traffic to use HTTPS via a redirect, if the site URL is HTTPS. Related [MB_SITE_URL](#mb_site_url)
#### `MB_REDSHIFT_FETCH_SIZE`
Type: integer<br>
Default: `5000`
Controls the fetch size used for Redshift queries (in `PreparedStatement`), via the `defaultRowFetchSize` JDBC URL
parameter.
#### `MB_REPORT_TIMEZONE`
Type: string<br>
Default: `null`
Connection timezone to use when executing queries. Defaults to system timezone.
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
#### `MB_SAML_APPLICATION_NAME`
Only available in Enterprise Edition<br>
Type: string<br>
Default: `"Metabase"`
This application name will be used for requests to the Identity Provider.
#### `MB_SAML_ATTRIBUTE_EMAIL`
Only available in Enterprise Edition<br>
Type: string<br>
Default: `"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<br>
Type: string<br>
Default: `"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<br>
Type: string<br>
Default: `"member_of"`
SAML attribute for group syncing.
#### `MB_SAML_ATTRIBUTE_LASTNAME`
Only available in Enterprise Edition<br>
Type: string<br>
Default: `"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname"`
SAML attribute for the user's last name.
#### `MB_SAML_ENABLED`
Only available in Enterprise Edition<br>
Type: boolean<br>
Default: `false`
When set to `true`, will enable SAML authentication with the options configured in the `MB_SAML_*` variables.
#### `MB_SAML_GROUP_MAPPINGS`
Only available in Enterprise Edition<br>
Type: string<br>
Default: `"{}"`
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`
Only available in Enterprise Edition<br>
Type: boolean<br>
Default: `false`
Enable group membership synchronization with SAML.
#### `MB_SAML_IDENTITY_PROVIDER_CERTIFICATE`
Only available in Enterprise Edition<br>
Type: string<br>
Default: `null`
Encoded certificate for the identity provider, provided as the content, not a file path.
#### `MB_SAML_IDENTITY_PROVIDER_URI`
Only available in Enterprise Edition<br>
Type: string<br>
Default: `null`
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`.
#### `MB_SAML_KEYSTORE_ALIAS`
Only available in Enterprise Edition<br>
Type: string<br>
Default: `"metabase"`
Alias for the key that Metabase should use for signing SAML requests.
#### `MB_SAML_KEYSTORE_PASSWORD`
Only available in Enterprise Edition<br>
Type: string<br>
Default: `"changeit"`
Password for opening the KeyStore.
#### `MB_SAML_KEYSTORE_PATH`
Only available in Enterprise Edition<br>
Type: string<br>
Default: `null`
Absolute path to the KeyStore file to use for signing SAML requests.
#### `MB_SEND_NEW_SSO_USER_ADMIN_EMAIL`
Only available in Enterprise Edition<br>
Type: boolean<br>
Default: `true`
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`
Type: boolean<br>
Default: `true`
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`
Type: boolean<br>
Default: `null`
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](#max_session_age) (by default 2 weeks).
This overrides the "Remember me" checkbox when logging in.
Also see the [Changing session expiration](changing-session-expiration.md) documentation page.
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#### `MB_SETUP_TOKEN`
Type: string<br>
Default: `null`
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`
Type: boolean<br>
Default: `null`
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`
Type: boolean<br>
Default: `null`
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<br>
Default: `"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<br>
Default: `"Metabase"`