Basic CrateDB Tarball Installation

This page shows you how get up and running directly from the tarball.

Note

Specialised install guides are available for: Linux, Mac OS X, Windows, and Docker.

Caution

These instructions are designed to get you up and running on your personal computer.

For putting CrateDB into production, you can learn more about deploying or scaling CrateDB in the CrateDB Guide.

Note

CrateDB requires Java 8. We recommend using Oracle’s Java on Mac OS X and OpenJDK on Linux Systems.

The same JVM version must be used on all CrateDB nodes.

We recommend installing Java 8 update 20 or later.

Table of Contents

Download

Download the latest CrateDB release.

Tip

Other releases of CrateDB are also available.

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

Once downloaded, unpack the tarball and change into the resulting directory:

sh$ tar -xzf crate-*.tar.gz
sh$ cd crate-*

Run

There is no need 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.

Tip

Consult the CrateDB reference documentation for help using this command.