Menu Close Get Metabase

Brand your Metabase instance

Sep 22, 2020 by The Metabase Team

With Metabase Enterprise Edition’s white labeling feature, you can customize your user interface:

Read this article to learn how to personalize your Metabase instance, transforming it from Figure 1 into Figure 2.

Figure 1. The clean, classic home page for Metabase without any <strong>white label</strong> changes.
Figure 1. The clean, classic home page for Metabase without any white label changes.
Figure 2. The Metabase home page with a modified <strong>logo</strong>, <strong>color palette</strong>, and <strong>home page location</strong>.
Figure 2. The Metabase home page with a modified logo, color palette, and home page location.

White label settings page

In Metabase Enterprise Edition, you can access the white label settings in Metabase Admin under the settings tab.

Application name

Use the text box at the top of the white label settings page to type the name of your company. We typed “Your Company” as an example.

When you click away, your company name will be saved and distributed throughout the application. Anywhere the text “Metabase” appeared will now be replaced by your company’s name. Double check that your name saved by looking at left side of the nav bar; it now says “Your Company Admin” instead of Metabase Admin.

Figure 3. The <strong>white label settings</strong> page with the application renamed to Your Company.
Figure 3. The white label settings page with the application renamed to Your Company.

Color palette

Change the application’s default colors in the color palette section.

The color palette has helpful descriptions beside each color swatch, so you know whether the swatch affects the site’s primary color, nav bar, query builder, buttons, or accents.

Click the color swatch you want to change. In the pop up, select a new color using your method of choice:

  • Drag the color selectors along the color and opacity gradients
  • Enter a hex number
  • Enter an RGBA number
  • Select a color swatch from the color palette provided
Figure 4. Editing the color palette settings and navigating back to the Metabase home page to demonstrate the changes.
Figure 4. Editing the color palette settings and navigating back to the Metabase home page to demonstrate the changes.

Upload your company’s logo to replace the Metabase logo throughout the app.

Figure 5 uploads a PNG image from a desktop computer as a replacement to the Metabase logo. Once uploaded, we return to the Metabase home page and confirm that the blue Metabase logo has been replaced by our PNG image.

Figure 5. Uploading a logo and verifying that it appears on the Metabase home page.
Figure 5. Uploading a logo and verifying that it appears on the Metabase home page.

Favicon

With an icon link, you can personalize the favicon that appears in your browser’s tab. In Figure 6 you can see the Google favicon on the left tab and the Metabase favicon on the right tab.

Figure 6. Examples of what favicons look like in Chrome tabs.
Figure 6. Examples of what favicons look like in Chrome tabs.

If you change your application name, but not your favicon, the favicon will remain as the Metabase logo.

Home page

If you’ve been following along with the article, your home page will look like Figure 7, below (altered application name, color palette, and logo).

Users see this page when they first log in to your Metabase instance and whenever they press the home button on the far left of the navbar.

Figure 7. Automatically generated home page with personalized greeting and x-ray suggestions based on data.
Figure 7. Automatically generated home page with personalized greeting and x-ray suggestions based on data.

To change your home page, navigate to the question, x-ray, or dashboard that you want to be your new home page. Copy the route and paste it into the text area provided in white label settings.

For example, if the url of my desired home page is “http://localhost:3000/dashboard/3”, I would type “/dashboard/3”. When I exit Metabase Admin I see that my home page now looks like Figure 8 instead of Figure 7.

Figure 8. Newly selected home page: an x-ray of the Orders table.
Figure 8. Newly selected home page: an x-ray of the Orders table.

Sign in page

With the example changes made to your application name, color palette, and logo, your login screen will look like Figure 9.

Figure 9. Sign in page with first three changes applied: purple background, EX logo, and the text 'Sign in to Your Company.'
Figure 9. Sign in page with first three changes applied: purple background, EX logo, and the text 'Sign in to Your Company.'

Your favicon will also appear on the browser tab of this page.

Learn about customization

Learn more about customizing your Metabase instance: