Skip to content

teverett/kSearch

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 

CI Codacy Badge

kSearch

A simple local search engine built on ElasticSearch. kSearch includes a threaded file system indexer which recursively reads files and indexes them into Elastic. There is also an automatic updater which deletes files from Elastic which have been deleted from the filesystem. The automatic updater also reindexes files which have changed on the file system since they were last indexed into Elastic.

License

kSearch is under the GPLv3

Supported file types

  • Text files including txt,java,c,cpp,sh,pdf,js,json,css,xml,yaml,yml,log,eml,msg,md,htm,html,doc,docx
  • pdf
  • doxc
  • docx

Configuring

The configuration for kSearch is via a properties file ksearch.properties. The relevant properties are documented in the file.

Building

To build kSearch you will need:

To build kSearch

mvn clean package

Running

To run kSearch, simply run run.sh which will run the binary jar and use ksearch.properties as the configuration file.

Screen shots

Search Screen

Search Results

About

A personal search engine based on Elastic Search

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published