Skip to content

Commit b3971e9

Browse files
github-automation-metabaseMetabase Docs bot
andauthored
[auto] adding content to master->master (#772)
Co-authored-by: Metabase Docs bot <[email protected]>
1 parent b827ec9 commit b3971e9

File tree

8 files changed

+114
-44
lines changed

8 files changed

+114
-44
lines changed

_docs/master/api.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11676,6 +11676,9 @@
1167611676
"parameter_mappings" : {
1167711677
"$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mappings"
1167811678
},
11679+
"embedding_type" : {
11680+
"type" : "string"
11681+
},
1167911682
"name" : {
1168011683
"type" : "string",
1168111684
"minLength" : 1
@@ -13834,6 +13837,9 @@
1383413837
"type" : "string",
1383513838
"enum" : [ "fixed", "full" ]
1383613839
},
13840+
"embedding_type" : {
13841+
"type" : "string"
13842+
},
1383713843
"show_in_getting_started" : {
1383813844
"type" : "boolean"
1383913845
},

_docs/master/configuring-metabase/config-template.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -162,6 +162,7 @@ config:
162162
health-check-logging-enabled: true
163163
help-link: metabase
164164
help-link-custom-destination: https://www.metabase.com/help/premium
165+
hide-stacktraces: false
165166
http-channel-host-strategy: external-only
166167
humanization-strategy: simple
167168
index-update-thread-count: 2
@@ -222,6 +223,9 @@ config:
222223
query-caching-max-kb: 2000
223224
query-caching-max-ttl: 3024000.0
224225
redirect-all-requests-to-https: false
226+
remote-sync-auto-import: false
227+
remote-sync-auto-import-rate: 5
228+
remote-sync-task-time-limit-ms: 300000
225229
report-timezone: null
226230
reset-token-ttl-hours: 48
227231
retry-initial-interval: 500
@@ -279,6 +283,5 @@ config:
279283
synchronous-batch-updates: false
280284
unaggregated-query-row-limit: null
281285
uploads-settings: null
282-
use-tenants: false
283286
user-visibility: all
284287
```

_docs/master/configuring-metabase/environment-variables.md

Lines changed: 39 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ Allowed iframe hosts.
114114
- Default: `true`
115115
- [Configuration file name](./config-file): `anon-tracking-enabled`
116116

117-
Enable the collection of anonymous usage data to help Metabase improve.
117+
Enable the collection of anonymous usage data in order to help Metabase improve.
118118

119119
### `MB_API_KEY`
120120

@@ -372,7 +372,7 @@ Whether dashboards should default to a user's last used parameters on load.
372372
- Type: integer
373373
- Default: `10000`
374374

375-
Consider metabase.driver/can-connect? / can-connect-with-details? to have failed if they were unable to
375+
Consider metabase.driver/can-connect? / can-connect-with-details? to have failed if they were not able to
376376
successfully connect after this many milliseconds. By default, this is 10 seconds.
377377

378378
Timeout in milliseconds for connecting to databases, both Metabase application database and data connections.
@@ -451,7 +451,7 @@ The name you want to use for the sender of emails.
451451
- [Configuration file name](./config-file): `email-max-recipients-per-second`
452452

453453
The maximum number of recipients, summed across emails, that can be sent per second.
454-
Note that the final email sent before reaching the limit can exceed it, if it has multiple recipients.
454+
Note that the final email sent before reaching the limit is able to exceed it, if it has multiple recipients.
455455

456456
### `MB_EMAIL_REPLY_TO`
457457

@@ -754,6 +754,14 @@ Keyword setting to control whitelabeling of the help link. Valid values are `:me
754754

755755
Custom URL for the help link.
756756

757+
### `MB_HIDE_STACKTRACES`
758+
759+
- Type: boolean
760+
- Default: `false`
761+
- [Configuration file name](./config-file): `hide-stacktraces`
762+
763+
Prevent the exception middleware from including stacktraces in responses.
764+
757765
### `MB_HTTP_CHANNEL_HOST_STRATEGY`
758766

759767
- Type: keyword
@@ -1244,7 +1252,7 @@ Indicates whether Metabase is running behind a proxy that sets the source-addres
12441252
By default "Site Url" is used in notification links, but can be overridden.
12451253

12461254
The base URL where dashboard notitification links will point to instead of the Metabase base URL.
1247-
Only applicable for users who use interactive embedding and subscriptions.
1255+
Only applicable for users who utilize interactive embedding and subscriptions.
12481256

12491257
### `MB_NOTIFICATION_SYSTEM_EVENT_THREAD_POOL_SIZE`
12501258

@@ -1313,6 +1321,30 @@ The absolute maximum time to keep any cached query results, in seconds.
13131321

13141322
Force all traffic to use HTTPS via a redirect, if the site URL is HTTPS.
13151323

1324+
### `MB_REMOTE_SYNC_AUTO_IMPORT`
1325+
1326+
- Type: boolean
1327+
- Default: `false`
1328+
- [Configuration file name](./config-file): `remote-sync-auto-import`
1329+
1330+
Whether to automatically import from the remote git repository. Only applies if remote-sync-type is :production.
1331+
1332+
### `MB_REMOTE_SYNC_AUTO_IMPORT_RATE`
1333+
1334+
- Type: integer
1335+
- Default: `5`
1336+
- [Configuration file name](./config-file): `remote-sync-auto-import-rate`
1337+
1338+
If remote-sync-type is :production and remote-sync-auto-import is true, the rate (in minutes) at which to check for updates to import. Defaults to 5.
1339+
1340+
### `MB_REMOTE_SYNC_TASK_TIME_LIMIT_MS`
1341+
1342+
- Type: integer
1343+
- Default: `300000`
1344+
- [Configuration file name](./config-file): `remote-sync-task-time-limit-ms`
1345+
1346+
The maximum amount of time a remote sync task will be given to complete.
1347+
13161348
### `MB_REPORT_TIMEZONE`
13171349

13181350
- Type: string
@@ -1673,7 +1705,7 @@ When enabled, we show users a button to authenticate with Google to import data
16731705
- [Exported as](../installation-and-operation/serialization): `show-homepage-data`.
16741706
- [Configuration file name](./config-file): `show-homepage-data`
16751707

1676-
Whether or not to display data on the homepage. Admins might turn this off to direct users to better content than raw data.
1708+
Whether or not to display data on the homepage. Admins might turn this off in order to direct users to better content than raw data.
16771709

16781710
### `MB_SHOW_HOMEPAGE_XRAYS`
16791711

@@ -1893,16 +1925,6 @@ Upload settings.
18931925

18941926
Prefix for upload table names.
18951927

1896-
### `MB_USE_TENANTS`
1897-
1898-
> Only available on Metabase [Pro](/product/pro) and [Enterprise](/product/enterprise) plans.
1899-
1900-
- Type: boolean
1901-
- Default: `false`
1902-
- [Configuration file name](./config-file): `use-tenants`
1903-
1904-
Turn on the Tenants feature, allowing users to be assigned to a particular Tenant.
1905-
19061928
### `MB_USER_VISIBILITY`
19071929

19081930
> Only available on Metabase [Pro](/product/pro) and [Enterprise](/product/enterprise) plans.
@@ -1957,7 +1979,7 @@ Maximum number of async Jetty threads. If not set, then [MB_JETTY_MAXTHREADS](#m
19571979
Type: integer<br>
19581980
Default: `20`<br>
19591981

1960-
Limits the number of rows Metabase will display in tables sent with dashboard subscriptions and alerts. Range: 1-100. To limit the total number of rows included in the file attachment for an email dashboard subscription, use [MB_UNAGGREGATED_QUERY_ROW_LIMIT](#mb_unaggregated_query_row_limit).
1982+
Limits the number of rows Metabase will display in tables sent with dashboard subscriptions and alerts. Range: 1-100. To limit the total number of rows included in the file attachment for an email dashboard subscription, use [MB_ATTACHMENT_ROW_LIMIT](#mb_attachment_row_limit).
19611983

19621984
### `MB_AUDIT_MAX_RETENTION_DAYS`
19631985

@@ -2135,7 +2157,7 @@ Type: integer<br>
21352157
Default: `600000`<br>
21362158
Since: v35.0
21372159

2138-
Timeout of Jetty async threads, defined in milliseconds. The default is 10 minutes. Few things might reach that timeout, since they return some type of data before, but things like CSV downloads might.
2160+
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.
21392161

21402162
### `MB_JETTY_DAEMON`
21412163

_docs/master/permissions/application.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,9 +45,11 @@ Monitoring access sets permissions for the following:
4545

4646
## Subscriptions and alerts
4747

48-
This setting determines who can set up:
48+
This setting determines who can create:
4949

5050
- [Dashboard subscriptions](../dashboards/subscriptions)
5151
- [Alerts](../questions/alerts)
5252

53-
People will need to be in groups with either view or edit access to the collection that contains the dashboard or question to set up alerts. See [Collection permissions](../permissions/collections).
53+
People will need to be in groups with either view or edit access to the collection that contains the dashboard or question in order to set up alerts. See [Collection permissions](../permissions/collections).
54+
55+
To prevent people from creating alerts and subscriptions, set the "Subscriptions and alerts" permission to "No".

_site/docs/master/api.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11676,6 +11676,9 @@
1167611676
"parameter_mappings" : {
1167711677
"$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mappings"
1167811678
},
11679+
"embedding_type" : {
11680+
"type" : "string"
11681+
},
1167911682
"name" : {
1168011683
"type" : "string",
1168111684
"minLength" : 1
@@ -13834,6 +13837,9 @@
1383413837
"type" : "string",
1383513838
"enum" : [ "fixed", "full" ]
1383613839
},
13840+
"embedding_type" : {
13841+
"type" : "string"
13842+
},
1383713843
"show_in_getting_started" : {
1383813844
"type" : "boolean"
1383913845
},

_site/docs/master/configuring-metabase/config-template.html

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5054,6 +5054,7 @@ <h1 id="metabase-config-file-template">Metabase config file template</h1>
50545054
<span class="na">health-check-logging-enabled</span><span class="pi">:</span> <span class="kc">true</span>
50555055
<span class="na">help-link</span><span class="pi">:</span> <span class="s">metabase</span>
50565056
<span class="na">help-link-custom-destination</span><span class="pi">:</span> <span class="s">https://www.metabase.com/help/premium</span>
5057+
<span class="na">hide-stacktraces</span><span class="pi">:</span> <span class="kc">false</span>
50575058
<span class="na">http-channel-host-strategy</span><span class="pi">:</span> <span class="s">external-only</span>
50585059
<span class="na">humanization-strategy</span><span class="pi">:</span> <span class="s">simple</span>
50595060
<span class="na">index-update-thread-count</span><span class="pi">:</span> <span class="m">2</span>
@@ -5114,6 +5115,9 @@ <h1 id="metabase-config-file-template">Metabase config file template</h1>
51145115
<span class="na">query-caching-max-kb</span><span class="pi">:</span> <span class="m">2000</span>
51155116
<span class="na">query-caching-max-ttl</span><span class="pi">:</span> <span class="m">3024000.0</span>
51165117
<span class="na">redirect-all-requests-to-https</span><span class="pi">:</span> <span class="kc">false</span>
5118+
<span class="na">remote-sync-auto-import</span><span class="pi">:</span> <span class="kc">false</span>
5119+
<span class="na">remote-sync-auto-import-rate</span><span class="pi">:</span> <span class="m">5</span>
5120+
<span class="na">remote-sync-task-time-limit-ms</span><span class="pi">:</span> <span class="m">300000</span>
51175121
<span class="na">report-timezone</span><span class="pi">:</span> <span class="kc">null</span>
51185122
<span class="na">reset-token-ttl-hours</span><span class="pi">:</span> <span class="m">48</span>
51195123
<span class="na">retry-initial-interval</span><span class="pi">:</span> <span class="m">500</span>
@@ -5171,7 +5175,6 @@ <h1 id="metabase-config-file-template">Metabase config file template</h1>
51715175
<span class="na">synchronous-batch-updates</span><span class="pi">:</span> <span class="kc">false</span>
51725176
<span class="na">unaggregated-query-row-limit</span><span class="pi">:</span> <span class="kc">null</span>
51735177
<span class="na">uploads-settings</span><span class="pi">:</span> <span class="kc">null</span>
5174-
<span class="na">use-tenants</span><span class="pi">:</span> <span class="kc">false</span>
51755178
<span class="na">user-visibility</span><span class="pi">:</span> <span class="s">all</span>
51765179
</code></pre></div></div>
51775180

_site/docs/master/configuring-metabase/environment-variables.html

Lines changed: 47 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -5010,7 +5010,7 @@ <h3 id="mb_anon_tracking_enabled"><code class="language-plaintext highlighter-ro
50105010
<li><a href="./config-file">Configuration file name</a>: <code class="language-plaintext highlighter-rouge">anon-tracking-enabled</code></li>
50115011
</ul>
50125012

5013-
<p>Enable the collection of anonymous usage data to help Metabase improve.</p>
5013+
<p>Enable the collection of anonymous usage data in order to help Metabase improve.</p>
50145014

50155015
<h3 id="mb_api_key"><code class="language-plaintext highlighter-rouge">MB_API_KEY</code></h3>
50165016

@@ -5323,7 +5323,7 @@ <h3 id="mb_db_connection_timeout_ms"><code class="language-plaintext highlighter
53235323
<li>Default: <code class="language-plaintext highlighter-rouge">10000</code></li>
53245324
</ul>
53255325

5326-
<p>Consider metabase.driver/can-connect? / can-connect-with-details? to have failed if they were unable to
5326+
<p>Consider metabase.driver/can-connect? / can-connect-with-details? to have failed if they were not able to
53275327
successfully connect after this many milliseconds. By default, this is 10 seconds.</p>
53285328

53295329
<p>Timeout in milliseconds for connecting to databases, both Metabase application database and data connections.
@@ -5420,7 +5420,7 @@ <h3 id="mb_email_max_recipients_per_second"><code class="language-plaintext high
54205420
</ul>
54215421

54225422
<p>The maximum number of recipients, summed across emails, that can be sent per second.
5423-
Note that the final email sent before reaching the limit can exceed it, if it has multiple recipients.</p>
5423+
Note that the final email sent before reaching the limit is able to exceed it, if it has multiple recipients.</p>
54245424

54255425
<h3 id="mb_email_reply_to"><code class="language-plaintext highlighter-rouge">MB_EMAIL_REPLY_TO</code></h3>
54265426

@@ -5817,6 +5817,16 @@ <h3 id="mb_help_link_custom_destination"><code class="language-plaintext highlig
58175817

58185818
<p>Custom URL for the help link.</p>
58195819

5820+
<h3 id="mb_hide_stacktraces"><code class="language-plaintext highlighter-rouge">MB_HIDE_STACKTRACES</code></h3>
5821+
5822+
<ul>
5823+
<li>Type: boolean</li>
5824+
<li>Default: <code class="language-plaintext highlighter-rouge">false</code></li>
5825+
<li><a href="./config-file">Configuration file name</a>: <code class="language-plaintext highlighter-rouge">hide-stacktraces</code></li>
5826+
</ul>
5827+
5828+
<p>Prevent the exception middleware from including stacktraces in responses.</p>
5829+
58205830
<h3 id="mb_http_channel_host_strategy"><code class="language-plaintext highlighter-rouge">MB_HTTP_CHANNEL_HOST_STRATEGY</code></h3>
58215831

58225832
<ul>
@@ -6453,7 +6463,7 @@ <h3 id="mb_notification_link_base_url"><code class="language-plaintext highlight
64536463
<p>By default “Site Url” is used in notification links, but can be overridden.</p>
64546464

64556465
<p>The base URL where dashboard notitification links will point to instead of the Metabase base URL.
6456-
Only applicable for users who use interactive embedding and subscriptions.</p>
6466+
Only applicable for users who utilize interactive embedding and subscriptions.</p>
64576467

64586468
<h3 id="mb_notification_system_event_thread_pool_size"><code class="language-plaintext highlighter-rouge">MB_NOTIFICATION_SYSTEM_EVENT_THREAD_POOL_SIZE</code></h3>
64596469

@@ -6538,6 +6548,36 @@ <h3 id="mb_redirect_all_requests_to_https"><code class="language-plaintext highl
65386548

65396549
<p>Force all traffic to use HTTPS via a redirect, if the site URL is HTTPS.</p>
65406550

6551+
<h3 id="mb_remote_sync_auto_import"><code class="language-plaintext highlighter-rouge">MB_REMOTE_SYNC_AUTO_IMPORT</code></h3>
6552+
6553+
<ul>
6554+
<li>Type: boolean</li>
6555+
<li>Default: <code class="language-plaintext highlighter-rouge">false</code></li>
6556+
<li><a href="./config-file">Configuration file name</a>: <code class="language-plaintext highlighter-rouge">remote-sync-auto-import</code></li>
6557+
</ul>
6558+
6559+
<p>Whether to automatically import from the remote git repository. Only applies if remote-sync-type is :production.</p>
6560+
6561+
<h3 id="mb_remote_sync_auto_import_rate"><code class="language-plaintext highlighter-rouge">MB_REMOTE_SYNC_AUTO_IMPORT_RATE</code></h3>
6562+
6563+
<ul>
6564+
<li>Type: integer</li>
6565+
<li>Default: <code class="language-plaintext highlighter-rouge">5</code></li>
6566+
<li><a href="./config-file">Configuration file name</a>: <code class="language-plaintext highlighter-rouge">remote-sync-auto-import-rate</code></li>
6567+
</ul>
6568+
6569+
<p>If remote-sync-type is :production and remote-sync-auto-import is true, the rate (in minutes) at which to check for updates to import. Defaults to 5.</p>
6570+
6571+
<h3 id="mb_remote_sync_task_time_limit_ms"><code class="language-plaintext highlighter-rouge">MB_REMOTE_SYNC_TASK_TIME_LIMIT_MS</code></h3>
6572+
6573+
<ul>
6574+
<li>Type: integer</li>
6575+
<li>Default: <code class="language-plaintext highlighter-rouge">300000</code></li>
6576+
<li><a href="./config-file">Configuration file name</a>: <code class="language-plaintext highlighter-rouge">remote-sync-task-time-limit-ms</code></li>
6577+
</ul>
6578+
6579+
<p>The maximum amount of time a remote sync task will be given to complete.</p>
6580+
65416581
<h3 id="mb_report_timezone"><code class="language-plaintext highlighter-rouge">MB_REPORT_TIMEZONE</code></h3>
65426582

65436583
<ul>
@@ -7008,7 +7048,7 @@ <h3 id="mb_show_homepage_data"><code class="language-plaintext highlighter-rouge
70087048
<li><a href="./config-file">Configuration file name</a>: <code class="language-plaintext highlighter-rouge">show-homepage-data</code></li>
70097049
</ul>
70107050

7011-
<p>Whether or not to display data on the homepage. Admins might turn this off to direct users to better content than raw data.</p>
7051+
<p>Whether or not to display data on the homepage. Admins might turn this off in order to direct users to better content than raw data.</p>
70127052

70137053
<h3 id="mb_show_homepage_xrays"><code class="language-plaintext highlighter-rouge">MB_SHOW_HOMEPAGE_XRAYS</code></h3>
70147054

@@ -7292,20 +7332,6 @@ <h3 id="mb_uploads_table_prefix-deprecated"><code class="language-plaintext high
72927332

72937333
<p>Prefix for upload table names.</p>
72947334

7295-
<h3 id="mb_use_tenants"><code class="language-plaintext highlighter-rouge">MB_USE_TENANTS</code></h3>
7296-
7297-
<blockquote>
7298-
<p>Only available on Metabase <a href="/product/pro">Pro</a> and <a href="/product/enterprise">Enterprise</a> plans.</p>
7299-
</blockquote>
7300-
7301-
<ul>
7302-
<li>Type: boolean</li>
7303-
<li>Default: <code class="language-plaintext highlighter-rouge">false</code></li>
7304-
<li><a href="./config-file">Configuration file name</a>: <code class="language-plaintext highlighter-rouge">use-tenants</code></li>
7305-
</ul>
7306-
7307-
<p>Turn on the Tenants feature, allowing users to be assigned to a particular Tenant.</p>
7308-
73097335
<h3 id="mb_user_visibility"><code class="language-plaintext highlighter-rouge">MB_USER_VISIBILITY</code></h3>
73107336

73117337
<blockquote>
@@ -7364,7 +7390,7 @@ <h3 id="mb_attachment_table_row_limit-1"><code class="language-plaintext highlig
73647390
<p>Type: integer<br>
73657391
Default: <code class="language-plaintext highlighter-rouge">20</code><br></p>
73667392

7367-
<p>Limits the number of rows Metabase will display in tables sent with dashboard subscriptions and alerts. Range: 1-100. To limit the total number of rows included in the file attachment for an email dashboard subscription, use <a href="#mb_unaggregated_query_row_limit">MB_UNAGGREGATED_QUERY_ROW_LIMIT</a>.</p>
7393+
<p>Limits the number of rows Metabase will display in tables sent with dashboard subscriptions and alerts. Range: 1-100. To limit the total number of rows included in the file attachment for an email dashboard subscription, use <a href="#mb_attachment_row_limit">MB_ATTACHMENT_ROW_LIMIT</a>.</p>
73687394

73697395
<h3 id="mb_audit_max_retention_days-1"><code class="language-plaintext highlighter-rouge">MB_AUDIT_MAX_RETENTION_DAYS</code></h3>
73707396

@@ -7543,7 +7569,7 @@ <h3 id="mb_jetty_async_response_timeout"><code class="language-plaintext highlig
75437569
Default: <code class="language-plaintext highlighter-rouge">600000</code><br>
75447570
Since: v35.0</p>
75457571

7546-
<p>Timeout of Jetty async threads, defined in milliseconds. The default is 10 minutes. Few things might reach that timeout, since they return some type of data before, but things like CSV downloads might.</p>
7572+
<p>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.</p>
75477573

75487574
<h3 id="mb_jetty_daemon"><code class="language-plaintext highlighter-rouge">MB_JETTY_DAEMON</code></h3>
75497575

0 commit comments

Comments
 (0)