Basic tarball Installation

Caution

These instructions are designed to get you quickly up and running on your local computer. For putting CrateDB into production, check out the How-To Guides.

See also

This page shows you how get up and running directly from the tarball on any Unix-like system.

Specialised install guides are available for: Linux, macOS, Microsoft Windows, and Docker.

Prerequisites

CrateDB requires a Java virtual machine to run.

Note

Starting with CrateDB 4.2, a Java virtual machine is bundled with the tarball and no extra installation is necessary.

Versions starting from 3.0 to 4.1 require a Java 11 installation. We recommend using Oracle’s Java on macOS and OpenJDK on Linux Systems. Earlier versions required Java 8.

Download

  1. Download the latest CrateDB release.
  2. Unpack the tarball and change into the resulting directory:
sh$ tar -xzf crate-*.tar.gz
sh$ cd crate-*

See also

Other releases of CrateDB are also available.

Check out the release notes for specific information about each CrateDB release.

Run

You do not have to configure or build anything. Once unpacked, CrateDB can be started in the foreground like this:

sh$ ./bin/crate

This command runs a single instance of CrateDB that is bound to the local IP address. Control-C will stop the process.

See also

Consult the CrateDB reference documentation for help using this command.

Next steps

Now you have CrateDB up and running, take the guided tour.

Feedback

How helpful was this page?