Install software

This page documents a preview version. v2.23 Preview
Preview includes features under active development and is for development and testing only.
For production, use the latest stable version (v2024.1).

Installing YugabyteDB involves completing prerequisites and downloading the YugabyteDB package.

Prerequisites

Before installing YugabyteDB, ensure that you have the following available:

  1. One of the supported operating systems.

  2. Python 3. To check the version, execute the following command:

    python --version
    
    Python 3.7.3
    

    By default, CentOS 8 does not have an unversioned system-wide python command. To fix this, set python3 as the alternative for python by running sudo alternatives --set python /usr/bin/python3.

    Starting from Ubuntu 20.04, python is no longer available. To fix this, run sudo apt install python-is-python3.

  3. wget or curl.

    The instructions use the wget command to download files. If you prefer to use curl, you can replace wget with curl -O.

    To install wget:

    • On CentOS, run yum install wget
    • On Ubuntu, run apt install wget

    To install curl:

    • On CentOS, run yum install curl
    • On Ubuntu, run apt install curl

Using disk encryption software with YugabyteDB

If you are using third party disk encryption software, such as Vormetric or CipherTrust, the disk encryption service must be up and running on the node before starting any YugabyteDB services. If YugabyteDB processes start before the encryption service, restarting an already encrypted node can result in data corruption.

To avoid issues, stop YugabyteDB services on the node before enabling or disabling the disk encryption service.

Download YugabyteDB

YugabyteDB supports both x86 and ARM (aarch64) CPU architectures. Download packages ending in x86_64.tar.gz to run on x86, and packages ending in aarch64.tar.gz to run on ARM.

The following instructions are for downloading the latest stable release of YugabyteDB, which is recommended for production deployments. For other versions, see Releases.

Which release should I use?

For production deployments, install a stable release.

Preview releases are recommended for development and testing only, and are not supported for production deployments. There is currently no migration path from a preview release to a stable release.

Download YugabyteDB as follows:

  1. Download the YugabyteDB package using one of the following wget commands:

    wget https://downloads.yugabyte.com/releases/2024.1.3.0/yugabyte-2024.1.3.0-b105-linux-x86_64.tar.gz
    

    Or:

    wget https://downloads.yugabyte.com/releases/2024.1.3.0/yugabyte-2024.1.3.0-b105-el8-aarch64.tar.gz
    
  2. Extract the package and then change directories to the YugabyteDB home.

    tar xvfz yugabyte-2024.1.3.0-b105-linux-x86_64.tar.gz && cd yugabyte-2024.1.3.0/
    

    Or:

    tar xvfz yugabyte-2024.1.3.0-b105-el8-aarch64.tar.gz && cd yugabyte-2024.1.3.0/
    

Configure YugabyteDB

To configure YugabyteDB, run the following shell script:

./bin/post_install.sh