OpenMetadata/docs/install/run-locally.md

---
description: >-
  This installation doc will help you start a OpenMetadata standalone instance
  on your local machine.
---

# Run Locally

{% hint style="success" %}
This is a quick start guide that will show you how to quickly start a standalone server.
{% endhint %}

## Build from source or download the distribution

**Prerequisites**

{% hint style="info" %}
OpenMetadata is built using Java, DropWizard, Jetty, and MySQL.

1. Java 11 or above
2. MySQL 8 or above
{% endhint %}

{% tabs %}
{% tab title="Build from source " %}
Follow these steps to checkout code from [Github](https://github.com/StreamlineData/catalog) and build OpenMetadata locally

{% hint style="info" %}
**Prerequisites**

Install [Apache Maven](https://maven.apache.org/install.html) 3.6 or higher
{% endhint %}

```bash
# checkout OpenMetadata
git clone https://github.com/StreamlineData/catalog
cd catalog

# build OpenMetadata
mvn install package -DskipTests

# navigate to directory containing the setup scripts
cd dist/target/
unzip catalog-1.0.0-SNAPSHOT.zip
cd catalog-1.0.0-SNAPSHOT
```
{% endtab %}

{% tab title="Download the release" %}
Download the latest binary release from [OpenMetadata](https://open-metadata.org/download/), Once you have the tar file,

```bash
# untar it
tar -zxvf catalog-1.0.0-SNAPSHOT.tar.gz

# navigate to directory containing the launcher scripts
cd catalog-1.0.0-SNAPSHOT
```
{% endtab %}
{% endtabs %}

## Install on your local machine

### macOS

1. Setup Database

   * Install MySQL

   ```text
   brew install mysql
   ```

   * Configure MySQL

     ```text
     mysqladmin -u root password 'yourpassword'
     mysql -u root -p
     ```

   * Setup Database

     ```text
     mysql -u root -p
     CREATE DATABASE catalog_db;
     CREATE USER 'catalog_user'@'localhost' IDENTIFIED BY 'catalog_password';
     GRANT ALL PRIVILEGES ON catalog_db.* TO 'catalog_user'@'localhost' WITH GRANT OPTION;
     commit;
     ```

2. Run bootstrap scripts to initiate the database and tables

   ```text
   cd $METADATA_HOME
   ./boostrap/bootstrap-storage.sh migrate
   ```

3. Start the OpenMetadata Server

   ```text
      ./bin/catalog.sh start
   ```