mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2025-07-19 23:39:12 +00:00

* GitBook: [#177] Documentation Update - Airflow * GitBook: [#195] Removing Cron from databaseServices * GitBook: [#196] Added trino * GitBook: [#197] removed cron from config * GitBook: [#198] Added Redash Documentation * GitBook: [#199] Added Bigquery Usage Documentation * GitBook: [#200] Added page link for presto * GitBook: [#201] Added Local Docker documentation * GitBook: [#202] Added Documentation for Local Docker Setup * GitBook: [#203] Added Git Command to clone Openmetadata in docs * GitBook: [#207] links update * GitBook: [#208] Updating Airflow Documentation * GitBook: [#210] Adding Python installation package under Airflow Lineage config * GitBook: [#211] Change the links to 0.5..0 * GitBook: [#213] Move buried connectors page up * GitBook: [#214] Update to connectors page * GitBook: [#215] Removed sub-categories * GitBook: [#212] Adding Discovery tutorial * GitBook: [#220] Updated steps to H2s. * GitBook: [#230] Complex queries * GitBook: [#231] Add lineage to feature overview * GitBook: [#232] Make feature overview headers verbs instead of nouns * GitBook: [#233] Add data reliability to features overview * GitBook: [#234] Add complex data types to feature overview * GitBook: [#235] Simplify and further distinguish discovery feature headers * GitBook: [#236] Add data importance to feature overview * GitBook: [#237] Break Connectors into its own section * GitBook: [#238] Reorganize first section of docs. * GitBook: [#239] Add connectors to feature overview * GitBook: [#240] Organize layout of feature overview into feature categories as agreed with Harsha. * GitBook: [#242] Make overview paragraph more descriptive. * GitBook: [#243] Create a link to Connectors section from feature overview. * GitBook: [#244] Add "discover data through association" to feature overview. * GitBook: [#245] Update importance and owners gifs * GitBook: [#246] Include a little more descriptive documentation for key features. * GitBook: [#248] Small tweaks to intro paragraph. * GitBook: [#249] Clean up data profiler paragraph. * GitBook: [#250] Promote Complex Data Types to its own feature. * GitBook: [#251] Update to advanced search * GitBook: [#252] Update Roadmap * GitBook: [#254] Remove old features page (text and screenshot based). * GitBook: [#255] Remove references to removed page. * GitBook: [#256] Add Descriptions and Tags section to feature overview. * GitBook: [#257] Update title for "Know Your Data" Co-authored-by: Ayush Shah <ayush.shah@deuexsolutions.com> Co-authored-by: Suresh Srinivas <suresh@getcollate.io> Co-authored-by: Shannon Bradshaw <shannon.bradshaw@arrikto.com> Co-authored-by: OpenMetadata <github@harsha.io>
OpenMetadata
Docker
Steps to run openmetadata using docker
cd docker/metadata/
docker-compose build
docker-compose up
Open in browser http://localhost:8585/api/swagger
Command line
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.
mvn -DskipTests clean package
cd dist/target
unzip openmetadata-1.0.0-SNAPSHOT.zip
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/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>