Installation from Tarball Archive

This section of the documentation outlines how to use the release archives to install CrateDB. The walkthrough is suitable to install and run CrateDB on Unix-like systems, for example Linux and macOS.

  1. Download the latest CrateDB release archive. Please make sure to select the right release archive matching your system.

  2. Once downloaded, extract the archive either using your favorite terminal or command line shell or by using a GUI tool like 7-Zip:

    # Extract tarball on Unix-like systems
    tar -xzf crate-*.tar.gz
  3. On the terminal, change into the extracted crate directory:

    cd crate-*
  4. Run a CrateDB single-node instance on the local network interface:

  5. In order to stop CrateDB again, use ctrl-c.

See also

Consult the CLI tools documentation for further information about the ./bin/crate command.

Post-install notes

After successfully installing CrateDB, for example on your workstation, the web-based Admin UI can be visited at:


See also

If you are new to CrateDB, you may want to follow up by taking the guided tour.

Also, let us outline those information entrypoints as suggestions to explore next:


This kind of installation flavor will let you quickly set up and start a single-node cluster. When adding additional CrateDB nodes, in order to make it form a multi-node cluster, you will need to reset (remove) the cluster state after changing the configuration.


Please make sure to read the General Upgrade Guidelines, and the guidelines about rolling upgrades and full restart upgrades, before upgrading a running cluster.