{"id":16842895,"url":"https://github.com/teverett/ksearch","last_synced_at":"2026-04-17T13:32:35.368Z","repository":{"id":38389727,"uuid":"264560341","full_name":"teverett/kSearch","owner":"teverett","description":"A personal search engine based on Elastic Search","archived":false,"fork":false,"pushed_at":"2023-08-01T00:53:31.000Z","size":583,"stargazers_count":2,"open_issues_count":7,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-10T21:36:24.375Z","etag":null,"topics":["elasticsearch","java","personal"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/teverett.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-05-17T01:23:51.000Z","updated_at":"2023-01-31T18:11:40.000Z","dependencies_parsed_at":"2024-12-18T16:42:05.108Z","dependency_job_id":"53711ddc-1335-45de-9d5d-8455055d541e","html_url":"https://github.com/teverett/kSearch","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/teverett%2FkSearch","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/teverett%2FkSearch/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/teverett%2FkSearch/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/teverett%2FkSearch/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/teverett","download_url":"https://codeload.github.com/teverett/kSearch/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247325647,"owners_count":20920713,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["elasticsearch","java","personal"],"created_at":"2024-10-13T12:48:55.643Z","updated_at":"2025-10-18T13:04:40.031Z","avatar_url":"https://github.com/teverett.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"![CI](https://github.com/teverett/kSearch/workflows/CI/badge.svg)\n[![Codacy Badge](https://app.codacy.com/project/badge/Grade/9c804e8f75d24a2785450511e57b222c)](https://www.codacy.com/manual/teverett/kSearch?utm_source=github.com\u0026amp;utm_medium=referral\u0026amp;utm_content=teverett/kSearch\u0026amp;utm_campaign=Badge_Grade)\n\n# kSearch\n\nA simple local search engine built on [ElasticSearch](https://www.elastic.co/).  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.\n\n## License\n\nkSearch is under the [GPLv3](https://www.gnu.org/licenses/gpl-3.0.html)\n\n## Supported file types\n\n*   Text files including txt,java,c,cpp,sh,pdf,js,json,css,xml,yaml,yml,log,eml,msg,md,htm,html,doc,docx\n*   pdf\n*   doxc\n*   docx\n\n## Configuring\n\nThe configuration for kSearch is via a properties file `ksearch.properties`.  The relevant properties are documented in the file.\n\n## Building\n\nTo build kSearch you will need:\n\n*   [Java8](https://adoptopenjdk.net/) or better\n*   [Maven 3.1.1](https://maven.apache.org/) or better\n*   A working install of [Elastic Search](http://https://www.elastic.co/).\n\nTo build kSearch\n\n\u003cpre\u003e\nmvn clean package\n\u003c/pre\u003e\n\n## Running\nTo run kSearch, simply run `run.sh` which will run the binary jar and use `ksearch.properties` as the configuration file.\n\n## Screen shots\n\n\u003cb\u003eSearch Screen\u003c/b\u003e\n\n\u003cimg src=\"https://github.com/teverett/kSearch/raw/master/screens/index.png\" width=\"800\" /\u003e\n\n\u003cb\u003eSearch Results\u003c/b\u003e\n\n\u003cimg src=\"https://github.com/teverett/kSearch/raw/master/screens/results.png\" width=\"800\" /\u003e\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fteverett%2Fksearch","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fteverett%2Fksearch","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fteverett%2Fksearch/lists"}