Web App
Getting Started

Getting Started

The Web App provides a convenient way to interact with the Grai server, allowing you to view you data lineage, connect to data sources, and capture updates.

When self-hosted it's viewable by default at http://localhost:3000 (opens in a new tab).

ℹ️

To install the Web App locally follow the instructions in quickstart.

Logging In

To get started you will need a username and password. You should contact your administrator for a workspace invite..

ℹ️

If you installed Grai locally you should use the superuser you configured during installation. By default this will be

username: null@grai.io
password: super_secret

If you have forgotten your password, follow the link to reset it. This will only work on a local installation if you have setup emails.


Change Workspace
ℹ️

Invited to a workspace but can't see any information? You may need to switch workspaces. From the profile menu (top right) choose Change Workspace.

Creating your first connection

It is likely that when you login there will be no information in your database. To get started we will connect your first data source and run an update to populate the database, this can then be repeated for each data source you wish to connect to Grai.

  1. Go to Connections

  2. Click Add Connection


Add Connection button

  1. Choose the Connector type from the list of supported data sources

  2. Enter a namespace, default is a good option if you don't know what to put here

  3. Enter a name for your Connection

  4. Enter the remaining required fields for the Connection

  5. Save the Connection

  6. Press Refresh on the Connection and wait for it to run

ℹ️

If the run errors you should be able to see the errors by clicking on the status or the table row.

  1. Go to the Graph or Tables page to see your data

Inviting users

It is easy to share access to the Grai Web App, so that the whole team can understand your data lineage.

ℹ️

If installed locally, you need to have setup emails to invite users through the Web App.

  1. Go to Settings under the Profile Menu

  2. Go to the Users page

  3. Click Invite User

  4. Enter the email address of the person you would like to invite

  5. They will receive an email inviting them to join your Workspace

Web AppConnections