Skip to content

Setup Process

Jump to bottom
Sameer Al-Sakran edited this page Mar 10, 2015 · 3 revisions

Overview

This describes the proposed process by which a new user downloads and installs Metabase.

Download

User visits the www.metabase.com website, and downloads a build.

Run Jar

This download is a single jar that when run will

  • create a directory for it's required datafiles
  • create an H2 database, and any config files it needs (or download them)
  • create a setup token that can be used to auth with the setup wizard
  • print the full url to the setup wizard (http://localdomain/setup/)
  • open the url in any defined browser (if running locally)

Get User Info

We request:

  • Organization Name
  • Admin Name
  • Admin Email Address
  • Admin Password

Metabase.com account:

  • We ask the user if they wish to create a metabase.com account as well
  • Benefits
    • Emailed reports without setting up an SMTP Server
    • Notifications about new versions
    • Immediate notification of any security issues discovered + resolutions
    • Personalized Documentation
  • If they accept we create a local account and submit an API call to metabase.com to create an account for them and get a token back
  • If not we only create a local account for them and prompt for an SMTP setup page

Get Database Connection Info

Here we prompt for

  • Database Name
  • Database User
  • Database Password
  • Database Port (or as appropriate for the specific storage engines)

Sync + Analyze Database

At this step we run sync_metadata and analyze_database to create a metadata model as well as try to guess field and table types.

Metadata Information

We display the metadata we've inferred from the previous step and allow the user to correct it. If we have predictions we are not sure of, we would ask the user if they were correct and if so, apply them.

Team Account Creation

If the user has a way to send email, we let the user invite additional people to create an account. For each new user we prompt the user for an email address. If the user has not set up a way to send email, we grey this page out and let them know that to add users we'd need them to enable an email server.

Metabase Logo

Clone this wiki locally