Skip to content
Snippets Groups Projects
Unverified Commit a223f819 authored by Jeff Bruemmer's avatar Jeff Bruemmer Committed by GitHub
Browse files

docs - add load-sample-content (#49284)

parent 28b0e3c5
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
docs/configuring-metabase/environment-variables.md
+ 79
− 44
View file @ a223f819
......@@ -69,6 +69,36 @@ Must be less than 1048575. This environment variable also affects how many rows
This environment variable also affects how many rows Metabase includes in dashboard subscription attachments.
See also MB_UNAGGREGATED_QUERY_ROW_LIMIT.
### `MB_ALLOWED_IFRAME_HOSTS`
- Type: string
- Default: `youtube.com,
youtu.be,
loom.com,
vimeo.com,
docs.google.com,
calendar.google.com,
airtable.com,
typeform.com,
canva.com,
codepen.io,
figma.com,
grafana.com,
miro.com,
excalidraw.com,
notion.com,
atlassian.com,
trello.com,
asana.com,
gist.github.com,
linkedin.com,
twitter.com,
x.com`
- [Exported as](../installation-and-operation/serialization.md): `allowed-iframe-hosts`.
- [Configuration file name](./config-file.md): `allowed-iframe-hosts`
Allowed iframe hosts.
### `MB_ANON_TRACKING_ENABLED`
- Type: boolean
......@@ -77,17 +107,6 @@ Must be less than 1048575. This environment variable also affects how many rows
Enable the collection of anonymous usage data in order to help Metabase improve.
### `MB_API_KEY`
- Type: string
- Default: `null`
When set, this API key is required for all API requests.
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 on Metabase [Pro](https://www.metabase.com/product/pro) and [Enterprise](https://www.metabase.com/product/enterprise) plans.
......@@ -411,15 +430,25 @@ SMTP secure connection protocol. (tls, ssl, starttls, or none).
SMTP username.
### `MB_EMBEDDING_APP_ORIGIN`
### `MB_EMBEDDING_APP_ORIGINS_INTERACTIVE`
> Only available on Metabase [Pro](https://www.metabase.com/product/pro) and [Enterprise](https://www.metabase.com/product/enterprise) plans.
- Type: string
- Default: `null`
- [Configuration file name](./config-file.md): `embedding-app-origin`
- [Configuration file name](./config-file.md): `embedding-app-origins-interactive`
Allow these space delimited origins to embed Metabase interactive.
### `MB_EMBEDDING_APP_ORIGINS_SDK`
> Only available on Metabase [Pro](https://www.metabase.com/product/pro) and [Enterprise](https://www.metabase.com/product/enterprise) plans.
- Type: string
- Default: `localhost:*`
- [Configuration file name](./config-file.md): `embedding-app-origins-sdk`
Allow this origin to embed the full Metabase application.
Allow Metabase SDK access to these space delimited origins.
### `MB_EMBEDDING_HOMEPAGE`
......@@ -438,14 +467,29 @@ Embedding homepage status, indicating if its visible, hidden or has been dismiss
Secret key used to sign JSON Web Tokens for requests to `/api/embed` endpoints.
### `MB_ENABLE_EMBEDDING`
### `MB_ENABLE_EMBEDDING_INTERACTIVE`
- Type: boolean
- Default: `false`
- [Exported as](../installation-and-operation/serialization.md): `enable-embedding`.
- [Configuration file name](./config-file.md): `enable-embedding`
- [Configuration file name](./config-file.md): `enable-embedding-interactive`
Allow admins to securely embed questions and dashboards within other applications?
Allow admins to embed Metabase via interactive embedding?
### `MB_ENABLE_EMBEDDING_SDK`
- Type: boolean
- Default: `false`
- [Configuration file name](./config-file.md): `enable-embedding-sdk`
Allow admins to embed Metabase via the SDK?
### `MB_ENABLE_EMBEDDING_STATIC`
- Type: boolean
- Default: `false`
- [Configuration file name](./config-file.md): `enable-embedding-static`
Allow admins to embed Metabase via static embedding?
### `MB_ENABLE_PASSWORD_LOGIN`
......@@ -1010,6 +1054,13 @@ 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 utilize interactive embedding and subscriptions.
### `MB_NOTIFICATION_THREAD_POOL_SIZE`
- Type: integer
- Default: `10`
The size of the thread pool used to send notifications.
### `MB_NUM_METABOT_CHOICES`
- Type: integer
......@@ -1352,7 +1403,7 @@ Should new email notifications be sent to admins, for all new SSO users?
Value for the session cookies `SameSite` directive.
See [Embedding Metabase in a different domain](../embedding/interactive-embedding.md#embedding-metabase-in-a-different-domain).
Related to [MB_EMBEDDING_APP_ORIGIN](#mb_embedding_app_origin). Read more about [interactive Embedding](../embedding/interactive-embedding.md).
Read more about [interactive Embedding](../embedding/interactive-embedding.md).
Learn more about [SameSite cookies](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite).
### `MB_SESSION_COOKIES`
......@@ -1585,7 +1636,7 @@ Must be less than 1048575, and less than the number configured in MB_AGGREGATED_
- [Exported as](../installation-and-operation/serialization.md): `update-channel`.
- [Configuration file name](./config-file.md): `update-channel`
Metabase will notify you when a new release is available for the channel you select.
Well notify you here when theres a new version of this type of release.
### `MB_UPLOADS_SETTINGS`
......@@ -1963,7 +2014,14 @@ Default page to show people when they log in.
Type: Boolean<br>
Default: True
If you want to exclude the [Usage analytics](../usage-and-performance-tools/usage-analytics.md) collection, you can set `MB_LOAD_ANALYTICS_CONTENT=false`. Setting this environment variable to false can also come in handy when migrating environments, as it can simplify the migration process.
If you want to exclude the [Metabase analytics](../usage-and-performance-tools/usage-analytics.md) collection, you can set `MB_LOAD_ANALYTICS_CONTENT=false`. Setting this environment variable to false can also come in handy when migrating environments, as it can simplify the migration process.
### `MB_LOAD_SAMPLE_CONTENT`
Type: Boolean<br>
Default: True
Whether to include the Sample Database in your Metabase. To exclude the Sample Database, set `MB_LOAD_SAMPLE_CONTENT=false`.
### `MB_NO_SURVEYS`
......@@ -2056,29 +2114,6 @@ Default: `true`
Send email notifications to users in Admin group, when a new SSO users is created on Metabase.
### `MB_SESSION_COOKIE_SAMESITE`
Only available on Metabase [Pro](https://www.metabase.com/product/pro) and [Enterprise](https://www.metabase.com/product/enterprise) plans.<br>
Type: string (`"none"`, `"lax"`, `"strict"`)<br>
Default: `"lax"`
See [Embedding Metabase in a different domain](../embedding/interactive-embedding.md#embedding-metabase-in-a-different-domain).
Related to [MB_EMBEDDING_APP_ORIGIN](#mb_embedding_app_origin). Read more about [interactive Embedding](../embedding/interactive-embedding.md).
Learn more about SameSite cookies: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite
### `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](../people-and-groups/changing-session-expiration.md) documentation page.
### `MB_SETUP_TOKEN`
Type: string<br>
......
src/metabase/cmd/resources/other-env-vars.md
+ 7
− 23
View file @ a223f819
......@@ -358,6 +358,13 @@ Default: True
If you want to exclude the [Metabase analytics](../usage-and-performance-tools/usage-analytics.md) collection, you can set `MB_LOAD_ANALYTICS_CONTENT=false`. Setting this environment variable to false can also come in handy when migrating environments, as it can simplify the migration process.
### `MB_LOAD_SAMPLE_CONTENT`
Type: Boolean<br>
Default: True
Whether to include the Sample Database in your Metabase. To exclude the Sample Database, set `MB_LOAD_SAMPLE_CONTENT=false`.
### `MB_NO_SURVEYS`
Type: boolean<br>
......@@ -449,29 +456,6 @@ Default: `true`
Send email notifications to users in Admin group, when a new SSO users is created on Metabase.
### `MB_SESSION_COOKIE_SAMESITE`
Only available on Metabase [Pro](https://www.metabase.com/product/pro) and [Enterprise](https://www.metabase.com/product/enterprise) plans.<br>
Type: string (`"none"`, `"lax"`, `"strict"`)<br>
Default: `"lax"`
See [Embedding Metabase in a different domain](../embedding/interactive-embedding.md#embedding-metabase-in-a-different-domain).
Related to [MB_EMBEDDING_APP_ORIGIN](#mb_embedding_app_origin). Read more about [interactive Embedding](../embedding/interactive-embedding.md).
Learn more about SameSite cookies: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite
### `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](../people-and-groups/changing-session-expiration.md) documentation page.
### `MB_SETUP_TOKEN`
Type: string<br>
......
src/metabase/server/middleware/session.clj
+ 1
− 1
View file @ a223f819
......@@ -107,7 +107,7 @@
:session-cookie-samesite normalized-value
:http-status 400})))))
:doc "See [Embedding Metabase in a different domain](../embedding/interactive-embedding.md#embedding-metabase-in-a-different-domain).
Related to [MB_EMBEDDING_APP_ORIGIN](#mb_embedding_app_origin). Read more about [interactive Embedding](../embedding/interactive-embedding.md).
Read more about [interactive Embedding](../embedding/interactive-embedding.md).
Learn more about [SameSite cookies](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite).")
(defmulti default-session-cookie-attributes
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment