Quick Start

Install Jubatus

We officially support Ubuntu Server 12.04 LTS (x86_64) and Red Hat Enterprise Linux 6.2 or later (x86_64).

On supported systems, you can install all components of Jubatus using binary packages. For other systems, see Building Jubatus from Source.

Yum Repository (RHEL)

Run the following command to register Jubatus Yum repository to the system.

$ sudo rpm -Uvh http://download.jubat.us/yum/rhel/6/stable/x86_64/jubatus-release-6-1.el6.x86_64.rpm

Now install jubatus and jubatus-client package.

$ sudo yum install jubatus jubatus-client

Apt Repository (Ubuntu)

Write the following line to /etc/apt/sources.list.d/jubatus.list to register Jubatus Apt repository to the system.

deb http://download.jubat.us/apt binary/

Now install jubatus package.

$ sudo apt-get update
$ sudo apt-get install jubatus

Currently our package is not GPG-signed. Bypass the warning by answering y to the prompt when asked:

Install these packages without verification [y/N]? y

Now Jubatus is installed in /opt/jubatus.

Each time before using Jubatus, you need to load the environment variable from profile script.

$ source /opt/jubatus/profile

If you’re using csh or tcsh, use this instead:

$ source /opt/jubatus/profile.csh

Install Jubatus Client Libraries

Jubatus client applications can be written in C++, Python, Ruby or Java. You need to setup the client library for each language to use Jubatus from client applications. Client libraries are distributed under MIT License.

If you’re going to try Tutorial, just install Python client and go ahead.

Version of Jubatus and Jubatus clients may be different, as clients are not updated when there are no API changes to Jubatus.

C++

The client is included in the Jubatus framework ($PREFIX/include/jubatus/client/*_client.hpp) and no additional setup is required.

If you don’t have compilers and/or development headers installed, you will need to setup them. For RHEL systems, type:

$ sudo yum groupinstall "Development tools" "Additional Development"

For Ubuntu systems, type:

$ sudo apt-get install build-essential

Python

The client (requires Python 2.7 or later) is available in PyPI.

$ sudo pip install jubatus

If you don’t have pip command, run the following command:

$ wget http://peak.telecommunity.com/dist/ez_setup.py
$ sudo python ez_setup.py
$ sudo easy_install pip

On Ubuntu, you can also use python-pip package to install pip.

Ruby

The client (requires Ruby 1.9) is available in RubyGems.

$ sudo gem install jubatus

Java

The client is available in our Maven repository. Please add these lines to pom.xml of your project.

<repositories>
  <repository>
    <id>jubat.us</id>
    <name>Jubatus Repository for Maven</name>
    <url>http://download.jubat.us/maven</url>
  </repository>
</repositories>

<dependencies>
  <dependency>
    <groupId>us.jubat</groupId>
    <artifactId>jubatus</artifactId>
    <version>0.4.2</version>
  </dependency>
</dependencies>

Try Tutorial

Try the Tutorial (requires Python client).

Write Your Application

Congratulations! Now you can write your own application using Jubatus. See the Client API for what Jubatus can do.

For C++ and Java users, skeleton projects are available:

• C++ Client Development Skelton
• Java Client Development Skelton (Eclipse project template)
• For Python users, see the tutorial repository.

In the jubatus-example repository, you can see applications using Jubatus.