OpenMetadata/openmetadata-docs/content/quick-start/local-deployment.md

title	slug
Try OpenMetadata in Docker	/quick-start/local-deployment

Local Docker Deployment

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

If you'd rather see the steps in a guided tutorial, we've got you covered! Otherwise, feel free to read the content below 👇

Requirements (OSX and Linux)

Please ensure your host system meets the requirements listed below. Then continue to the Procedure for installing OpenMetadata.

Docker (version 20.10.0 or greater)

Docker is an open-source platform for developing, shipping, and running applications. It enables you to separate your applications from your infrastructure, so you can deliver software quickly using OS-level virtualization. It helps deliver software in packages called Containers.

To check what version of Docker you have, please use the following command.

docker --version

If you need to install Docker, please visit Get Docker.

You must allocate at least 6GB of memory to Docker in order to run OpenMetadata. To change the memory allocation for Docker, please visit Preferences -> Resources -> Advanced in your Docker Desktop.

Docker Compose (version v2.1.1 or greater)

The Docker compose package enables you to define and run multi-container Docker applications. The compose command integrates compose functions into the Docker platform, making them available from the Docker command-line interface ( CLI). The Python packages you will install in the procedure below use compose to deploy OpenMetadata.

• MacOS X: Docker on MacOS X ships with compose already available in the Docker CLI.
• Linux: To install compose on Linux systems, please visit the Docker CLI command documentation and follow the instructions.

To verify that the docker compose command is installed and accessible on your system, run the following command.

docker compose version

Upon running this command you should see output similar to the following.

Docker Compose version v2.1.1

Install Docker Compose Version 2.0.0 on Linux

Follow the instructions here to install docker compose version 2.0.0

1. Run the following command to download the current stable release of Docker Compose

   DOCKER_CONFIG=${DOCKER_CONFIG:-$HOME/.docker}
   
   mkdir -p $DOCKER_CONFIG/cli-plugins curl
   -SL https://github.com/docker/compose/releases/download/v2.2.3/docker-compose-linux-x86_64 -o
   $DOCKER_CONFIG/cli-plugins/docker-compose
   

   This command installs Compose V2 for the active user under $HOME directory. To install Docker Compose for all users on your system, replace ~/.docker/cli-plugins with /usr/local/lib/docker/cli-plugins.
2. Apply executable permissions to the binary

   chmod +x $DOCKER_CONFIG/cli-plugins/docker-compose 
   

3. Test your installation

   docker compose version
   > Docker Compose version v2.2.3
   

WSL2, Ubuntu 20.04, and Docker for Windows

• Install WSL2
• Install Ubuntu 20.04
• Install Docker for Windows

Get the latest release and run

From your terminal:

mkdir openmetadata && cd "$_"
wget https://github.com/open-metadata/OpenMetadata/releases/download/0.11.0-release/docker-compose.yml
docker compose up -d

This will start all the necessary components locally. You can validate that all containers are up and running with docker ps.

❯ docker ps
CONTAINER ID   IMAGE                                                  COMMAND                  CREATED          STATUS                    PORTS                                                            NAMES
470cc8149826   openmetadata/server:0.11.0                             "./openmetadata-star…"   45 seconds ago   Up 43 seconds             3306/tcp, 9200/tcp, 9300/tcp, 0.0.0.0:8585-8586->8585-8586/tcp   openmetadata_server
63578aacbff5   openmetadata/ingestion:0.11.0                          "./ingestion_depende…"   45 seconds ago   Up 43 seconds             0.0.0.0:8080->8080/tcp                                           openmetadata_ingestion
9f5ee8334f4b   docker.elastic.co/elasticsearch/elasticsearch:7.10.2   "/tini -- /usr/local…"   45 seconds ago   Up 44 seconds             0.0.0.0:9200->9200/tcp, 0.0.0.0:9300->9300/tcp                   openmetadata_elasticsearch
08947ab3424b   openmetadata/db:0.11.0                                 "/entrypoint.sh mysq…"   45 seconds ago   Up 44 seconds (healthy)   3306/tcp, 33060-33061/tcp                                        openmetadata_mysql

In a few seconds, you should be able to access the OpenMetadata UI at http://localhost:8585:

Go on a tour and start discovering the power of metadata & collaboration

Log in to Airflow

OpenMetadata ships with an Airflow container to run the ingestion workflows that have been deployed via the UI.

In the Airflow, you will also see some sample DAGs that will ingest sample data and serve as an example.

You can access Airflow at http://localhost:8080. Use the following credentials to log in to Airflow.

• Username: admin
• Password: admin

Security

Please follow our Enable Security Guide to configure security for your OpenMetadata installation.

Advanced

If you want to persist your data, prepare Named Volumes for the containers.

Next Steps

1. Visit the Features overview page and explore the OpenMetadata UI.
2. Visit the Connectors documentation to see what services you can integrate with OpenMetadata.
3. Visit the API documentation and explore the rich set of OpenMetadata APIs.