There are four ways to install CockroachDB on macOS. See Release Notes for what's new in the latest release, v1.0.7.
Download the Binary
-
Download the CockroachDB archive for OS X, and extract the binary:
$ curl https://binaries.cockroachdb.com/cockroach-v1.0.7.darwin-10.9-amd64.tgz \ | tar -xzNote:You can also download other versions of the binary listed on our Releases page. -
Copy the binary into your
PATHso it's easy to execute cockroach commands from any shell:cp -i cockroach-v1.0.7.darwin-10.9-amd64/cockroach /usr/local/bin/If you get a permissions error, prefix the command with
sudo. -
Get future release notes emailed to you:
Thanks!
What's Next?
Quick start a single- or multi-node cluster locally and talk to it via the built-in SQL client.
Build from Source
-
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.8.1 is required. 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.
-
Download the CockroachDB v1.0.7 source archive, and extract the sources:
$ curl https://binaries.cockroachdb.com/cockroach-v1.0.7.src.tgz \ | tar -xzNote:You can also download other versions of the binary listed on our Releases page. In the extracted directory, run
make build:cd cockroach-v1.0.7make buildThe build process can take 10+ minutes, so please be patient.
Note: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, usemake buildoss. See this blog post for more details.-
Install the
cockroachbinary into/usr/local/bin/so it's easy to execute cockroach commands from any directory:make installIf you get a permissions error, prefix the command with
sudo.You can also execute the
cockroachbinary directly from its built location,./src/github.com/cockroachdb/cockroach/cockroach, but the rest of the documentation assumes you have the binary on yourPATH. -
Get future release notes emailed to you:
Thanks!
What's Next?
Quick start a single- or multi-node cluster locally and talk to it via the built-in SQL client.
Use Docker
-
Install Docker for Mac. Please carefully check that you meet all prerequisites.
-
Confirm that the Docker daemon is running in the background:
$ docker versionIf you do not see the server listed, start the Docker daemon.
-
Pull the official CockroachDB image from Docker Hub:
$ docker pull cockroachdb/cockroach:v1.0.7 -
Get future release notes emailed to you:
Thanks!
What's Next?
Quick start a multi-node cluster across multiple Docker containers on a single host, using Docker volumes to persist node data, or explore running a physically distributed cluster in containers using orchestration tools.
There are three ways to install CockroachDB on Linux. See Release Notes for what's new in the latest release, v1.0.7.
Download the Binary
-
Download the CockroachDB archive for Linux, and extract the binary:
$ curl https://binaries.cockroachdb.com/cockroach-v1.0.7.linux-amd64.tgz \ | tar -xzNote:You can also download other versions of the binary listed on our Releases page. -
Copy the binary into your
PATHso it's easy to execute cockroach commands from any shell:cp -i cockroach-v1.0.7.linux-amd64/cockroach /usr/local/bin/If you get a permissions error, prefix the command with
sudo. -
Get future release notes emailed to you:
Thanks!
What's Next?
Quick start a single- or multi-node cluster locally and talk to it via the built-in SQL client.
Build from Source
-
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.8, or a later version in the 1.8 series, is required. 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.
-
Download the CockroachDB v1.0.7 source archive, and extract the sources:
$ curl https://binaries.cockroachdb.com/cockroach-v1.0.7.src.tgz \ | tar -xzNote:You can also download other versions of the binary listed on our Releases page. In the extracted directory, run
make build:cd cockroach-v1.0.7make buildThe build process can take 10+ minutes, so please be patient.
Note: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, usemake buildoss. See this blog post for more details.-
Install the
cockroachbinary into/usr/local/bin/so it's easy to execute cockroach commands from any directory:make installIf you get a permissions error, prefix the command with
sudo.You can also execute the
cockroachbinary directly from its built location,./src/github.com/cockroachdb/cockroach/cockroach, but the rest of the documentation assumes you have the binary on yourPATH. -
Get future release notes emailed to you:
Thanks!
What's Next?
Quick start a single- or multi-node cluster locally and talk to it via the built-in SQL client.
Use Docker
-
Install Docker for Linux. Please carefully check that you meet all prerequisites.
-
Confirm that the Docker daemon is running in the background:
$ docker versionIf you do not see the server listed, start the Docker daemon.
Note:On Linux, Docker needs sudo privileges. -
Pull the official CockroachDB image from Docker Hub:
$ sudo docker pull cockroachdb/cockroach:v1.0.7 -
Get future release notes emailed to you:
Thanks!
What's Next?
Quick start a multi-node cluster across multiple Docker containers on a single host, using Docker volumes to persist node data, or explore running a physically distributed cluster in containers using orchestration tools.
There are two ways to install CockroachDB on Windows. See Release Notes for what's new in the latest release, v1.0.7.
Download the Binary
-
Download and extract the CockroachDB v1.0.7 archive for Windows.
-
Open PowerShell, navigate to the directory containing the binary, and make sure The CockroachDB executable for Windows works:
PS C:\cockroach-v1.0.7.windows-6.2-amd64> .\cockroach.exe version -
Get future release notes emailed to you:
Thanks!
What's Next?
Quick start a single- or multi-node cluster locally and talk to it via the built-in SQL client.
Use Docker
-
Install Docker for Windows.
Docker for Windows requires 64bit Windows 10 Pro and Microsoft Hyper-V. Please see the official documentation for more details. Note that if your system does not satisfy the stated requirements, you can try using Docker Toolbox. -
Open PowerShell and confirm that the Docker daemon is running in the background:
PS C:\Users\username> docker versionIf you do not see the server listed, start Docker for Windows.
-
Share your local drives. This makes it possible to mount local directories as data volumes to persist node data after containers are stopped or deleted.
-
Pull the official CockroachDB image from Docker Hub:
PS C:\Users\username> docker pull cockroachdb/cockroach:v1.0.7 -
Get future release notes emailed to you:
Thanks!
What's Next?
Quick start a multi-node cluster across multiple Docker containers on a single host, using Docker volumes to persist node data, or explore running a physically distributed cluster in containers using orchestration tools.
Was this helpful?
