---

• What is OpenMetadata?
• Features
• Building OpenMetadata
• Running OpenMetadata via Docker
• Documentation
• License

What is OpenMetadata?

OpenMetadata is a ...

Features

Building OpenMetadata

Set up mysql database used as OpenMetadata backend

mysql -u username -p (Enter password when prompted)

mysql> CREATE USER 'catalog_user'@'%' IDENTIFIED WITH mysql_native_password BY 'catalog_password';
mysql> CREATE DATABASE catalog_db;
mysql> GRANT ALL PRIVILEGES ON catalog_db.* TO 'catalog_user'@'%' IDENTIFIED BY 'catalog_password';
mysql> FLUSH PRIVILEGES;

Build OpenMetdata project and run it

Make sure mysql is running with credentials user 'catalog_user' with password 'catalog_password'. Connect to mysql following steps mentioned here.

mvn -DskipTests clean package
cd dist/target
tar zxvf catalog-1.0.0-SNAPSHOT.tar.gz
cd catalog-1.0.0-SNAPSHOT/bootstrap
./bootstrap_storage.sh migrate
cd ../

If authorizer is configured, run:

./bin/catalog-server-start.sh conf/catalog-security.yaml

otherwise run

./bin/catalog-server-start.sh conf/catalog.yaml

Open browser http://localhost:8585/ to start the UI.
Open browser http://localhost:8585/api/swagger to look at API documentation.

Setup Authorizer Configuration

Enter following information in /conf/catalog-security.yaml file:

authorizerConfiguration:
  className: <authorizer_classname>
  containerRequestFilter: <JWT-filter>
  publicKeyUri: <sign-on_provider_public-key>
  clientAuthorizer:
    authority: <sign-on_issuer-url>
    client_id: <sign-on_client_id>

Running OpenMetadata via Docker

cd docker/metadata/
docker-compose build
docker-compose up

Open browser http://localhost:8585/ to start the UI.
Open browser http://localhost:8585/api/swagger to look at API documentation.

Documentation

Check out OpenMetadata documentation for a complete description of OpenMetadata's features.

License

OpenMetadata is under Apache License, Version 2.0