mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2026-01-07 04:56:54 +00:00
55d7cb41bf
* changed catalog to openmetadata in all the docs * changed README.md Co-authored-by: parthp2107 <parth.panchal@deuexsoultions.com>
86 lines
3.0 KiB
Markdown
86 lines
3.0 KiB
Markdown
<div align="center">
|
|
<img src="https://i.imgur.com/5VumwFS.png" align="center" alt="OpenMetadata" height="90"/>
|
|
<hr />
|
|
|
|
[](https://github.com/StreamlineData/catalog/actions/workflows/maven-build.yml)
|
|
[](https://github.com/StreamlineData/catalog/releases)
|
|
[](https://twitter.com/intent/follow?screen_name=open_metadata)
|
|
[](LICENSE)
|
|
|
|
</div>
|
|
|
|
- [What is OpenMetadata?](#what-is-openmetadata )
|
|
- [Features](#features)
|
|
- [Building OpenMetadata](#building-openmetadata)
|
|
- [Running OpenMetadata via Docker](#running-openmetadata-via-docker)
|
|
- [Documentation](#documentation)
|
|
- [License](#license)
|
|
|
|
# What is OpenMetadata?
|
|
[OpenMetadata](https://open-metadata.org/) is a ...
|
|
|
|
## Features
|
|
|
|
## Building OpenMetadata
|
|
### Set up mysql database used as OpenMetadata backend
|
|
```shell
|
|
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).
|
|
|
|
```shells
|
|
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
|
|
```shell
|
|
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](https://docs.open-metadata.org/) for a complete description of OpenMetadata's features.
|
|
|
|
## License
|
|
OpenMetadata is under [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)
|