Skip to content

Latest commit

 

History

History
103 lines (83 loc) · 3.09 KB

README.md

File metadata and controls

103 lines (83 loc) · 3.09 KB
Raw

completionProxy

Proxy implementing an interface to the suggestion index (elastic search) and the analytics backend.

Dependencies

Thrift

To make this code compilable you have to generate the thrift files. To install the thrift compiler please see the following links:

Debian Wheezy/Ubuntu

sudo apt-get install git build-essential cmake pkg-config libboost-dev libboost-test-dev \
libboost-program-options-dev libevent-dev automake libtool flex bison pkg-config \
libssl-dev libsoup2.4-dev libboost-system-dev libboost-filesystem-dev \
libogg-dev libtheora-dev libasound2-dev libvorbis-dev libpango1.0-dev \
libvisual-0.4-dev libffi-dev libgmp-dev

git clone https://git-wip-us.apache.org/repos/asf/thrift.git thrift
cd thrift/
git checkout 0.9.1 -b build
./bootstrap.sh
./configure
make -j
sudo make install

Archlinux

wget https://aur.archlinux.org/packages/th/thrift/thrift.tar.gz
tar -xvzf thrift.tar.gz
cd thrift
makepkg -s
sudo pacman -U thrift*.tar.xz

Mac OSX

Using homebrew

brew install thrift

Elasticsearch

The backend databse used is elastic search (For the version please see elasticsearch.version here).

The installation is as simple as following:

esVersion=1.3.1
wget https://download.elasticsearch.org/elasticsearch/elasticsearch/elasticsearch-${esVersion}.tar.gz
tar -xvzf elasticsearch-${esVersion}.tar.gz
cd elasticsearch-${esVersion}

cp $pathToCompletionProxy/config/* config/

To run elasticsearch just execute the script file in bin:

bin/elasticsearch

Mac OSX

Using homebrew

brew install elasticsearch
cp $pathToCompletionProxy/config/* /usr/local/Cellar/elasticsearch/config/

Head plugin

A relative simple plugin vor ES to view the stored data is elasticsearch-head:

bin/plugin -install mobz/elasticsearch-head

This activate following fiew: http://localhost:9200/_plugin/head/

Installation and running

git clone [email protected]:Completionary/completionProxy.git
cd completionProxy/thrift
make all lang=java
cd ..
sudo mkdir /etc/completionary
sudo cp proxyOptions.cfg /etc/completionary

mvn compile
mvn exec:java -Dexec.mainClass="de.completionary.proxy.CompletionProxy"

Thrift API

If you want to communicate with our thrift API, you can execute make all lang=$language to generate all files you need for your prefered programming language $language (e.g. js:node, erlang, php, py...). This will generate a directory called gen-$language with all the API files in your language. Please see the following link for mor information on thrift: https://thrift.apache.org/tutorial/

Java

Here you can find a simple example of how to connect to the admin service:

TTransport transport =
    new TFramedTransport(new TSocket("localhost", ProxyOptions.ADMIN_SERVER_PORT));
TProtocol protocol = new TBinaryProtocol(transport);

client = new AdminService.Client(protocol);
transport.open();

client.addSingleTerm(index, ID, inputString, outputString, payload, wight);