CrateDB on Debian, Ubuntu, and Derivates

Install CrateDB deb packages using the apt package manager.

This installation method is suitable for Debian systems and derivates like Ubuntu.

Configure package repository

You will need to configure your system to register with and trust packages from the CrateDB package repository:

# Install prerequisites.
sudo apt update
sudo apt install --yes apt-transport-https apt-utils curl gnupg lsb-release

# Import the public GPG key for verifying the package signatures.
curl -sS https://cdn.crate.io/downloads/debian/DEB-GPG-KEY-crate | \
    sudo tee /etc/apt/trusted.gpg.d/cratedb.asc

# Add CrateDB repository to Apt
echo "deb https://cdn.crate.io/downloads/debian/stable/ default main" | \
    sudo tee /etc/apt/sources.list.d/crate-stable.list

Note

CrateDB provides two repositories. A stable and a testing repository. To use the testing repository, replace stable with testing in the command above. You can read more about our release workflow.

Now, update the package sources:

sh$ sudo apt update

You should see a success message. This indicates that the CrateDB package repository is correctly registered.

Install CrateDB

With everything set up, you can install CrateDB:

sh$ sudo apt install crate

After the installation is finished, you can start the crate service:

sh$ sudo systemctl start crate

Once the service is up and running, you can access CrateDB by visiting:

http://localhost:4200/

Configure CrateDB

Please visit the Configuration Settings documentation section to learn about the location and meaning of CrateDB’s configuration files.

Control CrateDB on Linux

You can control the crate service with the systemctl utility program:

sudo systemctl COMMAND crate

Replace COMMAND with start, stop, restart, status and so on.

Notes

After the installation is finished, the crate service should be installed, but may not be configured to start automatically. Use the following command to start CrateDB:

sudo systemctl start crate

In order to make the service reboot-safe, invoke:

sudo systemctl enable crate

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:

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.