Build the source code

• macOS
• CentOS
• Ubuntu

NoteCentOS 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. We will use this 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 bison ccache cmake  \
             coreutils flex gnu-tar icu4c libtool maven \
             ninja pkg-config pstree wget zlib [email protected]

NoteYugabyteDB 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.

Building the code

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

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

The above command will build the release configuration, put the C++ binaries in build/release-gcc-dynamic-community, and will also create the build/latest symlink to that directory.

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

For Linux, it will first make sure our custom Linuxbrew distribution is installed into ~/.linuxbrew-yb-build/linuxbrew-<version>.

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.5.0)

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

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