You can access Materialize through the
materialized binary, which you can
install on macOS and Linux, or build on most OSes (e.g. FreeBSD). These
instructions install the latest release of Materialize, v0.3.1. The latest (unstable)
developer builds are available at https://mtrlz.dev/. For prior releases,
see the Versions page.
Have any questions? Contact us
We provide the
materialize/materialized image in Docker Hub. If you already have
Docker installed, you can run materialized with your tools in the usual
way. For example:
docker run -p 6875:6875 materialize/materialized:v0.3.1 --workers 1
Assuming you’ve installed Homebrew:
brew install MaterializeInc/materialize/materialized
curl -L https://downloads.mtrlz.dev/materialized-v0.3.1-x86_64-apple-darwin.tar.gz \ | tar -xzC /usr/local --strip-components=1
apt (Ubuntu, Debian, or variants)
Run the following commands as root.
# Add the signing key for the Materialize apt repository apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 379CE192D401AB61 # Add and update the repository sh -c 'echo "deb http://packages.materialize.io/apt/ /" > /etc/apt/sources.list.d/materialize.list' apt update # Install materialized apt install materialized
curl -L https://downloads.mtrlz.dev/materialized-v0.3.1-x86_64-unknown-linux-gnu.tar.gz \ | tar -xzC /usr/local --strip-components=1
Build from source
Materialize is written in Rust and requires a recent Rust toolchain to build from source. Follow Rust’s getting started guide if you don’t already have Rust installed.
Then, to build your own
materialized binary, you can clone the
MaterializeInc/materialize repo from GitHub,
and build it using
cargo build. Be sure to check out the tag for the correct
git clone https://github.com/MaterializeInc/materialize.git cd materialize git checkout v0.3.1 cargo build --release
Run the binary
You can start the
materialized process by simply running the binary, e.g.
./materialized -w 1
-w 1 specifies that the process will use 1 worker. You can also find more detail
about our command line flags.
For more information, see CLI Connections.Next, let’s get started with Materialize →