kar | kahuna ambiguity resolver | a levenshtein distance search server
C++ Other
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
client
dist
src
LICENSE.md
Makefile
README.md
github.png

README.md

kar | kahuna ambiguity resolver

kahuna

kar is a search server that is operated over http. It is designed for websites and applications which need a fast and simple to set up string search ability. Written in C++ it is quite fast, and can be used for queries on hundreds of thousands of items. Internally words are stored in a trie which when queried are scored according to Levenshtein distance.

Building

Dependencies

  • C++11 Compiler
  • make
  • libcppnetlib
  • libboost_thread
  • libboost_system
  • libssl
  • libcrypto

On Ubuntu you can install these requirements like this:

sudo apt-get install g++ build-essential libcppnetlib-dev libboost-thread-dev libboost-system-dev libssl-dev libcrypto++-dev

To build just run make in root directory.

Client Requirements

A small example "client" is included. To use you must have PHP 5.3+ and composer.

Note: you may need to install / enable PHP's cURL extension.

Change into client directory: cd client then run composer install to install client dependencies.

Then cd src and php example.php - make sure the server is already running (and same port etc).

Read through this file to understand how to write your own client.

Running

Configuration

Open dist/config.json

Host is the ip address this should bind to, likewise port should also be self-explanatory.

You may set the number of threads for the threadpool, usually it is smart to put this to however many cores you have if you know in advance. If you don't know in advance and want kar to attempt to set the pool size to what it thinks you have, set this to 0.

Set a password

I suggest you choose a random string.

Enumerate the database names you will be using. You can have as many as you want.

Actually Running

cd dist ./kar -c "config.json"

License

MIT