Build the source code

Build the source code.


AlmaLinux 8 is the recommended Linux development platform for YugabyteDB.


The commands below assume the following:

  • You have sudo access.
  • You are using a bash or zsh shell.
  • You are running the commands as the user who will be doing development.
# Modify to your preference:

sudo dnf update -y
sudo dnf groupinstall -y 'Development Tools'
sudo dnf -y install epel-release
sudo dnf -y install "${packages[@]}"
sudo alternatives --set python3 /usr/bin/python3.9
latest_zip_url=$(curl -Ls "" \
                 | grep browser_download_url | grep | cut -d \" -f 4)
curl -Ls "$latest_zip_url" | zcat | sudo tee /usr/local/bin/ninja >/dev/null
sudo chmod +x /usr/local/bin/ninja
sudo mkdir /opt/yb-build

# If you'd like to use an unprivileged user for development, manually
# run/modify instructions from here onwards (change $USER, make sure shell
# variables are set appropriately when switching users).
sudo chown "$USER" /opt/yb-build
source <(echo 'export YB_CCACHE_DIR="$HOME/.cache/yb_ccache"' \
         | tee -a "$shellrc")

git clone
cd yugabyte-db

Detailed instructions

Update and install basic development packages as follows:

sudo dnf update -y
sudo dnf groupinstall -y 'Development Tools'
sudo dnf -y install epel-release libatomic rsync


By default, when running build, third-party libraries are not built, and pre-built libraries are downloaded. We also use Linuxbrew to provide some of the third-party dependencies. The build scripts automatically install these in directories under /opt/yb-build. In order for the build script to write under those directories, it needs proper permissions. One way to do that is as follows:

sudo mkdir /opt/yb-build
sudo chown "$USER" /opt/yb-build

Alternatively, specify the build options --no-download-thirdparty and/or --no-linuxbrew. Note that those options may require additional, undocumented steps.

Python 3

Python 3.7 or higher is required.

The following example installs Python 3.9.

sudo dnf install -y python39

In case there is more than one Python 3 version installed, ensure that python3 refers to the right one.

sudo alternatives --set python3 /usr/bin/python3.9
sudo alternatives --display python3
python3 -V

CMake 3

CMake 3.17.3 or higher is required.

sudo dnf install -y cmake3


YugabyteDB core is written in C and C++, but the repository contains Java code needed to run some tests and sample applications. To build the Java part, you need:

  • Java Development Kit (JDK) 8 or 11.
  • Apache Maven 3.3 or later.

Install the following packages to satisfy the preceding requirements:

sudo dnf install -y java-1.8.0-openjdk maven


yugabyted-ui is a UI for yugabyted. By default, it is not built unless the corresponding build option is specified or a release package is being built. To build it, npm and Go 1.20 or higher are required.

sudo dnf install -y npm golang

Ninja (optional)

Install Ninja for faster builds as follows:

The latest release can be downloaded:

latest_zip_url=$(curl -Ls "" \
                 | grep browser_download_url | grep | cut -d \" -f 4)
curl -Ls "$latest_zip_url" | zcat | sudo tee /usr/local/bin/ninja >/dev/null
sudo chmod +x /usr/local/bin/ninja

Ccache (optional)

Install and configure Ccache for faster builds as follows:

sudo dnf install -y ccache
# Also add the following line to your .bashrc or equivalent.
export YB_CCACHE_DIR="$HOME/.cache/yb_ccache"

GCC (optional)

To compile with GCC, install the following packages, and adjust the version numbers to match the GCC version you plan to use.

sudo dnf install -y gcc-toolset-11 gcc-toolset-11-libatomic-devel

Build the code

Assuming this repository is checked out in ~/code/yugabyte-db, do the following:

cd ~/code/yugabyte-db
./ release

The command above will build the release configuration, add the binaries into the build/release-<compiler>-dynamic-ninja directory, and create a build/latest symlink to that directory.


If you see errors, such as internal compiler error: Killed, the system has probably run out of memory. Try again by running the build script with less concurrency, for example, -j1.


If you get an error message such as

ValueError: Found no third-party release archives to download for OS type ubuntu20.04, compiler type matching gcc11, architecture x86_64, is_linuxbrew=False. See more details above.

it means that there is no third-party download available for that build configuration. Check the output that precedes the message for supported configurations.

For more details about building and testing, refer to Build and test.

Build release package (optional)

Perform the following steps to build a release package:

  1. Satisfy requirements for building yugabyted-ui.

  2. Install patchelf:

    sudo dnf install -y patchelf
  3. Run the yb_release script using the following command:

    2023-02-14 04:14:16,092 [ INFO] Generated a package at '/home/user/code/yugabyte-db/build/yugabyte-'


The build may fail with "too many open files". In that case, increase the nofile limit in /etc/security/limits.conf as follows:

echo "* - nofile 1048576" | sudo tee -a /etc/security/limits.conf

Start a new shell session, and check the limit increase with ulimit -n.