The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:
TypeScript analyticsbibusiness-intelligencebusinessintelligenceclojuredashboarddatadata-analysisdata-visualizationdatabasemetabasemysqlpostgrespostgresqlreportingslacksql-editorvisualization
docs: embedding hub changes (#64012)
Alex Yarosh7ac8feb49b50
diff --git a/docs/embedding/embedded-analytics-js.md b/docs/embedding/embedded-analytics-js.mdindex e069a760f75..36ad6bd4244 100644--- a/docs/embedding/embedded-analytics-js.md+++ b/docs/embedding/embedded-analytics-js.md@@ -23,20 +23,25 @@ Currently you can choose to embed:## Quickstart+You can also follow the setup guide directly in Metabase in **Admin > Embedding > Setup guide**. We're recording the steps here for convenience.+### 1. Enable Embedded Analytics JS-1. In Metabase, go to **Admin Settings > Embedding > Modular embedding**.+1. In Metabase, go to **Admin > Embedding > Modular embedding**.2. Toggle on **Embedded Analytics JS**.3. Under **Cross-Origin Resource Sharing (CORS)**, add the URLs of the websites where you want to embed Metabase (such as `https://*.example.com`). For testing embeds, you can use `localhost` which is always included in CORS policy.### 2. Create a new embed-1. In Metabase, go to **Admin Settings > Embedding > Quick start** and select **Create embed**. Note that this will only be visible to admins.+1. In Metabase, go to **Admin > Embedding > Setup guide > Embed in your code**, and select **Try it out** next to **Embedded analytics JS**.++ If you're planning to embed an existing question or dashboard, you can instead go straight to that question or dashboard, click on the **Share** button, and choose **Embedded Analytics JS**.+2. Choose the _type_ of entity to embed:- - Dashboard- - Question- - Exploration (which will embed the Metabase query builder)- - Browser+ - Dashboard+ - Question+ - Exploration (which will embed the Metabase query builder)+ - Browser3. Next, select the entity you want to embed. For browser, pick the collection you want people to start from.Once you've selected what you want to embed, click Next to customize your embed.@@ -109,13 +114,13 @@ Note the `defer` attribute and the reference to your Metabase URL in the scriptIf you're embedding multiple entities on the same page, you only need to include the `<script>` tags once globally.-You can also generate the code snippet for Embedded Analytics JS interactively in Metabase through **Admin Settings > Embedding > Setup guide > Create embed**. Check out the [Quickstart](#quickstart).+You can also generate the code snippet for Embedded Analytics JS interactively in Metabase through **Admin > Embedding > Setup guide > Embed in your code**. Check out the [quickstart](#quickstart).## Customizing embedsThe exact customization options you see will depend on what type of entity you're embedding.-When you're creating a new embed using **Admin Settings > Embedding > Setup guide > Create embed**, you'll see the following customization options in the interactive creation flow. These options correspond to parameters in [components](#components).+When you're creating a new embed using **Admin > Embedding > Setup guide > Embed in your code**, you'll see the following customization options in the interactive creation flow. These options correspond to parameters in [components](#components).- **Allow people to drill through on data points**: determines whether people can interact with the chart (or charts on a dashboard). Interactivity includes [drilling down](https://www.metabase.com/learn/metabase-basics/querying-and-dashboards/questions/drill-through) to individual records from aggregated questions, filtering on click, zooming in, etc. Disabling drill-through for an embedded _question_ also disables people's ability to add filters and summaries.@@ -360,7 +365,7 @@ To render a question (chart).To render a collection browser so people can navigate a collection and open dashboards or questions.- ```html+```html<metabase-browser initial-collection="14" read-only="false"></metabase-browser>```diff --git a/docs/embedding/images/jwt-setup.png b/docs/embedding/images/jwt-setup.pngindex 005a76fc45d..193243e53f7 100644Binary files a/docs/embedding/images/jwt-setup.png and b/docs/embedding/images/jwt-setup.png differdiff --git a/docs/embedding/interactive-embedding-quick-start-guide.md b/docs/embedding/interactive-embedding-quick-start-guide.mdindex 6c1a3b4070a..e8ba94bc6ef 100644--- a/docs/embedding/interactive-embedding-quick-start-guide.md+++ b/docs/embedding/interactive-embedding-quick-start-guide.md@@ -29,9 +29,9 @@ You could also use the dashboard's [Entity ID](../installation-and-operation/ser### Enable interactive embedding-In Metabase, click on the **gear** icon in the upper right and go to **Admin settings** > **Settings** > **Embedding**. Look for **Interactive Embedding** and click on the **Enabled** toggle.+In Metabase, click on the **gear** icon in the upper right and go to **Admin > Embedding > Interactive Embedding** and toggle on **Enable interactive embedding**.-Click on the **Configure** button under **Interactive Embedding**. Under **Authorized origins**, add the URL of the website or web app where you want to embed Metabase. If you're running your app locally, you can add localhost and specify the port number, e.g. `http://localhost:8080`.+Under **Authorized origins**, add the URL of the website or web app where you want to embed Metabase. If you're running your app locally, you can add localhost and specify the port number, e.g. `http://localhost:8080`.#### SameSite configuration@@ -41,7 +41,7 @@ If you're embedding Metabase in a different domain, you may need to [set the ses#### Enable authentication with JWT-While still in the Admin panel's **Settings** section, click on **Authentication**.+While still in the **Interactive embedding** section, click on **Authentication** under **Related settings**.On the card that says **JWT**, click the **Setup** button (you may have to scroll down to view the JWT card).@@ -169,7 +169,7 @@ In Metabase, click the **gear** icon and go to **Admin settings** > **People** >You'll map this string in the `groups` key to a Metabase group, so that when the person signs in via SSO, Metabase automatically assigns them to the appropriate Metabase group.-In Metabase's admin section, go to **Settings** > **Authentication**. Scroll to the **JWT** card and click **Edit**.+In Metabase's admin section, go to **Authentication > JWT** and click **Edit**.In the **Group schema** section, toggle on **Synchronize group memberships**. If the names of groups in the `groups` array match Metabase group names exactly (e.g. both are `"Customer Acme"`), then the groups will be mapped automatically.diff --git a/docs/embedding/interactive-embedding.md b/docs/embedding/interactive-embedding.mdindex f9d5b028214..59f930b92a1 100644--- a/docs/embedding/interactive-embedding.md+++ b/docs/embedding/interactive-embedding.md@@ -40,10 +40,9 @@ If you have your app running locally, and you're using the Pro Cloud version, or## Enabling interactive embedding in Metabase-1. Go to **Settings** > **Admin settings** > **Embedding**.-2. Click **Enable**.-3. Click **Interactive embedding**.-4. Under **Authorized origins**, add the URL of the website or web app where you want to embed Metabase (such as `https://*.example.com`).+1. Go to **Admin > Embedding > Interactive**.+2. Click **Enable interactive embedding**.+3. Under **Authorized origins**, add the URL of the website or web app where you want to embed Metabase (such as `https://*.example.com`).## Setting up embedding on your website@@ -131,7 +130,7 @@ Note that your interactive embed must be compatible with Safari to run on _any_If you want to embed Metabase in another domain (say, if Metabase is hosted at `metabase.yourcompany.com`, but you want to embed Metabase at `yourcompany.github.io`), you can tell Metabase to set the session cookie's SameSite value to "none".-You can set session cookie's SameSite value in **Admin settings** > **Embedding** > **Interactive embedding** > **SameSite cookie setting**.+You can set session cookie's SameSite value in **Admin settings** > **Embedding** > **Interactive** > **SameSite cookie setting**.SameSite values include:diff --git a/docs/embedding/introduction.md b/docs/embedding/introduction.mdindex dc546bb9f3a..bd9f596fe52 100644--- a/docs/embedding/introduction.md+++ b/docs/embedding/introduction.md@@ -12,12 +12,6 @@ Here are the different ways you can embed Metabase.{% include shared/in-page-promo-embedding-workshop.html %}-## Embedded analytics SDK with React--With the [Embedded analytics SDK](./sdk/introduction.md), you can embed individual Metabase components with React (like standalone charts, dashboards, the query builder, and more). You can manage access and interactivity per component, and you have advanced customization for seamless styling.--**When to use the Embedded analytics SDK**: you want the most control over how you embed Metabase in your React app.-## Embedded analytics JSWith [Embedded analytics JS](./embedded-analytics-js.md), you can embed individual Metabase components in your web app with JavaScript — no React required. Choose from dashboards, questions, or the query builder, and configure per‑component options like drill‑through, parameters, downloads, and theming. Embedded Analytics JS integrates with [SSO](securing-embeds.md) and [data permissions](../permissions/embedding.md).diff --git a/docs/embedding/public-links.md b/docs/embedding/public-links.mdindex c5945c53e4e..8792324dc1a 100644--- a/docs/embedding/public-links.md+++ b/docs/embedding/public-links.md@@ -65,9 +65,9 @@ You can simulate drill-through on a public dashboard by setting up a [custom cli6. Optional: pass a filter value from the primary dashboard to the destination dashboard by adding a query parameter to the end of the destination URL:```-{%raw%}+{% raw %}/public/dashboard/?child_filter_name={{parent_column_name}}-{%endraw%}+{% endraw %}```For example, if you have a primary public dashboard that displays **Invoices** data, you can pass the **Plan** name (on click) to a destination public dashboard that displays **Accounts** data:diff --git a/docs/embedding/sdk/introduction.md b/docs/embedding/sdk/introduction.mdindex 27e3572ef23..e3637c39cda 100644--- a/docs/embedding/sdk/introduction.md+++ b/docs/embedding/sdk/introduction.md@@ -36,7 +36,9 @@ To use the SDK, you'll need to enable the SDK in Metabase, and install the SDK i### Enable the SDK in Metabase-Enable the Embedded analytics SDK by going to **Admin settings > Settings > Embedding**. Toggle on the SDK, and hit **Configure**. Enter the origins for your website or app where you want to allow SDK embedding, separated by a space. Localhost is automatically included.+1. Enable the Embedded analytics SDK by going to **Admin settings > Embedding > Modular**.+2. Toggle on **SDK for React**.+3. In **Cross-Origin Resource Sharing (CORS)**, enter the origins for your website or app where you want to allow SDK embedding, separated by a space. Localhost is automatically included.### Install the SDK in your React applicationdiff --git a/docs/embedding/sdk/quickstart-with-sample-app.md b/docs/embedding/sdk/quickstart-with-sample-app.mdindex f8713b76d78..727a5675616 100644--- a/docs/embedding/sdk/quickstart-with-sample-app.md+++ b/docs/embedding/sdk/quickstart-with-sample-app.md@@ -98,11 +98,11 @@ To enable SSO with JWT when self-hosting, you'll need to [activate your license]## Enable embedding in Metabase-From any Metabase page, click on the **gear** icon in the upper right and select **Admin Settings** > **Settings** > **Embedding**.+From any Metabase page, click on the **gear** icon in the upper right and select **Admin Settings** > **Embedding**.Turn on:-- Embedded analytics SDK+- Embedded analytics SDK (it's in in the **Modular** section)- Static embeddingOtherwise, this whole thing is hopeless.diff --git a/docs/embedding/sdk/quickstart.md b/docs/embedding/sdk/quickstart.mdindex 6a304f7880b..ce8ce0abfea 100644--- a/docs/embedding/sdk/quickstart.md+++ b/docs/embedding/sdk/quickstart.md@@ -36,11 +36,11 @@ To embed a dashboard in your app using the SDK, you'll need to:## 1. Enable the SDK in Metabase-In Metabase, click on the gear icon in the upper right and navigate to **Admin Settings > Settings > Embedding** and enable the Embedded analytics SDK.+In Metabase, click on the gear icon in the upper right and navigate to **Admin Settings > Embedding > Modular** and enable the **SDK for React**.## 2. Create an API key in Metabase-Still in the Admin's Settings tab, navigate to the **Authentication** section in the sidebar and click on the **API keys** tab. [Create a new API key](../../people-and-groups/api-keys.md).+Still in the Admin console, go to **Settings > Authentication** and click on the **API keys** tab. [Create a new API key](../../people-and-groups/api-keys.md).- Key name: "Embedded analytics SDK" (just to make the key easy to identify).- Group: select “Admin” (since this is only for local testing).diff --git a/docs/embedding/sdk/version.md b/docs/embedding/sdk/version.mdindex 6463df13114..6ad77a7ad85 100644--- a/docs/embedding/sdk/version.md+++ b/docs/embedding/sdk/version.md@@ -30,8 +30,7 @@ Metabase Cloud upgrades your instance automatically as new versions roll out. BuTo manually pin your version of Metabase:-1. Go to **Admin settings > Settings > Embedding**.-2. Go to the Embedded analytics SDK card.-3. Scroll to **Version pinning** and click **Request version pinning**.+1. Go to **Admin > Embedding > Modular**.+2. Scroll to **Version pinning** and click **Request version pinning**.This will open a mailto link to our support team.diff --git a/docs/embedding/start.md b/docs/embedding/start.mdindex 261921942e8..af862c9fa30 100644--- a/docs/embedding/start.md+++ b/docs/embedding/start.md@@ -10,25 +10,13 @@ redirect_from:What is embedding, and how does it work?-## [Interactive embedding](./interactive-embedding.md)--The solution to self-service customer analytics: embed the full Metabase app in your app. Interactive embedding integrates with your data permissions to let people slice and dice data on their own using Metabase's query builder.--## [Interactive embedding quickstart](./interactive-embedding-quick-start-guide.md)--You'll embed the full Metabase application in your app. Once logged in, people can view a Metabase dashboard in your web app, and be able to use the full Metabase application to explore their data, and only their data.--## [Interactive UI components](./interactive-ui-components.md)--Customize the UI components in your interactive embed by adding parameters to the embedding URL.-## [Embedded analytics SDK](./sdk/introduction.md)With the Embedded analytics SDK, you can embed individual Metabase components with React (like standalone charts, dashboards, the query builder, and more). You can manage access and interactivity per component, and you have advanced customization for seamless styling.## [Embedded analytics JS](./embedded-analytics-js.md)-Embed dashboards, questions, or the query builder in your app with JavaScript (no React required). Built on the Embedded analytics SDK with per-component controls and theming.+Embed dashboards, questions, or the query builder in your app with JavaScript (no React required). Built on the Embedded analytics SDK with per-component controls and theming. Integrate your app's auth with Metabase SSO.## [Embedded analytics SDK quickstart](./sdk/quickstart.md)@@ -42,6 +30,18 @@ Also known as Signed Embedding, Static embedding is a secure way to embed chartsYou can pass parameters between Metabase and your website via the embedding URL to specify how Metabase items should look and behave inside the iframe on your website.+## [Interactive embedding](./interactive-embedding.md)++Interactive embedding allows you to embed full Metabase app in an iframe. Interactive embedding integrates with your data permissions to let people slice and dice data on their own using Metabase's query builder.++## [Interactive embedding quickstart](./interactive-embedding-quick-start-guide.md)++You'll embed the full Metabase application in your app. Once logged in, people can view a Metabase dashboard in your web app, and be able to use the full Metabase application to explore their data, and only their data.++## [Interactive UI components](./interactive-ui-components.md)++Customize the UI components in your interactive embed by adding parameters to the embedding URL.+## [Public embeds](./public-links.md)Admins can also create unsecured public links or embeds of questions and dashboards.diff --git a/docs/embedding/static-embedding.md b/docs/embedding/static-embedding.mdindex 69af9b337c4..9e3eefaa13f 100644--- a/docs/embedding/static-embedding.md+++ b/docs/embedding/static-embedding.md@@ -12,7 +12,7 @@ Also known as: standalone embedding, or signed embedding.In general, embedding works by displaying a Metabase URL inside an iframe in your website. A **static embed** (or signed embed) is an iframe that's loading a Metabase URL secured with a signed JSON Web Token (JWT). Metabase will only load the URL if the request supplies a JWT signed with the secret shared between your app and your Metabase. The JWT also includes a reference to the resource to load, e.g., the dashboard ID, and any values for locked parameters.-You can't use static embeds with [row and column security](../permissions/row-and-column-security.md), [drill-through](https://www.metabase.com/learn/metabase-basics/querying-and-dashboards/questions/drill-through), and user-specific data isn't captured in [usage analytics](../usage-and-performance-tools/usage-analytics.md) because signed JWTs don't create user sessions (server-side sessions). For those features, check out [interactive embedding](./interactive-embedding.md).+You can't use static embeds with [row and column security](../permissions/row-and-column-security.md), [drill-through](https://www.metabase.com/learn/metabase-basics/querying-and-dashboards/questions/drill-through), and user-specific data isn't captured in [usage analytics](../usage-and-performance-tools/usage-analytics.md) because signed JWTs don't create user sessions (server-side sessions). For those features, check out [Embedded analytics JS](./embedded-analytics-js.md).You can, however, restrict data in static embeds for specific people or groups by [locking parameters](./static-embedding-parameters.md#restricting-data-in-a-static-embed-with-locked-parameters).@@ -34,12 +34,12 @@ your_metabase_embedding_url/your_signed_jwt?filter=trueThe signed JWT is generated using your [Metabase secret key](#regenerating-the-static-embedding-secret-key). The secret key tells Metabase that the request for filtered data can be trusted, so it's safe to display the results at the new embedding URL. Note that this secret key is shared for all static embeds, so whoever has access to that key will have access to all embedded artifacts.-If you want to embed charts with additional interactive features, like [drill-down](https://www.metabase.com/learn/metabase-basics/querying-and-dashboards/questions/drill-through) and [self-service querying](../questions/query-builder/editor.md), see [Interactive embedding](./interactive-embedding.md).+If you want to embed charts with additional interactive features, like [drill-down](https://www.metabase.com/learn/metabase-basics/querying-and-dashboards/questions/drill-through) and [self-service querying](../questions/query-builder/editor.md), see [Embedded analytics JS](./embedded-analytics-js.md).## Turning on the embedding feature in Metabase-1. Go to **Settings** > **Admin settings** > **Embedding**.-2. Toggle the **Enable embedding**.+1. Go to **Settings** > **Admin settings** > **Embedding > Static**.+2. Toggle **Enable static embedding**.## Making a question or dashboard embeddable@@ -127,7 +127,7 @@ If you change the [parameters](./static-embedding-parameters.md) of your embedde## Disabling embedding for a question or dashboard-You can find a list of all static embeds of questions and dashboards from **Admin settings** > **Embedding** > **Static embedding** > **Manage**.+You can find a list of all static embeds of questions and dashboards from **Admin settings** > **Embedding** > **Static**.1. Visit the embeddable question or dashboard.2. Click on the **sharing icon** (square with an arrow pointing to the top right).@@ -164,9 +164,8 @@ The banner appears on static embeds created with Metabase's open-source version.Your embedding secret key is used to sign JWTs for all of your [embedding URLs](#adding-the-embedding-url-to-your-website).-1. Go to **Settings** > **Admin settings** > **Embedding**.-2. On the **Static embedding** card, click on **Manage**.-3. Under **Regenerate secret key**, click **Regenerate key**.+1. Go to **Admin** > **Embedding** > **Static embedding**.+2. Under **Regenerate secret key**, click **Regenerate key**.This key is shared across all static embeds. Whoever has access to this key could get access to all embedded artifacts, so keep this key secure. If you regenerate this key, you'll need to update your server code with the new key.diff --git a/docs/embedding/translations.md b/docs/embedding/translations.mdindex 49dfefb1dd0..84549efde58 100644--- a/docs/embedding/translations.md+++ b/docs/embedding/translations.md@@ -7,7 +7,7 @@ summary: Upload a translation dictionary to translate questions and dashboards i{% include plans-blockquote.html feature="Translation of embedded content" convert_pro_link_to_embbedding=true %}-For now, translations are only available for [static embeds](./static-embedding.md), not Interactive embedding or the Embedded analytics SDK.+For now, translations are only available for [static embeds](./static-embedding.md), not Interactive embedding or the Embedded analytics JS/SDK.You can upload a translation dictionary to translate strings both in Metabase content (like dashboard titles) and in the data itself (like column names and values).@@ -21,6 +21,11 @@ The dictionary must be a CSV with these columns:> Don't put any sensitive data in the dictionary, since anyone can see the dictionary—including viewers of public links.+To add a translation dictionary:++1. Go to **Admin > Embedding > Static**.+2. Under **Translate embedded dashboards and question**, click **Upload translation dictionary**.+Uploading a new dictionary will replace the existing dictionary.To remove a translation dictionary, upload a blank dictionary.@@ -64,9 +69,9 @@ Exact translations also apply to strings that use punctuation and special characTranslations are case-insensitive. For example, if your translation dictionary has a translation:-| Language | String | Translation |-| -------- | ----------- | ------------ |-| pt-BR | Examples | Exemplos |+| Language | String | Translation |+| -------- | -------- | ----------- |+| pt-BR | Examples | Exemplos |`Examples`, `examples`, `EXAMPLES` would all be translated as `Exemplos`. That is, Metabase won't preserve the original case; it will output the exact translation string in the dictionary.diff --git a/docs/exploration-and-organization/exploration.md b/docs/exploration-and-organization/exploration.mdindex 8be0f3c046d..268000c8bc5 100644--- a/docs/exploration-and-organization/exploration.md+++ b/docs/exploration-and-organization/exploration.md@@ -25,7 +25,7 @@ You can use the command palette to:So anytime you want to do or find anything in Metabase, just hit `cmd/ctrl + k` and start typing what you want to do.-> The command palette is currently unavailable in [interactive embedding](../embedding/interactive-embedding.md) contexts.+> The command palette is currently unavailable in [Embedded analytics JS](../embedding/embedded-analytics-js.md) and [interactive embedding](../embedding/interactive-embedding.md) contexts.## Advanced searchdiff --git a/docs/installation-and-operation/serialization.md b/docs/installation-and-operation/serialization.mdindex 7e42527e57c..8d3c6c5f1fc 100644--- a/docs/installation-and-operation/serialization.md+++ b/docs/installation-and-operation/serialization.md@@ -296,7 +296,7 @@ This ID refers to the collection where the question was saved. In a real export,### Entity IDs work with embedding-Metabase supports working with [Entity IDs](#metabase-uses-entity-ids-to-identify-and-reference-metabase-items) for questions, dashboards, and collections in [Static Embedding](../embedding/static-embedding.md), [Interactive embedding](../embedding/interactive-embedding.md), and the [Embedded Analytics SDK](../embedding/sdk/introduction.md).+Metabase supports working with [Entity IDs](#metabase-uses-entity-ids-to-identify-and-reference-metabase-items) for questions, dashboards, and collections in [Static Embedding](../embedding/static-embedding.md), [Embedded analytics JS](../embedding/embedded-analytics-js.md), [Interactive embedding](../embedding/interactive-embedding.md), and the [Embedded analytics SDK](../embedding/sdk/introduction.md).A high-level workflow for using Entity IDs when embedding Metabase in your app would look something like: