Installation

This page documents the most basic sort of CrateDB installation.

Note

CrateDB comes pre-packaged for many Linux systems, Docker, and cloud hosting providers. There is also a handy one-line command that let’s you download and run CrateDB on Mac OS X.

To learn more, check out the install section of the CrateDB Guide.

Table of Contents

Prerequisites

CrateDB requires Java 8. We recommend using Oracle’s Java on OSX 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.

Download

Download the latest CrateDB release.

Tip

Older 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 runs a single instance of CrateDB that is bound the local IP address.

Control-C will stop the process.

Pass the --help option for command usage information:

sh$ ./bin/crate --help

Connect

The CrateDB Shell (aka Crash) is shipped with the tarball distribution.

Start the shell like so:

sh$ ./bin/crash

CrateDB also comes with a web administration interface served on port 4200.

Visit the admin interface in your browser at a URL like this one:

http://localhost:4200/

Note

The admin interface runs on each CrateDB node.

Note

If port 4200 is accessed via libraries or the command line, the request will be handled by the CrateDB Rest API, and the response will be JSON.