Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions _docs/master/api.json
Original file line number Diff line number Diff line change
Expand Up @@ -11676,6 +11676,9 @@
"parameter_mappings" : {
"$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mappings"
},
"embedding_type" : {
"type" : "string"
},
"name" : {
"type" : "string",
"minLength" : 1
Expand Down Expand Up @@ -13834,6 +13837,9 @@
"type" : "string",
"enum" : [ "fixed", "full" ]
},
"embedding_type" : {
"type" : "string"
},
"show_in_getting_started" : {
"type" : "boolean"
},
Expand Down
5 changes: 4 additions & 1 deletion _docs/master/configuring-metabase/config-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,7 @@ config:
health-check-logging-enabled: true
help-link: metabase
help-link-custom-destination: https://www.metabase.com/help/premium
hide-stacktraces: false
http-channel-host-strategy: external-only
humanization-strategy: simple
index-update-thread-count: 2
Expand Down Expand Up @@ -222,6 +223,9 @@ config:
query-caching-max-kb: 2000
query-caching-max-ttl: 3024000.0
redirect-all-requests-to-https: false
remote-sync-auto-import: false
remote-sync-auto-import-rate: 5
remote-sync-task-time-limit-ms: 300000
report-timezone: null
reset-token-ttl-hours: 48
retry-initial-interval: 500
Expand Down Expand Up @@ -279,6 +283,5 @@ config:
synchronous-batch-updates: false
unaggregated-query-row-limit: null
uploads-settings: null
use-tenants: false
user-visibility: all
```
56 changes: 39 additions & 17 deletions _docs/master/configuring-metabase/environment-variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ Allowed iframe hosts.
- Default: `true`
- [Configuration file name](./config-file): `anon-tracking-enabled`

Enable the collection of anonymous usage data to help Metabase improve.
Enable the collection of anonymous usage data in order to help Metabase improve.

### `MB_API_KEY`

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

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

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

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

### `MB_EMAIL_REPLY_TO`

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

Custom URL for the help link.

### `MB_HIDE_STACKTRACES`

- Type: boolean
- Default: `false`
- [Configuration file name](./config-file): `hide-stacktraces`

Prevent the exception middleware from including stacktraces in responses.

### `MB_HTTP_CHANNEL_HOST_STRATEGY`

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

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

### `MB_NOTIFICATION_SYSTEM_EVENT_THREAD_POOL_SIZE`

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

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

### `MB_REMOTE_SYNC_AUTO_IMPORT`

- Type: boolean
- Default: `false`
- [Configuration file name](./config-file): `remote-sync-auto-import`

Whether to automatically import from the remote git repository. Only applies if remote-sync-type is :production.

### `MB_REMOTE_SYNC_AUTO_IMPORT_RATE`

- Type: integer
- Default: `5`
- [Configuration file name](./config-file): `remote-sync-auto-import-rate`

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.

### `MB_REMOTE_SYNC_TASK_TIME_LIMIT_MS`

- Type: integer
- Default: `300000`
- [Configuration file name](./config-file): `remote-sync-task-time-limit-ms`

The maximum amount of time a remote sync task will be given to complete.

### `MB_REPORT_TIMEZONE`

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

Whether or not to display data on the homepage. Admins might turn this off to direct users to better content than raw data.
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.

### `MB_SHOW_HOMEPAGE_XRAYS`

Expand Down Expand Up @@ -1893,16 +1925,6 @@ Upload settings.

Prefix for upload table names.

### `MB_USE_TENANTS`

> Only available on Metabase [Pro](/product/pro) and [Enterprise](/product/enterprise) plans.

- Type: boolean
- Default: `false`
- [Configuration file name](./config-file): `use-tenants`

Turn on the Tenants feature, allowing users to be assigned to a particular Tenant.

### `MB_USER_VISIBILITY`

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

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).
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).

### `MB_AUDIT_MAX_RETENTION_DAYS`

Expand Down Expand Up @@ -2135,7 +2157,7 @@ Type: integer<br>
Default: `600000`<br>
Since: v35.0

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.
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`

Expand Down
6 changes: 4 additions & 2 deletions _docs/master/permissions/application.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,11 @@ Monitoring access sets permissions for the following:

## Subscriptions and alerts

This setting determines who can set up:
This setting determines who can create:

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

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).
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).

To prevent people from creating alerts and subscriptions, set the "Subscriptions and alerts" permission to "No".
6 changes: 6 additions & 0 deletions _site/docs/master/api.json
Original file line number Diff line number Diff line change
Expand Up @@ -11676,6 +11676,9 @@
"parameter_mappings" : {
"$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mappings"
},
"embedding_type" : {
"type" : "string"
},
"name" : {
"type" : "string",
"minLength" : 1
Expand Down Expand Up @@ -13834,6 +13837,9 @@
"type" : "string",
"enum" : [ "fixed", "full" ]
},
"embedding_type" : {
"type" : "string"
},
"show_in_getting_started" : {
"type" : "boolean"
},
Expand Down
5 changes: 4 additions & 1 deletion _site/docs/master/configuring-metabase/config-template.html
Original file line number Diff line number Diff line change
Expand Up @@ -5054,6 +5054,7 @@ <h1 id="metabase-config-file-template">Metabase config file template</h1>
<span class="na">health-check-logging-enabled</span><span class="pi">:</span> <span class="kc">true</span>
<span class="na">help-link</span><span class="pi">:</span> <span class="s">metabase</span>
<span class="na">help-link-custom-destination</span><span class="pi">:</span> <span class="s">https://www.metabase.com/help/premium</span>
<span class="na">hide-stacktraces</span><span class="pi">:</span> <span class="kc">false</span>
<span class="na">http-channel-host-strategy</span><span class="pi">:</span> <span class="s">external-only</span>
<span class="na">humanization-strategy</span><span class="pi">:</span> <span class="s">simple</span>
<span class="na">index-update-thread-count</span><span class="pi">:</span> <span class="m">2</span>
Expand Down Expand Up @@ -5114,6 +5115,9 @@ <h1 id="metabase-config-file-template">Metabase config file template</h1>
<span class="na">query-caching-max-kb</span><span class="pi">:</span> <span class="m">2000</span>
<span class="na">query-caching-max-ttl</span><span class="pi">:</span> <span class="m">3024000.0</span>
<span class="na">redirect-all-requests-to-https</span><span class="pi">:</span> <span class="kc">false</span>
<span class="na">remote-sync-auto-import</span><span class="pi">:</span> <span class="kc">false</span>
<span class="na">remote-sync-auto-import-rate</span><span class="pi">:</span> <span class="m">5</span>
<span class="na">remote-sync-task-time-limit-ms</span><span class="pi">:</span> <span class="m">300000</span>
<span class="na">report-timezone</span><span class="pi">:</span> <span class="kc">null</span>
<span class="na">reset-token-ttl-hours</span><span class="pi">:</span> <span class="m">48</span>
<span class="na">retry-initial-interval</span><span class="pi">:</span> <span class="m">500</span>
Expand Down Expand Up @@ -5171,7 +5175,6 @@ <h1 id="metabase-config-file-template">Metabase config file template</h1>
<span class="na">synchronous-batch-updates</span><span class="pi">:</span> <span class="kc">false</span>
<span class="na">unaggregated-query-row-limit</span><span class="pi">:</span> <span class="kc">null</span>
<span class="na">uploads-settings</span><span class="pi">:</span> <span class="kc">null</span>
<span class="na">use-tenants</span><span class="pi">:</span> <span class="kc">false</span>
<span class="na">user-visibility</span><span class="pi">:</span> <span class="s">all</span>
</code></pre></div></div>

Expand Down
68 changes: 47 additions & 21 deletions _site/docs/master/configuring-metabase/environment-variables.html
Original file line number Diff line number Diff line change
Expand Up @@ -5010,7 +5010,7 @@ <h3 id="mb_anon_tracking_enabled"><code class="language-plaintext highlighter-ro
<li><a href="./config-file">Configuration file name</a>: <code class="language-plaintext highlighter-rouge">anon-tracking-enabled</code></li>
</ul>

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

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

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

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

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

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

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

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

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

<h3 id="mb_hide_stacktraces"><code class="language-plaintext highlighter-rouge">MB_HIDE_STACKTRACES</code></h3>

<ul>
<li>Type: boolean</li>
<li>Default: <code class="language-plaintext highlighter-rouge">false</code></li>
<li><a href="./config-file">Configuration file name</a>: <code class="language-plaintext highlighter-rouge">hide-stacktraces</code></li>
</ul>

<p>Prevent the exception middleware from including stacktraces in responses.</p>

<h3 id="mb_http_channel_host_strategy"><code class="language-plaintext highlighter-rouge">MB_HTTP_CHANNEL_HOST_STRATEGY</code></h3>

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

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

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

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

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

<h3 id="mb_remote_sync_auto_import"><code class="language-plaintext highlighter-rouge">MB_REMOTE_SYNC_AUTO_IMPORT</code></h3>

<ul>
<li>Type: boolean</li>
<li>Default: <code class="language-plaintext highlighter-rouge">false</code></li>
<li><a href="./config-file">Configuration file name</a>: <code class="language-plaintext highlighter-rouge">remote-sync-auto-import</code></li>
</ul>

<p>Whether to automatically import from the remote git repository. Only applies if remote-sync-type is :production.</p>

<h3 id="mb_remote_sync_auto_import_rate"><code class="language-plaintext highlighter-rouge">MB_REMOTE_SYNC_AUTO_IMPORT_RATE</code></h3>

<ul>
<li>Type: integer</li>
<li>Default: <code class="language-plaintext highlighter-rouge">5</code></li>
<li><a href="./config-file">Configuration file name</a>: <code class="language-plaintext highlighter-rouge">remote-sync-auto-import-rate</code></li>
</ul>

<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>

<h3 id="mb_remote_sync_task_time_limit_ms"><code class="language-plaintext highlighter-rouge">MB_REMOTE_SYNC_TASK_TIME_LIMIT_MS</code></h3>

<ul>
<li>Type: integer</li>
<li>Default: <code class="language-plaintext highlighter-rouge">300000</code></li>
<li><a href="./config-file">Configuration file name</a>: <code class="language-plaintext highlighter-rouge">remote-sync-task-time-limit-ms</code></li>
</ul>

<p>The maximum amount of time a remote sync task will be given to complete.</p>

<h3 id="mb_report_timezone"><code class="language-plaintext highlighter-rouge">MB_REPORT_TIMEZONE</code></h3>

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

<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>
<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>

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

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

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

<h3 id="mb_use_tenants"><code class="language-plaintext highlighter-rouge">MB_USE_TENANTS</code></h3>

<blockquote>
<p>Only available on Metabase <a href="/product/pro">Pro</a> and <a href="/product/enterprise">Enterprise</a> plans.</p>
</blockquote>

<ul>
<li>Type: boolean</li>
<li>Default: <code class="language-plaintext highlighter-rouge">false</code></li>
<li><a href="./config-file">Configuration file name</a>: <code class="language-plaintext highlighter-rouge">use-tenants</code></li>
</ul>

<p>Turn on the Tenants feature, allowing users to be assigned to a particular Tenant.</p>

<h3 id="mb_user_visibility"><code class="language-plaintext highlighter-rouge">MB_USER_VISIBILITY</code></h3>

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

<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>
<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>

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

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

<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>
<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>

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

Expand Down
Loading