Home > Contribute > Core database >

Build the source code

Note

CentOS 7 is the recommended Linux distribution for development and production platform for YugabyteDB.

Install necessary packages

First, install Homebrew, if you do not already have it. Homebrew will be used to install the other required packages.

/usr/bin/ruby -e "$(
  curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

Install the following packages using Homebrew:

brew install autoconf automake bash ccache cmake coreutils gnu-tar libtool \
             maven ninja pkg-config pstree wget python

Note

YugabyteDB build scripts rely on Bash 4. Make sure that which bash outputs /usr/local/bin/bash before proceeding. You may need to put /usr/local/bin as the first directory on PATH in your ~/.bashrc to achieve that.

Build the code

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

cd ~/code/yugabyte-db
./yb_build.sh release

The command above builds the release configuration, puts the C++ binaries in build/release-clang-dynamic-ninja, and creates the build/latest symlink to that directory.

Tip

You can find the binaries you just built in build/latest directory.

Build Java code

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

JDK 8
Apache Maven.

Also make sure Maven's bin directory is added to your PATH (for example, by adding to your ~/.bashrc). See the example below (if you've installed Maven into ~/tools/apache-maven-3.6.3)

export PATH=$HOME/tools/apache-maven-3.6.3/bin:$PATH

For building YugabyteDB Java code, you'll need to install Java and Apache Maven.

Build release package

You can build a release package by executing:

$ ./yb_release
......
2020-10-27 13:55:40,856 [yb_release.py:283 INFO] Generated a package at '/Users/me/code/yugabyte-db/build/yugabyte-2.5.1.0-6ab8013159fdca00ced7e6f5d2f98cacac6a536a-release-darwin-x86_64.tar.gz'```