InstallWant to connect with Materialize? Join our growing community on Slack! →
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.9.5. The latest (unstable)
developer builds are available at https://dev.materialize.com/. For prior releases,
see the Versions page.
Have any questions? Ask us on Slack
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.9.5 --workers 1
Assuming you’ve installed Homebrew:
brew install MaterializeInc/materialize/materialized
curl -L https://binaries.materialize.com/materialized-v0.9.5-x86_64-apple-darwin.tar.gz \ | sudo tar -xzC /usr/local --strip-components=1
apt (Ubuntu, Debian, or variants)
Note! These instructions changed between versions 0.8.0 and 0.8.1. If you ran them previously, you may need to do so again to continue receiving updates.
# Add the signing key for the Materialize apt repository sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 79DEC5E1B7AE7694 # Add and update the repository sudo sh -c 'echo "deb http://apt.materialize.com/ generic main" > /etc/apt/sources.list.d/materialize.list' sudo apt update # Install materialized sudo apt install materialized
curl -L https://binaries.materialize.com/materialized-v0.9.5-x86_64-unknown-linux-gnu.tar.gz \ | sudo tar -xzC /usr/local --strip-components=1
Build from source
Materialize is written primarily in Rust, but incorporates several components written in C. To build Materialize, you will need to acquire the following tools:
A recent version of Git
A C compiler that supports C11
Your system’s package manager, like Homebrew on macOS or APT on Debian, likely
contains sufficiently recent versions of Git, a C compiler, and CMake. However,
we recommend installing Rust via rustup. rustup configures your system so that
cargo build in the Materialize repository will automatically download
and use the correct version of Rust.
Once you’ve installed the prerequisites, to build your own
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 release.
git clone https://github.com/MaterializeInc/materialize.git cd materialize git checkout v0.9.5 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.
To connect to a running instance, you can use any Materialize-compatible CLI,
mzcli. To install the
brew install postgresql
apt install postgresql-client
Once you have
psql installed, connect using:
psql -U materialize -h localhost -p 6875 materialize