Permalink
Browse files

Created gh-pages branch via GitHub

  • Loading branch information...
0 parents commit 004ad2c0de53566185c2af84c6fdda01a433a293 @iladriano iladriano committed Apr 2, 2012
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
@@ -0,0 +1,175 @@
+<!DOCTYPE html>
+<html>
+
+ <head>
+ <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">
+
+ <title>Indextank-engine</title>
+ </head>
+
+ <body>
+
+ <!-- HEADER -->
+ <div id="header_wrap" class="outer">
+ <header class="inner">
+ <a id="forkme_banner" href="https://github.com/linkedin/indextank-engine">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="https://github.com/linkedin/indextank-engine/zipball/master">Download this project as a .zip file</a>
+ <a class="tar_download_link" href="https://github.com/linkedin/indextank-engine/tarball/master">Download this project as a tar.gz file</a>
+ </section>
+ </header>
+ </div>
+
+ <!-- MAIN CONTENT -->
+ <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="http://indextank.com">http://indextank.com</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="http://github.com/linkedin/indextank-service">http://github.com/linkedin/indextank-service</a></p>
+
+<h3>Homepage:</h3>
+
+<p>Find out more about at: TBD</p>
+
+<h3>License:</h3>
+
+<p>Apache Public License (APL) 2.0</p>
+
+<h3>Artifacts:</h3>
+
+<ol>
+<li>indextank-engine-1.0.0.jar &lt;-- core library</li>
+</ol><h3>Maven:</h3>
+
+<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
+</code></pre>
+
+<p>This will create a single file in:</p>
+
+<pre><code>target/indextank-engine-1.0.0-jar-with-dependencies.jar
+</code></pre>
+
+<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
+</code></pre>
+
+<p>This command starts an API server (<a href="http://www.indextank.com/documentation/api">http://www.indextank.com/documentation/api</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
+</code></pre>
+
+<h2>API Clients (compatible with the embedded API)</h2>
+
+<p>Java: <a href="https://github.com/flaptor/indextank-java">https://github.com/flaptor/indextank-java</a></p>
+
+<p>Python: <a href="https://github.com/flaptor/indextank-py">https://github.com/flaptor/indextank-py</a></p>
+
+<p>Ruby: <a href="https://github.com/flaptor/indextank-rb">https://github.com/flaptor/indextank-rb</a></p>
+
+<p>PHP: <a href="https://github.com/flaptor/indextank-php">https://github.com/flaptor/indextank-php</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 -Dorg.apache.lucene.FSDirectory.class=org.apache.lucene.store.MMapDirectory -Xmx600M
+</code></pre>
+
+<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
+</code></pre>
+
+<p>Sample engine configuration file contents:</p>
+
+<pre><code>{
+"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
+}
+</code></pre>
+
+<h2>Tests:</h2>
+
+<p>Execute the following command to run:</p>
+
+<pre><code>mvn test
+</code></pre>
+
+<p>Avoid running tests by adding:</p>
+
+<pre><code>mvn -Dmaven.test.skip=true compile
+</code></pre>
+
+<h2>Eclipse:</h2>
+
+<p>Set up Eclipse for this project by executing the command below:</p>
+
+<pre><code>mvn eclipse:eclipse
+</code></pre>
+
+<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="http://maven.apache.org/guides/mini/guide-ide-eclipse.html">http://maven.apache.org/guides/mini/guide-ide-eclipse.html</a></p>
+ </section>
+ </div>
+
+ <!-- FOOTER -->
+ <div id="footer_wrap" class="outer">
+ <footer class="inner">
+ <p class="copyright">Indextank-engine maintained by <a href="https://github.com/linkedin">linkedin</a></p>
+ <p>Published with <a href="http://pages.github.com">GitHub Pages</a></p>
+ </footer>
+ </div>
+
+
+
+ </body>
+</html>
@@ -0,0 +1 @@
+console.log('This would be the main JS file.');
@@ -0,0 +1 @@
+{"name":"Indextank-engine","body":"About IndexTank Engine\r\n======================\r\n\r\nThis project contains IndexTank (http://indextank.com) search engine implementation.\r\nIncludes features like variables (boosts), categories (facets), faceted search, snippeting, custom scoring functions, suggest, and autocomplete.\r\n\r\nFor IndexTank's full administrative stack (which makes use of this engine) see http://github.com/linkedin/indextank-service\r\n\r\n### Homepage:\r\n\r\nFind out more about at: TBD\r\n\r\n### License:\r\n\r\nApache Public License (APL) 2.0\r\n\r\n### Artifacts:\r\n\r\n1. indextank-engine-1.0.0.jar <-- core library\r\n\r\n### Maven:\r\n\r\ngroupId: com.flaptor.indextank\r\n\r\nartifactId: indextank-engine\r\n\r\nversion: 1.0.0\r\n\r\nPackage generation:\r\n-------------------\r\n\r\nBuild a single jar containing all dependencies by:\r\n\r\n $ mvn compile package assembly:single\r\n\r\nThis will create a single file in:\r\n\r\n target/indextank-engine-1.0.0-jar-with-dependencies.jar\r\n\r\nQuick start with the standalone REST API\r\n----------------------------------------\r\n\r\nYou can try basic indexing and searching\r\n\r\nMain class: com.flaptor.indextank.api.Launcher\r\n\r\nAfter running the package generation:\r\n\r\n $ java -cp target/indextank-engine-1.0.0-jar-with-dependencies.jar com.flaptor.indextank.api.Launcher\r\n\r\nThis command starts an API server (http://www.indextank.com/documentation/api) at port 20220.\r\nThe indexing and searching can be done with any client or for example, via curl:\r\n\r\n $ curl -d \"{\\\"docid\\\":\\\"post1\\\", \\\"fields\\\":{\\\"text\\\":\\\"I love Fallout\\\"}}\" -v -X PUT http://localhost:20220/v1/indexes/idx/docs\r\n\r\n $ curl -d \"{\\\"docid\\\":\\\"post2\\\", \\\"fields\\\":{\\\"text\\\":\\\"I love Planescape\\\"}}\" -v -X PUT http://localhost:20220/v1/indexes/idx/docs\r\n\r\n $ curl http://localhost:20220/v1/indexes/idx/search?q=love\r\n\r\nAPI Clients (compatible with the embedded API)\r\n----------------------------------------------\r\n\r\nJava: https://github.com/flaptor/indextank-java\r\n\r\nPython: https://github.com/flaptor/indextank-py\r\n\r\nRuby: https://github.com/flaptor/indextank-rb\r\n\r\nPHP: https://github.com/flaptor/indextank-php\r\n\r\nThrift API sample configuration:\r\n--------------------------------\r\n\r\nMain class: com.flaptor.indextank.index.IndexEngine\r\n\r\nVM args:\r\n\r\n -XX:+UseConcMarkSweepGC -XX:+UseParNewGC -Dorg.apache.lucene.FSDirectory.class=org.apache.lucene.store.MMapDirectory -Xmx600M\r\n\r\nProgram args:\r\n\r\n --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\r\n\r\nSample engine configuration file contents:\r\n\r\n {\r\n \"max_variables\": 3, \r\n \"functions\": {\"0\": \"-age\"}, \r\n \"index_code\": \"dgmqn\", \r\n \"allows_facets\": true, \r\n \"ram\": 600, \r\n \"log_server_host\": \"index123.localhost\", \r\n \"autocomplete\": true,\r\n \"log_server_port\": 15100, \r\n \"autocomplete_type\": \"documents\",\r\n \"allows_snippets\": true, \r\n \"rti_size\": 500, \r\n \"facets_bits\": 5, \r\n \"base_port\": 20220, \r\n \"log_based_storage\": false, \r\n \"xmx\": 600\r\n }\r\n\r\nTests:\r\n------\r\n\r\nExecute the following command to run:\r\n\r\n mvn test\r\n\r\nAvoid running tests by adding:\r\n\r\n mvn -Dmaven.test.skip=true compile\r\n\r\nEclipse:\r\n--------\r\n\r\nSet up Eclipse for this project by executing the command below:\r\n\r\n mvn eclipse:eclipse\r\n\r\nInside Eclipse, select Preferences > Java > Build Path > Classpath Variables. Define a new classpath variable M2_REPO and assign maven repository.\r\n\r\nFor more information, check out http://maven.apache.org/guides/mini/guide-ide-eclipse.html\r\n","tagline":"Indexing engine for IndexTank","google":"","note":"Don't delete this file! It's used internally to help with page regeneration."}
@@ -0,0 +1,70 @@
+.highlight .hll { background-color: #ffffcc }
+.highlight { background: #f0f3f3; }
+.highlight .c { color: #0099FF; font-style: italic } /* Comment */
+.highlight .err { color: #AA0000; background-color: #FFAAAA } /* Error */
+.highlight .k { color: #006699; font-weight: bold } /* Keyword */
+.highlight .o { color: #555555 } /* Operator */
+.highlight .cm { color: #0099FF; font-style: italic } /* Comment.Multiline */
+.highlight .cp { color: #009999 } /* Comment.Preproc */
+.highlight .c1 { color: #0099FF; font-style: italic } /* Comment.Single */
+.highlight .cs { color: #0099FF; font-weight: bold; font-style: italic } /* Comment.Special */
+.highlight .gd { background-color: #FFCCCC; border: 1px solid #CC0000 } /* Generic.Deleted */
+.highlight .ge { font-style: italic } /* Generic.Emph */
+.highlight .gr { color: #FF0000 } /* Generic.Error */
+.highlight .gh { color: #003300; font-weight: bold } /* Generic.Heading */
+.highlight .gi { background-color: #CCFFCC; border: 1px solid #00CC00 } /* Generic.Inserted */
+.highlight .go { color: #AAAAAA } /* Generic.Output */
+.highlight .gp { color: #000099; font-weight: bold } /* Generic.Prompt */
+.highlight .gs { font-weight: bold } /* Generic.Strong */
+.highlight .gu { color: #003300; font-weight: bold } /* Generic.Subheading */
+.highlight .gt { color: #99CC66 } /* Generic.Traceback */
+.highlight .kc { color: #006699; font-weight: bold } /* Keyword.Constant */
+.highlight .kd { color: #006699; font-weight: bold } /* Keyword.Declaration */
+.highlight .kn { color: #006699; font-weight: bold } /* Keyword.Namespace */
+.highlight .kp { color: #006699 } /* Keyword.Pseudo */
+.highlight .kr { color: #006699; font-weight: bold } /* Keyword.Reserved */
+.highlight .kt { color: #007788; font-weight: bold } /* Keyword.Type */
+.highlight .m { color: #FF6600 } /* Literal.Number */
+.highlight .s { color: #CC3300 } /* Literal.String */
+.highlight .na { color: #330099 } /* Name.Attribute */
+.highlight .nb { color: #336666 } /* Name.Builtin */
+.highlight .nc { color: #00AA88; font-weight: bold } /* Name.Class */
+.highlight .no { color: #336600 } /* Name.Constant */
+.highlight .nd { color: #9999FF } /* Name.Decorator */
+.highlight .ni { color: #999999; font-weight: bold } /* Name.Entity */
+.highlight .ne { color: #CC0000; font-weight: bold } /* Name.Exception */
+.highlight .nf { color: #CC00FF } /* Name.Function */
+.highlight .nl { color: #9999FF } /* Name.Label */
+.highlight .nn { color: #00CCFF; font-weight: bold } /* Name.Namespace */
+.highlight .nt { color: #330099; font-weight: bold } /* Name.Tag */
+.highlight .nv { color: #003333 } /* Name.Variable */
+.highlight .ow { color: #000000; font-weight: bold } /* Operator.Word */
+.highlight .w { color: #bbbbbb } /* Text.Whitespace */
+.highlight .mf { color: #FF6600 } /* Literal.Number.Float */
+.highlight .mh { color: #FF6600 } /* Literal.Number.Hex */
+.highlight .mi { color: #FF6600 } /* Literal.Number.Integer */
+.highlight .mo { color: #FF6600 } /* Literal.Number.Oct */
+.highlight .sb { color: #CC3300 } /* Literal.String.Backtick */
+.highlight .sc { color: #CC3300 } /* Literal.String.Char */
+.highlight .sd { color: #CC3300; font-style: italic } /* Literal.String.Doc */
+.highlight .s2 { color: #CC3300 } /* Literal.String.Double */
+.highlight .se { color: #CC3300; font-weight: bold } /* Literal.String.Escape */
+.highlight .sh { color: #CC3300 } /* Literal.String.Heredoc */
+.highlight .si { color: #AA0000 } /* Literal.String.Interpol */
+.highlight .sx { color: #CC3300 } /* Literal.String.Other */
+.highlight .sr { color: #33AAAA } /* Literal.String.Regex */
+.highlight .s1 { color: #CC3300 } /* Literal.String.Single */
+.highlight .ss { color: #FFCC33 } /* Literal.String.Symbol */
+.highlight .bp { color: #336666 } /* Name.Builtin.Pseudo */
+.highlight .vc { color: #003333 } /* Name.Variable.Class */
+.highlight .vg { color: #003333 } /* Name.Variable.Global */
+.highlight .vi { color: #003333 } /* Name.Variable.Instance */
+.highlight .il { color: #FF6600 } /* Literal.Number.Integer.Long */
+
+.type-csharp .highlight .k { color: #0000FF }
+.type-csharp .highlight .kt { color: #0000FF }
+.type-csharp .highlight .nf { color: #000000; font-weight: normal }
+.type-csharp .highlight .nc { color: #2B91AF }
+.type-csharp .highlight .nn { color: #000000 }
+.type-csharp .highlight .s { color: #A31515 }
+.type-csharp .highlight .sc { color: #A31515 }
Oops, something went wrong.

0 comments on commit 004ad2c

Please sign in to comment.