Quickstart
Metaform is a self-hosted data fabric that unifies disparate data sources exactly where they already live.
This quick-start guide walks new users through pulling the Metaform Docker image and running it with Docker Desktop, giving you a fully local environment for exploration and testing.
Follow the sections below to get up and running.
Pull the Image
Before beginning, make sure Docker Desktop is installed and running on your system. Once Docker is ready, open a terminal inside Docker Desktop and pull the latest Metaform image from the Quay registry:
docker pull quay.io/metaform/metaform:latest
This command downloads the Docker image tagged latest from quay.io/metaform/metaform, ensuring you have the newest Metaform build. You may see output showing Docker fetching layers of the image.
Run the Container
To start Metaform, run the container with appropriate options:
docker run -d -p 8047:8047 -v ${PWD}:/data -v ${PWD}/metaform:/persist quay.io/metaform/metaform
Let’s break down Docker’s run command.
| Flag | Meaning |
|---|---|
-d | Runs the container in detached mode, keeping it in the background so your terminal stays free. |
-p 8047:8047 | Publishes Metaform on localhost:8047, mapping your machine’s port to the container’s port. |
-v ${PWD}:/data | Mounts the current working directory into the container at /data for file access. Metaform reads files from /data, so it can directly access files from your local system without copying them. |
-v ${PWD}/metaform:/persist | Mounts a persistent directory used to store configuration that survives container restarts. |
Access the Console
With the image pulled and the container running, Metaform is now live on your machine. Open your browser and navigate to:
http://localhost:8047
If everything started correctly, you’ll be greeted by the Metaform Console—a web-based interface where you can run queries, inspect connectors, and explore your data.
Next Steps
You’ve successfully set up Metaform—now it’s time to extend it. Head over to the Connectors section and start installing a few. Each connector includes a practical scenario and a fully working example, giving you a structured way to explore how Metaform reads, interprets, and queries real data.