full-app-embedding.md

title: Full-app embedding
redirect_from:
  - /docs/latest/enterprise-guide/full-app-embedding

Full-app embedding

{% include plans-blockquote.html feature="Full-app embedding" %}

Full-app embedding is what you want if you want to offer multi-tenant, self-service analytics.

Full-app embedding is the only type of embedding that integrates with your permissions and SSO to give people the right level of access to query and drill-down into your data.

Full-app embedding demo

To get a feel for what you can do with full-app embedding, check out our full-app embedding demo.

To see the query builder in action, click on Reports > + New > Question.

Prerequisites for full-app embedding

1. Make sure you have a license token for a paid plan.
2. Organize people into Metabase groups.
3. Set up permissions for each group.
4. Set up SSO to automatically apply permissions and show people the right data upon sign-in.

If you're dealing with a multi-tenant situation, check out our recommendations for Configuring permissions for different customer schemas.

Enabling full-app embedding in Metabase

1. Go to Settings > Admin settings > Embedding.
2. Click Enable.
3. Click Full-app 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).

Setting up embedding on your website

1. Create an iframe with a src attribute set to:
   • the URL of the Metabase page you want to embed, or
   • an authentication endpoint that redirects to your Metabase URL.
2. Optional: Depending on the way your web app is set up, set environment variables to:
   • Add your license token.
   • Embed Metabase in a different domain.
   • Secure your full-app embed.
3. Optional: Enable communication to and from the embedded Metabase using supported postMessage messages:
   • From Metabase
   • To Metabase
4. Optional: Set parameters to show or hide Metabase UI components.

Once you're ready to roll out your full-app embed, make sure that people allow browser cookies from Metabase, otherwise they won't be able to log in.

Pointing an iframe to a Metabase URL

Go to your Metabase instance and find the page that you want to embed.

For example, to embed your Metabase home page, set the src attribute to your site URL, such as:

http://metabase.yourcompany.com/

To embed a specific Metabase dashboard, use the dashboard's URL, such as:

http://metabase.yourcompany.com/dashboard/1

Pointing an iframe to an authentication endpoint

Use this option if you want to send people directly to your SSO login screen (i.e., skip over the Metabase login screen with an SSO button), and redirect to Metabase automatically upon authentication.

You'll need to set the src attribute to your auth endpoint, with a return_to parameter pointing to the encoded Metabase URL. For example, to send people to your SSO login page and automatically redirect them to http://metabase.yourcompany.com/dashboard/1:

https://metabase.example.com/auth/sso?return_to=http%3A%2F%2Fmetabase.yourcompany.com%2Fdashboard%2F1

If you're using JWT, you can use the relative path for the redirect (i.e., your Metabase URL without the site URL). For example, to send people to a Metabase page at /dashboard/1:

https://metabase.example.com/auth/sso?jwt=<token>&return_to=%2Fdashboard%2F1

You must URL encode (or double encode, depending on your web setup) all of the parameters in your redirect link, including parameters for filters (e.g., filter=value) and UI settings (e.g., top_nav=true). For example, if you added two filter parameters to the JWT example shown above, your src link would become:

https://metabase.example.com/auth/sso?jwt=<token>&redirect=%2Fdashboard%2F1%3Ffilter1%3Dvalue%26filter2%3Dvalue

Cross-browser compatibility

To make sure that your embedded Metabase works in all browsers, put Metabase and the embedding app in the same top-level domain (TLD). The TLD is indicated by the last part of a web address, like .com or .org.

Note that your full-app embed must be compatible with Safari to run on any browser in iOS (such as Chrome on iOS).

Embedding Metabase in a different domain

Skip this section if your Metabase and embedding app are already in the same top-level domain (TLD).

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 set the following environment variable:

MB_SESSION_COOKIE_SAMESITE=None

If you set this environment variable to "None", you must use HTTPS in Metabase to prevent browsers from rejecting the request. For more information, see MDN's documentation on SameSite cookies.

Note that SameSite=None is incompatible with most Safari and iOS browser versions (including any browser that runs on iOS, such as Chrome on iOS).

Securing full-app embeds

Metabase uses HTTP cookies to authenticate people and keep them signed into your embedded Metabase, even when someone closes their browser session. If you enjoy diagrammed auth flows, check out Full-app embedding with SSO.

To limit the amount of time that a person stays logged in, set MAX_SESSION_AGE to a number in minutes. The default value is 20,160 (two weeks).

For example, to keep people signed in for 24 hours at most:

MAX_SESSION_AGE=1440

To automatically clear a person's login cookies when they end a browser session:

MB_SESSION_COOKIES=true

To manually log someone out of Metabase, load the following URL (for example, in a hidden iframe on the logout page of your application):

https://metabase.yourcompany.com/auth/logout

If you're using JWT for SSO, we recommend setting the exp (expiration time) property to a short duration (e.g., 1 minute).

Supported postMessage messages from embedded Metabase

To keep up with changes to an embedded Metabase URL (for example, when a filter is applied), set up your app to listen for "location" messages from the embedded Metabase. If you want to use this message for deep-linking, note that "location" mirrors "window.location".

{ "metabase": { "type": "location", "location": LOCATION_OBJECT_OR_URL }}

To make an embedded Metabase page (like a question) fill up the entire iframe in your app, set up your app to listen for a "frame" message with "normal" mode from Metabase:

{ "metabase": { "type": "frame", "frame": { "mode": "normal" }}}

To specify the size of an iframe in your app so that it matches an embedded Metabase page (such as a dashboard), set up your app to listen for a "frame" message with "fit" mode from Metabase:

{ "metabase": { "type": "frame", "frame": { "mode": "fit", height: HEIGHT_IN_PIXELS }}}

Supported postMessage messages to embedded Metabase

To change an embedding URL, send a "location" message from your app to Metabase:

{ "metabase": { "type": "location", "location": LOCATION_OBJECT_OR_URL }}

Showing or hiding Metabase UI components

To change the interface of your full-app embed, you can add parameters to the end of your embedding URL. If you want to change the colors or fonts in your embed, see Customizing appearance.

For example, you can disable Metabase's top nav bar and side nav menu like this:

your_embedding_url?top_nav=false&side_nav=false

action_buttons

Visible by default on question pages when the header is enabled.

To hide the action buttons such as Filter, Summarize, the query builder button, and so on:

header=false&action_buttons=false

additional_info

Visible by default on question and dashboard pages, when the header is enabled.

To hide the gray text "Edited X days ago by FirstName LastName", as well as the breadcrumbs with collection, database, and table names:

header=false&additional_info=false

breadcrumbs

Shown by default in the top nav bar. Collection breadcrumbs show the path to the item (i.e., the collection(s) the item is in). To hide the breadcrumbs:

breadcrumbs=false

header

Visible by default on question and dashboard pages.

To hide a question or dashboard's title, additional info, and action buttons:

header=false

logo

Whether to show the logo that opens and closes the sidebar nav. Default is true. How Metabase displays the logo depends on the side_nav setting. Here's a rough breakdown of how these two parameters interact:

If logo=true and:

• side_nav=true: Looks like regular Metabase (with whatever logo you have set).
• side_nav=false: There is no sidebar, so nothing happens when you hover over the logo.

If logo=false and:

• side_nav=true: Metabase shows the generic sidebar icon, with a gray color in normal state, and a brand color on hover.
• side_nav=false: There is no side nav nor logo, so the breadcrumbs move all the way to the left of the screen.

new_button

Hidden by default. To show the + New button used to create queries or dashboards:

top_nav=true&new_button=true

search

Hidden by default. To show the search box in the top nav:

top_nav=true&search=true

side_nav

The navigation sidebar is shown on /collection and home page routes, and hidden everywhere else by default.

To allow people to minimize the sidebar:

top_nav=true&side_nav=true

top_nav

Shown by default. To hide the top navigation bar:

top_nav=false

search, new_button, and breadcrumbs all depend on top_nav being set to true. If these three children (search, new_button, and breadcrumbs) are all false, Metabase will hide the top nav bar.

Reference app

To build a sample full-app embed, see our reference app on GitHub.

Further reading

• Strategies for delivering customer-facing analytics.
• Permissions strategies.
• Customizing Metabase's appearance.