TrailDB depends on two external libraries:

• Judy arrays
• Libarchive

You can install these libraries using a package manager as described below.

First, clone the latest version of TrailDB from GitHub:

git clone https://github.com/traildb/traildb

Install on Linux¶

Here we assume you are installing TrailDB on Ubuntu / Debian. It is easy to adapt the steps for other distributions.

Install the dependencies:

apt-get install libjudy-dev libarchive-dev pkg-config build-essential

Build TrailDB using waf

./waf configure
./waf build

waf writes the output to the build directory. You can install the library and the tdb command line tool to a system-wide directory with

./waf install

That’s all. See below for instructions for testing the installation.

Alternatively, TrailDB provides an autotools-based build system which can be run as follows:

./autogen.sh
./configure
make
make install

Note that some old versions of Ubuntu and Debian include a version of Judy that is broken (1.0.5-1 or older). The build will fail if a broken version is found. You can install a newer version of Judy manually if your system is affected.

To install fixed version of Judy on Ubuntu 14.04 to 15.04, you can use packages from Ubuntu Xenial (16.04):

wget https://mirrors.kernel.org/ubuntu/pool/universe/j/judy/libjudy-dev_1.0.5-5_amd64.deb \
     https://mirrors.kernel.org/ubuntu/pool/universe/j/judy/libjudydebian1_1.0.5-5_amd64.deb
sudo dpkg -i libjudy-dev_1.0.5-5_amd64.deb libjudydebian1_1.0.5-5_amd64.deb

Install on OS X¶

Using Homebrew¶

TrailDB package is available in Homebrew:

brew install traildb

Building from source¶

Install the dependencies:

brew install traildb/judy/judy libarchive pkg-config

Build TrailDB using waf

./waf configure
./waf build

waf writes the output to the build directory. You can install the library and the tdb command line tool to a system-wide directory with

./waf install

Test that it works¶

There is a small test file, test.tdb, included in the root of the TrailDB repository. Once the tdb command line tool is built and installed properly, you should be able to run

tdb dump -i test

at the root of the repository. You should see two events, hello world and it works!, if everything works ok.

Install Python bindings¶

The following tutorial includes examples in C and Python. If you want to use Python, you need to install the Python binding:

git clone https://github.com/traildb/traildb-python

Install the Python package with

python setup.py install

For other language bindings, follow the instructions in their README files.