Install CockroachDB | CockroachDB

See Release Notes for what's new in the latest release, v2.0.6.

Use

Homebrew

Install Homebrew.
Instruct Homebrew to install CockroachDB:

copy
```
$ brew install cockroach
```
Keep up-to-date with CockroachDB releases and best practices:

What's Next?

Quick start a single- or multi-node cluster locally and talk to it via the built-in SQL client.

Note:

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.

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

copy
```
$ curl https://binaries.cockroachdb.com/cockroach-v2.0.6.darwin-10.9-amd64.tgz | tar -xJ
```
Copy the binary into your PATH so it's easy to execute cockroach commands from any shell:

copy
```
cp -i cockroach-v2.0.6.darwin-10.9-amd64/cockroach /usr/local/bin
```
If you get a permissions error, prefix the command with sudo.
Keep up-to-date with CockroachDB releases and best practices:

What's Next?

Quick start a single- or multi-node cluster locally and talk to it via the built-in SQL client.

Note:

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.10 or higher is required.
Bash	Versions 4+ are preferred, but later releases from the 3.x series are also known to work.
CMake	Versions 3.81+ 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 v2.0.6 source archive, and extract the sources:

copy
```
$ curl https://binaries.cockroachdb.com/cockroach-v2.0.6.src.tgz | tar -xJ
```
In the extracted directory, run make build:

copy
```
cd cockroach-v2.0.6
```
copy
```
make build
```
The 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, use make buildoss. See this blog post for more details.
Install the cockroach binary into /usr/local/bin so it's easy to execute cockroach commands from any directory:

copy
```
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/github.com/cockroachdb/cockroach/cockroach, but the rest of the documentation assumes you have the binary on your PATH.
Keep up-to-date with CockroachDB releases and best practices:

What's Next?

Quick start a single- or multi-node cluster locally and talk to it via the built-in SQL client.

Note:

Warning:

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.

Install Docker for Mac. Please carefully check that you meet all prerequisites.
Confirm that the Docker daemon is running in the background:

copy
```
$ docker version
```
If you don't see the server listed, start the Docker daemon.
Pull the image for the v2.0.6 release of CockroachDB from Docker Hub:

copy
```
$ docker pull cockroachdb/cockroach:v2.0.6
```
Keep up-to-date with CockroachDB releases and best practices:

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.

Note:

See Release Notes for what's new in the latest release, v2.0.6.

The CockroachDB binary for Linux requires glibc and libncurses, which are found by default on nearly all Linux distributions, with Alpine as the notable exception.

Download the CockroachDB archive for Linux, and extract the binary:

copy
```
$ wget -qO- https://binaries.cockroachdb.com/cockroach-v2.0.6.linux-amd64.tgz | tar  xvz
```
Copy the binary into your PATH so it's easy to execute cockroach commands from any shell:

copy
```
cp -i cockroach-v2.0.6.linux-amd64/cockroach /usr/local/bin
```
If you get a permissions error, prefix the command with sudo.
Keep up-to-date with CockroachDB releases and best practices:

What's Next?

Quick start a single- or multi-node cluster locally and talk to it via the built-in SQL client.

Note:

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.10 or higher is required.
Bash	Versions 4+ are preferred, but later releases from the 3.x series are also known to work.
CMake	Versions 3.81+ are known to work.
Autoconf	Version 2.68 or higher is required.
Terminfo / NCurses development libraries	This may be part of a ncurses development package (e.g. `libncurses-dev` on Debian/Ubuntu, but `ncurses-devel` on CentOS).

Download the CockroachDB v2.0.6 source archive, and extract the sources:

copy
```
$ wget -qO- https://binaries.cockroachdb.com/cockroach-v2.0.6.src.tgz | tar  xvz
```
In the extracted directory, run make build:

copy
```
cd cockroach-v2.0.6
```
copy
```
make build
```
The 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, use make buildoss. See this blog post for more details.
Install the cockroach binary into /usr/local/bin so it's easy to execute cockroach commands from any directory:

copy
```
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/github.com/cockroachdb/cockroach/cockroach, but the rest of the documentation assumes you have the binary on your PATH.
Keep up-to-date with CockroachDB releases and best practices:

What's Next?

Quick start a single- or multi-node cluster locally and talk to it via the built-in SQL client.

Note:

Warning:

Install Docker for Linux. Please carefully check that you meet all prerequisites.
Confirm that the Docker daemon is running in the background:

copy
```
$ docker version
```
If you don't see the server listed, start the Docker daemon.

Note:
On Linux, Docker needs sudo privileges.
Pull the image for the v2.0.6 release of CockroachDB from Docker Hub:

copy
```
$ sudo docker pull cockroachdb/cockroach:v2.0.6
```
Keep up-to-date with CockroachDB releases and best practices:

What's Next?

Note:

See Release Notes for what's new in the latest release, v2.0.6.

Warning:

Native CockroachDB on Windows requires Windows 8 or higher, is experimental, and has not been extensively tested by Cockroach Labs. This prebuilt binary is provided as a convenience for local development and experimentation; production deployments of CockroachDB on Windows are strongly discouraged.

Download and extract the CockroachDB v2.0.6 archive for Windows.
Open PowerShell, navigate to the directory containing the binary, and make sure the CockroachDB executable works:

copy
```
PS C:\cockroach-v2.0.6.windows-6.2-amd64> .\cockroach.exe version
```
Keep up-to-date with CockroachDB releases and best practices:

What's Next?

Quick start a single- or multi-node cluster locally and talk to it via the built-in SQL client.

Note:

Was this page helpful?

Yes No