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.

Caution

You may experience performance issues when running releases from the public archive on ARM-based macOS systems. For improved performance, we recommend manually building CrateDB suited for ARM-based macOS. Detailed instructions can be found in our manual build guide.

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:

   ./bin/crate
   

Note

When running a specific version of CrateDB from tarball on a macOS system for the first time, it is possible that you will encounter an error like: “java” cannot be opened because developer cannot be verified.

This is expected and can be fixed in your system settings:

• Navigate to System Preferences -> Security and Privacy

• On the page you will see an Allow Anyway button for “java”

• After confirming, run the /bin/crate command again. You will be asked to confirm once more with Open button. After that CrateDB will run as expected.

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:

http://localhost:4200/

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:

• Read more details about the Configuration.

• The background about Bootstrap checks.

• Multi-node configuration within the section about Clustering and Going into production.

• When operating a CrateDB cluster in production, please also take performance tuning into consideration.

Note

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.

Caution

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