Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

docs - embedding hub updates (#82709)

Jeff Bruemmer1a2df8db55f0
diff --git a/docs/configuring-metabase/setting-up-metabase.md b/docs/configuring-metabase/setting-up-metabase.md
index 6f940127f7e..02e18d6337f 100644
--- a/docs/configuring-metabase/setting-up-metabase.md
+++ b/docs/configuring-metabase/setting-up-metabase.md
@@ -32,7 +32,7 @@ Let us know your plans with Metabase so that we can best guide you.
- A bit of both
- Not sure yet
-Don't worry about picking the wrong option. If you say you're interested in embedding, Metabase will display a card with a link to the embedding settings when you (the admin) first log in to your instance. Just a little convenience thing, that's all.
+Don't worry about picking the wrong option. If you say you're interested in embedding, Metabase will display a card about embedding when you (the admin) first log in to your instance. On Pro and Enterprise plans, Metabase displays the embedding setup guide instead. Just a little convenience thing, that's all.
## Gathering your database info
diff --git a/docs/embedding/appearance.md b/docs/embedding/appearance.md
index 23b00284f1e..1d8164f37f3 100644
--- a/docs/embedding/appearance.md
+++ b/docs/embedding/appearance.md
@@ -2,7 +2,7 @@
title: "Customizing the appearance of modular embeds"
summary: "Style your embedded Metabase components using themes to customize colors, backgrounds, and more."
redirect_from:
-- /docs/latest/embedding/sdk/appearance
+ - /docs/latest/embedding/sdk/appearance
---
# Customizing the appearance of modular embeds
@@ -42,18 +42,20 @@ A theme is a named set of colors and fonts that the embed wizard can copy into e
### Manage themes
-Go to **Admin settings > Embedding > Themes**.
+Go to **Embedding hub > Appearance**.
Metabase ships with light and dark themes that pick up any appearance settings you've set on your Metabase (though you can tinker with these default themes as well, including removing them like you can any other custom theme).
-From the Themes tab, you can:
+In the **Themes** section, you can:
-- **Create a theme.** Click **+ New theme**, then set a name, colors, and font.
+- **Create a theme.** Click **New theme**, then set a name, colors, and font.
- **Edit a theme.** Click a theme card to open the editor. Changes show up in the live preview.
- **Choose what the preview renders.** Pick the dashboard or question used to preview the theme.
- **Duplicate a theme.** Handy if you want to vary an existing theme.
- **Delete a theme.** This deletion is eternal.
+**Branding elements**, on the same page, sets the [loading message](../configuring-metabase/appearance.md#loading-message) and the [illustrations](../configuring-metabase/appearance.md#metabase-illustrations) for empty results. These are the same settings as [Admin > Settings > Appearance](../configuring-metabase/appearance.md).
+
![Theme editor](./images/theme-editor.png)
### Apply a saved theme to a new embed
@@ -70,7 +72,7 @@ The theme you pick is inlined into the generated `defineMetabaseConfig({ theme:
### Reuse a saved theme in the SDK
-If you're using the [SDK](./sdk/introduction.md), pass a theme to `MetabaseProvider` with `defineMetabaseTheme`, which accepts the same theme shape that you configure in the Themes admin UI. You can copy a saved theme's values into your code:
+If you're using the [SDK](./sdk/introduction.md), pass a theme to `MetabaseProvider` with `defineMetabaseTheme`, which accepts the same theme shape that you configure in **Embedding hub > Appearance**. You can copy a saved theme's values into your code:
```tsx
import {
diff --git a/docs/embedding/authentication.md b/docs/embedding/authentication.md
index 8c0e86b784d..29e65e517b7 100644
--- a/docs/embedding/authentication.md
+++ b/docs/embedding/authentication.md
@@ -27,9 +27,9 @@ Here's a high-level overview:
### 1. Enable JWT SSO in your Metabase
-1. Configure JWT by going to **Admin** > **Settings** > **Authentication** and clicking on **JWT**
+1. Go to **Embedding hub > Authentication**.
2. Enter the JWT Identity Provider URI, for example `http://localhost:9090/sso/metabase`. This is a new endpoint you will add in your backend to handle authentication.
-3. Generate a key and copy it to your clipboard.
+3. Click **Set up key** and copy the key to your clipboard.
### 2. Add a new endpoint to your backend to handle authentication
@@ -187,7 +187,7 @@ Additionally, if you have SAML set up, but you'd prefer to use JWT SSO, you'll n
**Admin setting changes in Metabase**:
-In **Admin** > **Authentication** > **JWT SSO**, set the `JWT Identity Provider URI` to the URL of your JWT SSO endpoint, e.g., `http://localhost:9090/sso/metabase`.
+In **Embedding hub** > **Authentication**, set the `JWT Identity Provider URI` to the URL of your JWT SSO endpoint, e.g., `http://localhost:9090/sso/metabase`.
**Before:**
@@ -206,7 +206,7 @@ const authConfig = defineMetabaseAuthConfig({
});
```
-The SDK now uses the JWT Identity Provider URI setting configured in your Metabase Admin (Admin > Settings > Authentication > JWT).
+The SDK now uses the JWT Identity Provider URI setting configured in your Metabase (**Embedding hub** > **Authentication**).
### Update the `fetchRequestToken` function signature
@@ -293,13 +293,13 @@ If you want to embed Metabase in another domain (say, if Metabase is hosted at `
### Allow your domain in CORS
-Go to **Admin** > **Embedding** > **Modular embedding** and add your embedding domain under **Cross-Origin Resource Sharing (CORS)** (such as `https://*.example.com`).
+Go to **Embedding hub** > **Security** and add your embedding domain under **Cross-Origin Resource Sharing (CORS)** (such as `https://*.example.com`).
### Configure session cookies when testing locally
When you use `useExistingUserSession: true` during development on a different domain, the browser must send the existing Metabase session cookie cross-origin into the iframe. To allow this, you'll need to set the session cookie's SameSite value to "none".
-You can set session cookie's SameSite value in **Admin** > **Embedding** > **Security** > **SameSite cookie setting**.
+You can set session cookie's SameSite value in **Embedding hub** > **Security** > **SameSite cookie setting**.
SameSite values include:
diff --git a/docs/embedding/chart.md b/docs/embedding/chart.md
index 189c5ef5ea4..5ce950cabbb 100644
--- a/docs/embedding/chart.md
+++ b/docs/embedding/chart.md
@@ -111,7 +111,7 @@ On your app's server, set the value for the locked parameter in the token. Whoev
const jwt = require("jsonwebtoken");
// Get your key from your Metabase at
-// /admin/embedding/guest -> Embedding secret key
+// Embedding hub > Security > Secret key for guest embeds
const METABASE_SECRET_KEY = "YOUR_SECRET_KEY";
// Here we lock a customer_id parameter to 13
diff --git a/docs/embedding/dashboard.md b/docs/embedding/dashboard.md
index 850d854c302..a90b60cfa5a 100644
--- a/docs/embedding/dashboard.md
+++ b/docs/embedding/dashboard.md
@@ -107,7 +107,8 @@ And here's the endpoint that signs the token. The embed posts the dashboard's ID
```javascript
const jwt = require("jsonwebtoken");
-// Your embedding secret key. Keep it on your server; it never reaches the browser.
+// Your embedding secret key, from Embedding hub > Security > Secret key for guest embeds.
+// Keep it on your server; it never reaches the browser.
const METABASE_SECRET_KEY = process.env.METABASE_SECRET_KEY;
app.post("/api/metabase-guest-token", (req, res) => {
diff --git a/docs/embedding/full-app-embedding-quick-start-guide.md b/docs/embedding/full-app-embedding-quick-start-guide.md
index b4aa344409a..03afb227555 100644
--- a/docs/embedding/full-app-embedding-quick-start-guide.md
+++ b/docs/embedding/full-app-embedding-quick-start-guide.md
@@ -33,9 +33,9 @@ You could also use the dashboard's [Entity ID](../installation-and-operation/ser
### Enable full app embedding
-In Metabase, click the **grid** icon in the upper right and go to **Admin > Embedding** and toggle on **Enable full app embedding**.
+In Metabase, click the **grid** icon in the upper right, select **Embedding hub**, and go to **Security**. Toggle on **Full-app 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 for full-app embedding** (it appears once you flip the toggle), 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
@@ -45,9 +45,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 **Embedding settings** section, scroll down and click on **Authentication** under **Related settings**.
-
-On the card that says **JWT**, click the **Set up** button (you may have to scroll down to view the JWT card).
+In the Embedding hub sidebar, click **Authentication**. The page opens to the JWT settings.
#### Set JWT identity provider URI
@@ -171,7 +169,7 @@ In Metabase, click the **grid** icon and go to **Admin** > **People** > **Groups
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.
-Go to **Admin** > **Settings** > **Authentication** > **JWT**.
+Go to **Embedding hub** > **Authentication**.
In the **Group mapping** section, select **Automatic**. Metabase adds people to the Metabase groups whose names match the group names in their JWT. If your `groups` array and your Metabase group both use `Customer Acme`, Metabase maps them for you.
diff --git a/docs/embedding/full-app-embedding.md b/docs/embedding/full-app-embedding.md
index 0604efa33bc..5768d271a35 100644
--- a/docs/embedding/full-app-embedding.md
+++ b/docs/embedding/full-app-embedding.md
@@ -26,7 +26,7 @@ Check out the [Full app embedding quick start](./full-app-embedding-quick-start-
## Prerequisites for full app embedding
-1. Make sure you have a [license token](../installation-and-operation/activating-the-enterprise-edition.md) for a [Pro or Enterprise plan](https://www.metabase.com/pricing).
+1. Make sure you have a [license token](../installation-and-operation/activating-the-enterprise-edition.md) for a [Pro or Enterprise plan](https://www.metabase.com/pricing).
2. Organize people into Metabase [groups](../people-and-groups/start.md).
3. Set up [permissions](../permissions/introduction.md) for each group.
4. Set up [SSO](../people-and-groups/start.md#authentication) to automatically apply permissions and show people the right data upon sign-in. In general, **we recommend using [SSO with JWT](../people-and-groups/authenticating-with-jwt.md)**.
@@ -37,9 +37,9 @@ If you have your app running locally, and you're using the Pro Cloud version, or
## Enabling full app embedding in Metabase
-1. Go to **Admin > Embedding**.
-2. Click **Enable Full app 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`).
+1. Go to **Embedding hub > Security**.
+2. Toggle on **Full-app embedding**.
+3. Under **Authorized origins for full-app embedding** (it appears once you flip the toggle), 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
@@ -129,7 +129,7 @@ Note that your full app embed must be compatible with Safari to run on _any_ bro
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** > **Embedding** > **Security** > **SameSite cookie setting**.
+You can set a session cookie's SameSite value in **Embedding hub** > **Security** > **SameSite cookie setting**.
SameSite values include:
diff --git a/docs/embedding/guest-embedding.md b/docs/embedding/guest-embedding.md
index 3e502f4559d..9326e410a2b 100644
--- a/docs/embedding/guest-embedding.md
+++ b/docs/embedding/guest-embedding.md
@@ -20,12 +20,8 @@ To restrict data in guest embeds for specific people or groups, use [locked para
## Turning on guest embedding in Metabase
-The path to embedding settings depends on your Metabase version:
-
-- **OSS**: **Admin > Embedding**
-- **Starter/Pro/Enterprise**: **Admin > Embedding > Guest embeds**
-
-Toggle **Enable guest embeds**.
+1. Go to **Embedding hub > Security**.
+2. Toggle on **Enable embedding** (called **Modular embedding** on Pro and Enterprise). The same switch covers guest embeds and modular embedding.
## Creating a guest embed
@@ -111,8 +107,8 @@ You can set different attributes to enable/disable UI. Here are some example att
| `token` | Required. The signed JWT token from your server. |
| `with-title` | Show or hide the title. Values: `"true"` or `"false"`. |
| `with-downloads`\* | Enable or disable downloads. Values: `"true"` or `"false"`. |
-| `initial-parameters` | JSON string of starting parameter values (uncontrolled). Example: `'{"category":["Gizmo"]}'`. See [Embedding parameters](./parameters.md#set-starting-values). |
-| `parameters` | JSON string of parameter values (controlled). Example: `'{"category":["Gizmo"]}'`. See [Embedding parameters](./parameters.md#control-values-from-your-app). |
+| `initial-parameters` | JSON string of starting parameter values (uncontrolled). Example: `'{"category":["Gizmo"]}'`. See [Embedding parameters](./parameters.md#set-starting-values). |
+| `parameters` | JSON string of parameter values (controlled). Example: `'{"category":["Gizmo"]}'`. See [Embedding parameters](./parameters.md#control-values-from-your-app). |
| `hidden-parameters` | JSON array of slugs whose widgets to hide. Only **Editable** parameters have a widget on a guest embed, so the wizard won't generate this for you. Hiding a widget doesn't restrict the value. See [Hide parameter widgets](./parameters.md#hide-parameter-widgets). |
| `auto-refresh-interval` | Dashboards only. Auto-refresh interval in seconds. |
| `custom-context` | Forwarded to your [`guestEmbedProviderUri`](#refreshing-or-initializing-the-jwt-from-your-server) endpoint as `customContext`. Either a string (e.g., `"gadgets-tab"`), or a JSON-stringified object like `initial-parameters` (e.g., `'{"tab":"gadgets","region":"us-east"}'`). |
@@ -301,7 +297,7 @@ If you change an embed's settings in the wizard, like a parameter's visibility o
4. Select **Guest embedding**
5. Click **Unpublish**.
-Admins can find a list of embedded items in **Admin > Embedding** (on Pro and Enterprise plans, check the **Guest embeds** tab).
+Admins can find a list of embedded items in **Embedding hub > Security** under **Published guest embeds**. You'll only see the list once you've published something.
## Removing the "Powered by Metabase" banner
@@ -311,10 +307,10 @@ Metabase adds the banner to guest embeds (both charts and dashboards) on the OSS
## Regenerating the embedding secret key
-Your embedding secret key is used to sign JWTs for all of your embeds.
+Your embedding secret key is used to sign JWTs for all of your embeds. If you don't have a key yet, Metabase generates one for you when you turn on embedding.
-1. Go to **Admin > Embedding**. On Pro and Enterprise plans, check the **Guest embeds** tab.
-2. Under **Regenerate secret key**, click **Regenerate key**.
+1. Go to **Embedding hub > Security**.
+2. Under **Secret key for guest embeds**, click **Regenerate key**.
This key is shared across all guest 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/images/edit-tenant-strategy.png b/docs/embedding/images/edit-tenant-strategy.png
index 2f127f8f636..2289aee03af 100644
Binary files a/docs/embedding/images/edit-tenant-strategy.png and b/docs/embedding/images/edit-tenant-strategy.png differ
diff --git a/docs/embedding/images/embed-with-sso.png b/docs/embedding/images/embed-with-sso.png
deleted file mode 100644
index 4fc9da9c827..00000000000
Binary files a/docs/embedding/images/embed-with-sso.png and /dev/null differ
diff --git a/docs/embedding/images/embedding-hub-getting-started.png b/docs/embedding/images/embedding-hub-getting-started.png
new file mode 100644
index 00000000000..193b32feea8
Binary files /dev/null and b/docs/embedding/images/embedding-hub-getting-started.png differ
diff --git a/docs/embedding/images/new-modular-embed-from-admin-settings.png b/docs/embedding/images/new-modular-embed-from-admin-settings.png
deleted file mode 100644
index 0d791b0ea8e..00000000000
Binary files a/docs/embedding/images/new-modular-embed-from-admin-settings.png and /dev/null differ
diff --git a/docs/embedding/images/themes.png b/docs/embedding/images/themes.png
index e193a4442de..f49e2772c08 100644
Binary files a/docs/embedding/images/themes.png and b/docs/embedding/images/themes.png differ
diff --git a/docs/embedding/introduction.md b/docs/embedding/introduction.md
index 5539ce0c48e..cfbcc3e3c4e 100644
--- a/docs/embedding/introduction.md
+++ b/docs/embedding/introduction.md
@@ -16,10 +16,26 @@ There are two ways to embed Metabase.
Most people go with modular embedding, so you can integrate Metabase components into your app.
-Whichever way you embed, you'll also pick how Metabase authenticates the people looking at it. Authentication is a setting on what you embed, not a different kind of embedding.
+Whichever way you embed, you'll also pick how Metabase authenticates the people viewing your embed. Authentication is a setting on what you embed, not a different kind of embedding.
If you just want to share a chart or dashboard with anyone who has the link, and you don't need any authentication, take a look at [public links and embeds](#public-links-and-embeds).
+## Embedding hub
+
+![Embedding hub](./images/embedding-hub-getting-started.png)
+
+Admins set up embedding in the Embedding hub. To get there, click the **grid** icon in the upper right and select **Embedding hub**.
+
+The hub opens to **Get started**, a checklist for your first embed. The sidebar has the rest of the embedding settings:
+
+- **Security**: turn on [modular embedding](./modular-embedding.md#enable-modular-embedding), [guest embeds](./guest-embedding.md#turning-on-guest-embedding-in-metabase), or [full app embedding](./full-app-embedding.md#enabling-full-app-embedding-in-metabase), and set CORS and cookie settings.
+- **Authentication**: set up [JWT SSO](./authentication.md). SAML settings stay in Admin.
+- **Permissions**: control what data people can see in your embeds. If you use tenants, see [data permissions for tenants](./tenants.md#data-permissions-for-tenants).
+- **Tenancy**: [turn on multi-tenant strategy](./tenants.md#enable-multi-tenant-strategy) and manage tenants, tenant groups, and tenant users.
+- **Appearance**: create and manage [embedding themes](./appearance.md#embedding-themes).
+- **Localization**: [add a translation dictionary](./translations.md#add-a-translation-dictionary).
+- **New embed**: open the [embed wizard](./modular-embedding.md#create-a-new-embed).
+
## Modular embedding
With [modular embedding](./modular-embedding.md), you can embed individual Metabase [components](./components.md) in your web app: dashboards, questions, the query builder, AI chat, and a collection browser.
diff --git a/docs/embedding/modular-embedding.md b/docs/embedding/modular-embedding.md
index aafa5448f79..8c556e20486 100644
--- a/docs/embedding/modular-embedding.md
+++ b/docs/embedding/modular-embedding.md
@@ -17,8 +17,10 @@ If you're using React, check out the [Modular embedding SDK](./sdk/introduction.
## Enable modular embedding
-1. In Metabase, go to **Admin > Embedding**.
-2. Toggle on **Enable modular embedding**.
+1. Go to **Embedding hub > Security**.
+2. Toggle on **Modular embedding** (on OSS and Starter plans, it's just **Enable embedding**).
+
+The first time you turn this on in Pro or Enterprise, Metabase asks you to accept the usage terms.
**For guest embeds**: You're done! Skip to [Create a new embed](#create-a-new-embed) or see the [Guest embedding guide](./guest-embedding.md) for detailed setup instructions.
@@ -43,9 +45,7 @@ In your Metabase:
You can also open a command palette with Ctrl/Cmd+K, type "New embed". You'll get a wizard to help you set up your embed.
-You can also go to **Admin > Embedding > Modular embedding** and click **New embed**.
-
-![New modular embed from the admin settings](./images/new-modular-embed-from-admin-settings.png)
+You can also click **New embed** at the bottom of the Embedding hub sidebar.
### 2. Pick how to authenticate the embed
@@ -65,7 +65,7 @@ If you're on Metabase OSS/Starter plans, you can select light or dark themes for
On Metabase Pro/Enterprise, you can also:
-- Pick a [saved theme](./appearance.md#embedding-themes) you've created in **Admin settings > Embedding > Themes**.
+- Pick a [saved theme](./appearance.md#embedding-themes) you've created in **Embedding hub > Appearance**.
- Pick specific colors for brand, text, and background in the embed wizard.
- Add more [advanced theme options](./appearance.md#advanced-theming) by editing the generated snippet later.
@@ -162,7 +162,7 @@ In addition to this, we consider shared accounts to be unfair usage. Fair usage
The exact customization options you see will depend on which type of entity you're embedding. These are the settings for authenticated embeds available on [Pro](https://www.metabase.com/product/pro) and [Enterprise](https://www.metabase.com/product/enterprise) plans. For guest embeds (OSS and paid), see [guest embedding options](./guest-embedding.md#component-attributes).
-When you're creating a new embed using **Admin > Embedding > Setup guide > Embed in your code**, you'll see some or all of the following customization options in the interactive creation flow. These options correspond to attributes on the component you're embedding. For each attribute, see the [dashboard](./dashboard-reference.md) and [question](./question-reference.md) component references.
+When you create a new embed with the embed wizard (click **New embed** in the Embedding hub, or **Share > Embed** on an item), you'll see some or all of the following customization options in the interactive creation flow. These options correspond to attributes on the component you're embedding. For each attribute, see the [dashboard](./dashboard-reference.md) and [question](./question-reference.md) component references.
- **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](../questions/visualizations/drill-through.md) 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.
diff --git a/docs/embedding/sdk/introduction.md b/docs/embedding/sdk/introduction.md
index 8f8ea207a99..78ba1478e35 100644
--- a/docs/embedding/sdk/introduction.md
+++ b/docs/embedding/sdk/introduction.md
@@ -44,8 +44,8 @@ To use the SDK, you'll need to enable the SDK in Metabase, and install the SDK i
### Enable the SDK in Metabase
-1. Enable the Modular embedding SDK by going to **Admin > Embedding**.
-2. Toggle on **Modular embedding SDK**.
+1. Go to **Embedding hub > Security**.
+2. Toggle on **Modular embedding React SDK**.
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 application
diff --git a/docs/embedding/sdk/quickstart-with-sample-app.md b/docs/embedding/sdk/quickstart-with-sample-app.md
index 99d70c0987d..63a0bbfb019 100644
--- a/docs/embedding/sdk/quickstart-with-sample-app.md
+++ b/docs/embedding/sdk/quickstart-with-sample-app.md
@@ -123,11 +123,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 the **grid** icon in the upper right and select **Admin** > **Embedding**.
+From any Metabase page, click the **grid** icon in the upper right and select **Embedding hub**. Go to **Security**.
Turn on:
-- Modular embedding SDK
+- Modular embedding React SDK
Otherwise, this whole thing is hopeless.
@@ -135,9 +135,7 @@ Otherwise, this whole thing is hopeless.
We'll also need to update our JWT Provider URI in Metabase. By default, this URI is where the SDK will redirect login requests.
-From any Metabase page, click the **grid** icon in the upper right and select **Admin** > **Settings** > **Authentication**.
-
-On the card that says **JWT**, click the **Setup** button.
+From any Metabase page, click the **grid** icon in the upper right, select **Embedding hub**, and go to **Authentication**.
### JWT Identity provider URI
diff --git a/docs/embedding/sdk/quickstart.md b/docs/embedding/sdk/quickstart.md
index 1bb3df365d2..224770a17d0 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 the grid icon in the upper right and navigate to **Admin > Embedding > Modular** and enable the **SDK for React**.
+In Metabase, click the **grid** icon in the upper right, select **Embedding hub**, and go to **Security**. Toggle on **Modular embedding React SDK**.
## 2. Create an API key in Metabase
-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).
+Click the **grid** icon, select **Admin**, and go to **Settings > Authentication > API keys**. [Create a new API key](../../people-and-groups/api-keys.md).
- Key name: "Modular embedding 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.md
index 9cbca1e476c..83038d5dcdf 100644
--- a/docs/embedding/sdk/version.md
+++ b/docs/embedding/sdk/version.md
@@ -43,7 +43,7 @@ On Metabase 56 or earlier, pinning also keeps the SDK Package and Metabase major
To manually pin your version of Metabase:
-1. Go to **Admin > Embedding > Modular**.
+1. Go to **Admin > Settings > General**.
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/tenants.md b/docs/embedding/tenants.md
index 514fa41e3e1..2df0712d0ce 100644
--- a/docs/embedding/tenants.md
+++ b/docs/embedding/tenants.md
@@ -98,17 +98,18 @@ In the experiences that expose users to Metabase collections (e.g. when using fu
## Enable multi-tenant strategy
-_Admin settings > People_
+_Embedding hub > Tenancy_
You can create and manage your tenants exclusively through Metabase UI, or, if that's not your jam, [through SSO](#provisioning-and-assigning-tenants-with-jwt). Regardless of how you manage your tenants, you'll need to enable multi-tenant strategy in Metabase first.
-![Edit tenant strategy](./images/edit-tenant-strategy.png)
+1. Go to **Embedding hub > Tenancy**.
+2. Under **Enable multi-tenant user strategy**, click **Enable multi-tenancy**.
+
+Once it's on, the **gear** icon on the **Tenants** tab lets you switch strategies.
-1. Go to **Admin settings > People**.
-2. Click on the **gear** icon above the list of people.
-3. Choose **Multi-tenant strategy**.
+![Edit tenant strategy](./images/edit-tenant-strategy.png)
-Changing Metabase to multi-tenant strategy enables special [user](#user-types) and [collection](#collection-types) types. You can create new tenants, tenant groups, and collections, and you get some additional admin settings in the People and Permissions tabs.
+Changing Metabase to multi-tenant strategy enables special [user](#user-types) and [collection](#collection-types) types. You can create new tenants, tenant groups, and collections, and you get additional settings in the Embedding hub's **Tenancy**, **Permissions**, and **Authentication** pages.
If you have an existing permissions and collection setup that you'd like to translate to use tenants, see [Changing tenant strategy](#changing-tenant-strategy).
@@ -116,15 +117,15 @@ Once you enable multi-tenant strategy, keep in mind that switching _from_ multi-
## Create new tenants in Metabase
-_Admin settings > People > Tenant_
+_Embedding hub > Tenancy > Tenants_
![New tenant user](./images/new-tenant.png)
To create new tenants in Metabase:
1. [Enable multi-tenant strategy](#enable-multi-tenant-strategy), if you haven't yet.
-2. Go to **Admin settings > People** .
-3. Select **Tenants** on the left sidebar and click **New tenant**.
+2. Go to **Embedding hub > Tenancy**.
+3. On the **Tenants** tab, click **New tenant**.
4. Fill out the information for the tenant:
- **Tenant name**: Display name for the tenant that will be displayed to _internal_ users. Not exposed to external users. This name can be changed later.
- **Tenant slug**: Unique identifier of the tenant. It can be used to [match JWT claims](#use-tenant-claim-to-sign-in-users) and for setting up [data permissions](#use-tenant-attributes-for-data-permissions). See [Tenant slug](#special-tenant-slug-attribute) for more information.
@@ -134,29 +135,29 @@ You can avoid manually setting up tenants in Metabase by [provisioning tenants w
## Create tenant groups
-_Admin settings > People > Tenant groups_
+_Embedding hub > Tenancy > Tenant groups_
Tenant groups are applicable across tenants. For example, you can have tenant groups "Basic users" and "Premium users", and every tenant will be able to use those groups. Groups can be used to configure permissions so that, among the tenant's users, some get Basic permissions while others get Premium. See [Tenant concepts](#concepts) for more information.
To create a tenant group:
1. [Enable multi-tenant strategy](#enable-multi-tenant-strategy), if you haven't yet.
-2. Go to **Admin settings > People**.
-3. Select **Tenant groups** on the left sidebar and click **Create a group**.
+2. Go to **Embedding hub > Tenancy**.
+3. On the **Tenant groups** tab, click **Create a group**.
4. Name your group.
To add people to tenant groups, see [Add people to groups](../people-and-groups/managing.md#adding-people-to-groups).
## Create tenant users in Metabase
-_Admin settings > People > Tenant users_
+_Embedding hub > Tenancy > Tenant users_
Tenant users are the end users in tenants. In a B2B SaaS context, these are your customer's users. Usually tenant users interact with Metabase through an intermediate app (for example, through an embedded dashboard).
To add tenant users in Metabase:
1. [Create a tenant](#create-new-tenants-in-metabase).
-2. Go to **Admin settings > People** .
-3. Select **Tenant users** on the left sidebar and click **New tenant user**.
+2. Go to **Embedding hub > Tenancy**.
+3. On the **Tenant users** tab, click **Create tenant user**.
4. Fill out the user information, including the tenant and tenant groups.
If your tenant has [tenant attributes](#tenant-attributes), they'll be inherited by the user, but you can override the value in "Attributes".
@@ -186,7 +187,7 @@ You can set up [Remote sync](../installation-and-operation/remote-sync.md) for s
## Tenant attributes
-_Admin settings > People > Tenants_
+_Embedding hub > Tenancy > Tenants_
You can create tenant-level [user attributes](#tenant-attributes) which all users of the tenant inherit. This is useful for configuring attribute-based data permissions like [row-level security](../permissions/row-and-column-security.md), [impersonation](../permissions/impersonation.md), or [database routing](../permissions/database-routing.md).
@@ -194,10 +195,10 @@ You can create tenant-level [user attributes](#tenant-attributes) which all user
To create a tenant attribute manually using the Metabase UI:
-1. Go to **Admin settings > People**
-2. Select **Tenants** on the left sidebar.
-3. Click on **three dots** next to the tenant.
-4. Input the attribute key and value.
+1. Go to **Embedding hub > Tenancy**.
+2. Select the **Tenants** tab.
+3. Click on **three dots** next to the tenant and select **Edit tenant**.
+4. Under **Default attributes**, input the attribute key and value.
You can also assign tenant attributes automatically through JWT claims, see [Setting tenant attributes using tenant claims](#setting-tenant-attributes-using-tenant-claims) below.
@@ -251,7 +252,7 @@ If the user has already been assigned to a tenant (for example, through Metabase
By default, Metabase looks for a `@tenant` key in your JWT. To set up a different key:
-1. Go to **Admin** > **Settings** > **Authentication** > **JWT** > **User attribute configuration**
+1. Go to **Embedding hub** > **Authentication** > **User attribute configuration**.
2. Change the **Tenant assignment attribute** key to your preferred identifier.
### Provisioning tenants and users
@@ -294,7 +295,7 @@ Some common auth error messages and what they mean:
## Data permissions for tenants
-_Admin settings > Permissions_
+_Embedding hub > Permissions_
Data permissions control what data people can see on charts and dashboards, and what they can do with that data. To control _which_ charts people see, you can use [collection permissions](#collection-permissions-for-tenants) instead.
@@ -320,7 +321,7 @@ Please review [Data permissions documentation](../permissions/data.md) for more
### Use tenant attributes for data permissions
-[Row and column security](../permissions/row-and-column-security.md), [Impersonation](../permissions/impersonation.md), and Database routing require user attributes. You can [specify custom tenant attributes](#tenant-attributes) to configure data permissions based on attribute values. See [Tenant attributes](#tenant-attributes).
+[Row and column security](../permissions/row-and-column-security.md), [Impersonation](../permissions/impersonation.md), and Database routing require user attributes. You can [specify custom tenant attributes](#tenant-attributes) to configure data permissions based on attribute values. See [Tenant attributes](#tenant-attributes).
## Collection permissions for tenants
@@ -356,9 +357,9 @@ For configuring permissions to _internal_ collections for internal users, see [g
### Configuring shared collections permissions
-_Admin settings > Permissions_
+_Embedding hub > Permissions_
-To configure access to shared collections for tenant and internal groups, go to **Admin settings > Permissions > Shared collections**.
+To configure access to shared collections for tenant and internal groups, go to **Embedding hub > Permissions > Shared collections**.
You can configure access for each shared collection and their subcollections for both internal and external users. See general docs on [collection permissions](../permissions/collections.md).
@@ -368,20 +369,20 @@ When configuring permissions, remember that in Metabase, all permissions are add
## Subscription permissions for tenants
-_Admin settings > Permissions_
+_Embedding hub > Permissions_
By default, all tenant users will be created with **No** [subscription permissions](../permissions/application.md#subscriptions-and-alerts). If you want your users to be able to create subscriptions (either in full-app embedding, modular embedding, or by logging in directly to Metabase), you'll need to change the Subscription and alerts permissions to "Yes".
## Deactivate a tenant
-_Admin settings > People > Tenants_
+_Embedding hub > Tenancy > Tenants_
**Deactivating a tenant will also deactivate all users who belong to this tenant**.
To deactivate a tenant:
-1. Go to **Admin settings > People**.
-2. Select **Tenants** on the left sidebar.
+1. Go to **Embedding hub > Tenancy**.
+2. Select the **Tenants** tab.
3. Click on **three dots** next to the tenant.
4. Choose **Deactivate tenant**.
diff --git a/docs/embedding/translations.md b/docs/embedding/translations.md
index 558956769c6..bc38481a852 100644
--- a/docs/embedding/translations.md
+++ b/docs/embedding/translations.md
@@ -55,8 +55,10 @@ The dictionary must be a CSV with these columns:
To add a translation dictionary:
-1. Go to **Admin > Embedding**.
-2. Under **Translate embedded dashboards and question**, click **Upload translation dictionary**.
+1. Go to **Embedding hub > Localization**.
+2. Under **Translate embedded dashboards and questions**, click **Upload edited translation dictionary**.
+
+For a starting point, click **Get translation dictionary template**. You'll get a CSV with the right columns, filled with your current dictionary if you've uploaded one, or a few sample rows if you haven't.
Uploading a new dictionary will replace the existing dictionary.
diff --git a/docs/permissions/application.md b/docs/permissions/application.md
index 2f2ec7dcb68..14af32d804c 100644
--- a/docs/permissions/application.md
+++ b/docs/permissions/application.md
@@ -27,6 +27,8 @@ Settings access defines which groups can view and edit the settings under the Ad
- [Appearance](../configuring-metabase/appearance.md)
- [Public sharing](../embedding/public-links.md)
+Embedding settings aren't included. They live in the **Embedding hub**, which only admins can open.
+
## Monitoring access
People in groups with Monitoring access can view:
diff --git a/docs/permissions/embedding.md b/docs/permissions/embedding.md
index 15353f34a02..ab6a69d6c29 100644
--- a/docs/permissions/embedding.md
+++ b/docs/permissions/embedding.md
@@ -121,7 +121,7 @@ Say you have a single database with ten different tables, each corresponding to
1. **Create a group** for your first customer in **Admin** > **People**. If you need different permission levels within a company (some employees can ask questions, others can only view), create multiple groups like **Company A (Self-service)** and **Company A (View only)**.
-2. **Grant table access** by going to **Permissions** > **Data** > **Databases** and granting your new group access to the customer's table. If you want customers to create questions and dashboards within their table, set **Create query** permissions to **Query builder**.
+2. **Grant table access** by going to **Admin** > **Permissions** > **Data** > **Databases** and granting your new group access to the customer's table. If you want customers to create questions and dashboards within their table, set **Create query** permissions to **Query builder**.
For employees who should only view data and create collections to house those specific questions and dashboards, see [collection permissions](./collections.md).