Materialize/doc/user/content/get-started/install-materialize-emulator.md

---

title: "Download and run Materialize Emulator" description: "The Materialize Emulator is an all-in-one Docker image available on Docker Hub, offering the fastest way to get hands-on experience with Materialize in a local environment." menu: main:

parent: "get-started"
weight: 16
name: "Download and run Materialize Emulator"

---

The Materialize Emulator is an all-in-one Docker image available on Docker Hub for testing and evaluation purposes. The Materialize Emulator is not representative of Materialize's performance and full feature set.

{{< important >}}

The Materialize Emulator is not suitable for production workloads..

{{</ important >}}

Materialize Emulator

Materialize Emulator is the easiest way to get started with Materialize, but is not suitable for full feature set evaluations or production workloads.

Materialize Emulator	Details
What is it	A single Docker container version of Materialize.
Best For	Prototyping and CI jobs.
Known Limitations	Not indicative of true Materialize performance. Services are bundled in a single container. No fault tolerance. No data persistence. No support for version upgrades.
Evaluation Experience	Download from Docker Hub.
Support	Materialize Community Slack channel.
License/legal arrangement	BSL/Materialize's privacy policy

Prerequisites

• Docker. If Docker is not installed, refer to its official documentation to install.

Run Materialize Emulator

{{< note >}}

• Use of the Docker image is subject to Materialize's BSL License.

• By downloading the Docker image, you are agreeing to Materialize's privacy policy.

{{</ note >}}

1. In a terminal, issue the following command to run a Docker container from the Materialize Emulator image. The command downloads the image, if one has not been already downloaded.

   docker run -d -p 127.0.0.1:6874:6874 -p 127.0.0.1:6875:6875 -p 127.0.0.1:6876:6876 materialize/materialized:{{< version >}}
   

When running locally:

• The Docker container binds exclusively to localhost for security reasons.
• The Materialize Console is available on port 6874.
• The SQL interface is available on port 6875.
• Logs are available via docker logs <container-id>.
• A default user materialize is created.
• A default database materialize is created.

Open the Materialize Console in your browser at http://localhost:6874.

Alternatively, you can connect to the Materialize Emulator using your preferred SQL client, using the following connection field values:

| Field | Value | |----------|---------------| | Server | localhost | | Database | materialize | | Port | 6875 | | Username | materialize |

For example, if using psql:

   psql postgres://materialize@localhost:6875/materialize

1. Once connected, you can get started with the Quickstart.

Next steps

• To start ingesting your own data from an external system like Kafka, MySQL or PostgreSQL, check the documentation for sources.

• Join the Materialize Community on Slack.

• To fully evaluate Materialize Cloud, sign up for a free trial Materialize Cloud account. The full experience of Materialize is also available as a self-managed offering. See Self-managed Materialize.

Technical Support

For questions, discussions, or general technical support, join the Materialize Community on Slack.

mz-debug

Materialize provides a [mz-debug]command-line debug tool called that helps collect diagnostic information from your emulator environment. This tool can gather:

• Docker logs and resource information
• Snapshots of system catalog tables from your Materialize instance

To debug your emulator instance, you can use the following command:

mz-debug emulator --docker-container-id <your-container-id>

This debug information can be particularly helpful when troubleshooting issues or when working with the Materialize support team.

For more detailed information about the debug tool, see the mz-debug documentation.

License and privacy policy

• Use of the Docker image is subject to Materialize's BSL License.

• By downloading the Docker image, you are agreeing to Materialize's privacy policy.

Materialize Self-Managed Community Edition or the Materialize Emulator Privacy FAQ

When you use the Materialize Self-Managed Community Edition or the Materialize Emulator, we may collect the following information from the machine that runs the Materialize Self-Managed Community Edition or the Materialize Emulator software:

• The IP address of the machine running Materialize.

• If available, the cloud provider and region of the machine running Materialize.

• Usage data about your use of the product such as the types or quantity of commands you run, the number of clusters or indexes you are running, and similar feature usage information.

The collection of this data is subject to the Materialize Privacy Policy.

Please note that if you visit our website or otherwise engage with us outside of downloading the Materialize Self-Managed Community Edition or the Materialize Emulator, we may collect additional information about you as further described in our Privacy Policy.