Install CockroachDB

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

   $ curl https://binaries.cockroachdb.com/cockroach-v2.0.7.darwin-10.9-amd64.tgz | tar -xz

2. Copy the binary into your PATH so it's easy to execute cockroach commands from any shell:

   cp -i cockroach-v2.0.7.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:

   Thanks!

What's Next?

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

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.10.* is required, but 1.11 and above is known to not work reliably.
   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 v2.0.7 source archive, and extract the sources:

   $ curl https://binaries.cockroachdb.com/cockroach-v2.0.7.src.tgz | tar -xz

3. In the extracted directory, run make build:

   cd cockroach-v2.0.7

   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.

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/github.com/cockroachdb/cockroach/cockroach, 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:

   Thanks!

What's Next?

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

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 v2.0.7 release of CockroachDB from Docker Hub:

   $ docker pull cockroachdb/cockroach:v2.0.7

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

   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.

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.

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

   $ curl https://binaries.cockroachdb.com/cockroach-v2.0.7.linux-amd64.tgz | tar -xz

2. Copy the binary into your PATH so it's easy to execute cockroach commands from any shell:

   cp -i cockroach-v2.0.7.linux-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:

   Thanks!

What's Next?

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

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.10.* is required, but 1.11 and above is known to not work reliably.
   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.
   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).

   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 v2.0.7 source archive, and extract the sources:

   $ curl https://binaries.cockroachdb.com/cockroach-v2.0.7.src.tgz | tar -xz

3. In the extracted directory, run make build:

   cd cockroach-v2.0.7

   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.

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/github.com/cockroachdb/cockroach/cockroach, 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:

   Thanks!

What's Next?

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

1. Install Docker for Linux. 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.

   Note:

   On Linux, Docker needs sudo privileges.

3. Pull the image for the v2.0.7 release of CockroachDB from Docker Hub:

   $ sudo docker pull cockroachdb/cockroach:v2.0.7

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

   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.

1. Download and extract the CockroachDB v2.0.7 archive for Windows.

2. Open PowerShell, navigate to the directory containing the executable, and make sure it works:

   PS C:\cockroach-v2.0.7.windows-6.2-amd64> .\cockroach.exe version

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

   Thanks!

What's Next?

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

1. 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.

2. Open PowerShell and confirm that the Docker daemon is running in the background:

   PS C:\Users\username> docker version

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

3. 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.

4. Pull the image for the v2.0.7 release of CockroachDB from Docker Hub:

   PS C:\Users\username> docker pull cockroachdb/cockroach:v2.0.7

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

   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.