Install CockroachDB on Mac

This version of CockroachDB is no longer supported. For more details, see the Release Support Policy.

See Release Notes for what's new in the latest release, v19.1.11. To upgrade to this release from an older version, see Cluster Upgrade.

Download the binary

  1. Download the CockroachDB archive for OS X, and extract the binary:

    curl | tar -xJ
  2. Copy the binary into your PATH so you can execute cockroach commands from any shell:

    cp -i cockroach-v19.1.11.darwin-10.9-amd64/cockroach /usr/local/bin/

    If you get a permissions error, prefix the command with sudo.

  3. Keep up-to-date with CockroachDB releases and best practices:

Use Kubernetes

To orchestrate CockroachDB locally using Kubernetes, either with configuration files or the Helm package manager, see Orchestrate CockroachDB Locally with Minikube.

Use Docker

Running a stateful application like CockroachDB in Docker is more complex and error-prone than most uses of Docker. Unless you are very experienced with Docker, we recommend starting with a different installation and deployment method.
  1. Install Docker for Mac. Please carefully check that you meet all prerequisites.

  2. Confirm that the Docker daemon is running in the background:

    $ docker version

    If you do not see the server listed, start the Docker daemon.

  3. Pull the image for the v19.1.11 release of CockroachDB from Docker Hub:

    $ docker pull cockroachdb/cockroach:v19.1.11
  4. Keep up-to-date with CockroachDB releases and best practices:

Build from source

  1. Install the following prerequisites, as necessary:

    C++ compiler Must support C++ 11. GCC prior to 6.0 does not work due to this issue. On macOS, Xcode should suffice.
    Go Version 1.11.6+ is required, but 1.12 and above is not recommended. Older versions might work via make build IGNORE_GOVERS=1.
    Bash Versions 4+ are preferred, but later releases from the 3.x series are also known to work.
    CMake Versions 3.8+ are known to work.
    Autoconf Version 2.68 or higher is required.

    A 64-bit system is strongly recommended. Building or running CockroachDB on 32-bit systems has not been tested. You'll also need at least 2GB of RAM. If you plan to run our test suite, you'll need closer to 4GB of RAM.

  2. Download the CockroachDB v19.1.11 source archive, and extract the sources:

    $ curl | tar -xJ
  3. In the extracted directory, run make build:

    cd cockroach-v19.1.11
    make build

    The build process can take 10+ minutes, so please be patient.

    The default binary contains core open-source functionality covered by the Apache License 2 (APL2) and enterprise functionality covered by the CockroachDB Community License (CCL). To build a pure open-source (APL2) version excluding enterprise functionality, use make buildoss. See this blog post for more details.
  4. Install the cockroach binary into /usr/local/bin/ so it's easy to execute cockroach commands from any directory:

    make install

    If you get a permissions error, prefix the command with sudo.

    You can also execute the cockroach binary directly from its built location, ./src/, but the rest of the documentation assumes you have the binary on your PATH.

  5. Keep up-to-date with CockroachDB releases and best practices:

What's next?

By default, each node of a CockroachDB cluster periodically shares anonymous usage details with Cockroach Labs. For an explanation of the details that get shared and how to opt-out of reporting, see Diagnostics Reporting.
YesYes NoNo