Skip to content


Subversion checkout URL

You can clone with
Download ZIP
Tree: 004ad2c0de
Fetching contributors…

Cannot retrieve contributors at this time

176 lines (115 sloc) 5.58 KB
<!DOCTYPE html>
<meta charset='utf-8' />
<meta http-equiv="X-UA-Compatible" content="chrome=1" />
<meta name="description" content="Indextank-engine : Indexing engine for IndexTank" />
<link rel="stylesheet" type="text/css" media="screen" href="stylesheets/stylesheet.css">
<!-- HEADER -->
<div id="header_wrap" class="outer">
<header class="inner">
<a id="forkme_banner" href="">Fork Me on GitHub</a>
<h1 id="project_title">Indextank-engine</h1>
<h2 id="project_tagline">Indexing engine for IndexTank</h2>
<section id="downloads">
<a class="zip_download_link" href="">Download this project as a .zip file</a>
<a class="tar_download_link" href="">Download this project as a tar.gz file</a>
<div id="main_content_wrap" class="outer">
<section id="main_content" class="inner">
<h1>About IndexTank Engine</h1>
<p>This project contains IndexTank (<a href=""></a>) search engine implementation.
Includes features like variables (boosts), categories (facets), faceted search, snippeting, custom scoring functions, suggest, and autocomplete.</p>
<p>For IndexTank's full administrative stack (which makes use of this engine) see <a href=""></a></p>
<p>Find out more about at: TBD</p>
<p>Apache Public License (APL) 2.0</p>
<li>indextank-engine-1.0.0.jar &lt;-- core library</li>
<p>groupId: com.flaptor.indextank</p>
<p>artifactId: indextank-engine</p>
<p>version: 1.0.0</p>
<h2>Package generation:</h2>
<p>Build a single jar containing all dependencies by:</p>
<pre><code>$ mvn compile package assembly:single
<p>This will create a single file in:</p>
<h2>Quick start with the standalone REST API</h2>
<p>You can try basic indexing and searching</p>
<p>Main class: com.flaptor.indextank.api.Launcher</p>
<p>After running the package generation:</p>
<pre><code>$ java -cp target/indextank-engine-1.0.0-jar-with-dependencies.jar com.flaptor.indextank.api.Launcher
<p>This command starts an API server (<a href=""></a>) at port 20220.
The indexing and searching can be done with any client or for example, via curl:</p>
<pre><code>$ curl -d "{\"docid\":\"post1\", \"fields\":{\"text\":\"I love Fallout\"}}" -v -X PUT http://localhost:20220/v1/indexes/idx/docs
$ curl -d "{\"docid\":\"post2\", \"fields\":{\"text\":\"I love Planescape\"}}" -v -X PUT http://localhost:20220/v1/indexes/idx/docs
$ curl http://localhost:20220/v1/indexes/idx/search?q=love
<h2>API Clients (compatible with the embedded API)</h2>
<p>Java: <a href=""></a></p>
<p>Python: <a href=""></a></p>
<p>Ruby: <a href=""></a></p>
<p>PHP: <a href=""></a></p>
<h2>Thrift API sample configuration:</h2>
<p>Main class: com.flaptor.indextank.index.IndexEngine</p>
<p>VM args:</p>
<pre><code>-XX:+UseConcMarkSweepGC -XX:+UseParNewGC -Xmx600M
<p>Program args:</p>
<pre><code>--facets --rti-size 500 --conf-file sample-engine-config --port 20220 --environment-prefix TEST --recover --dir index --snippets --suggest documents --boosts 3 --index-code dgmqn --functions 0:-age
<p>Sample engine configuration file contents:</p>
"max_variables": 3,
"functions": {"0": "-age"},
"index_code": "dgmqn",
"allows_facets": true,
"ram": 600,
"log_server_host": "index123.localhost",
"autocomplete": true,
"log_server_port": 15100,
"autocomplete_type": "documents",
"allows_snippets": true,
"rti_size": 500,
"facets_bits": 5,
"base_port": 20220,
"log_based_storage": false,
"xmx": 600
<p>Execute the following command to run:</p>
<pre><code>mvn test
<p>Avoid running tests by adding:</p>
<pre><code>mvn -Dmaven.test.skip=true compile
<p>Set up Eclipse for this project by executing the command below:</p>
<pre><code>mvn eclipse:eclipse
<p>Inside Eclipse, select Preferences &gt; Java &gt; Build Path &gt; Classpath Variables. Define a new classpath variable M2_REPO and assign maven repository.</p>
<p>For more information, check out <a href=""></a></p>
<!-- FOOTER -->
<div id="footer_wrap" class="outer">
<footer class="inner">
<p class="copyright">Indextank-engine maintained by <a href="">linkedin</a></p>
<p>Published with <a href="">GitHub Pages</a></p>
Jump to Line
Something went wrong with that request. Please try again.