mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2025-12-28 07:58:31 +00:00
* changed catalog to openmetadata in all the docs * changed README.md Co-authored-by: parthp2107 <parth.panchal@deuexsoultions.com>
3.0 KiB
3.0 KiB
- 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 'openmetadata_user'@'%' IDENTIFIED WITH mysql_native_password BY 'openmetadata_password';
mysql> CREATE DATABASE openmetadata_db;
mysql> GRANT ALL PRIVILEGES ON openmetadata_db.* TO 'openmetadata_user'@'%';
mysql> FLUSH PRIVILEGES;
Build OpenMetdata project and run it
Make sure mysql is running with credentials user 'openmetadata_user' with password 'openmetadata_password'. Connect to mysql following steps mentioned [here](#Set up mysql database used as OpenMetadata backend).
mvn -DskipTests clean package
cd dist/target
tar zxvf openmetadata-1.0.0-SNAPSHOT.tar.gz
cd openmetadata-1.0.0-SNAPSHOT/bootstrap
./bootstrap_storage.sh migrate
cd ../
If authorizer is configured, run:
./bin/openmetadata-server-start.sh conf/openmetadata-security.yaml
otherwise run
./bin/openmetadata-server-start.sh conf/openmetadata.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/openmetadata-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