mirror of
https://github.com/simon987/Simple-Incremental-Search-Tool.git
synced 2025-04-10 14:06:41 +00:00
46 lines
1.8 KiB
Markdown
46 lines
1.8 KiB
Markdown
*NOTE: This project is no longer being maintained. See [sist2](https://github.com/simon987/sist2)*
|
|
|
|
[](https://www.codefactor.io/repository/github/simon987/simple-incremental-search-tool/overview/master)
|
|
|
|
# Simple incremental search tool
|
|
|
|
|
|
Portable search tool for local files using Elasticsearch.
|
|
|
|
### Features
|
|
* Incremental search (Search as you type)
|
|
* Extracts text from common file types (Mp3 tags, picture sizes, content of docx, pdf, xlsx files etc.)
|
|
* Portable installation
|
|
* Generate thumbnails for images and videos
|
|
* Once indexed, no access to the files is required to search (useful for cold storage)
|
|
* Consult videos/GIFs/Images/audio directly in the search result page
|
|
* Can be configured to take very low disk space or to store maximum metadata/content
|
|
|
|
# Screenshots
|
|
### Search page
|
|
|
|
### Search results
|
|
|
|
|
|
|
|
# Installation
|
|
Java and python3 are required.
|
|
Once the web server is running, you can connect to the search interface by typing `localhost:8080` in your browser.
|
|
|
|
## Setup on Windows/Mac/linux (Python 3.5+)
|
|
|
|
* Download and install [Elasticsearch](https://www.elastic.co/downloads/elasticsearch)
|
|
|
|
* Edit settings in [config.py](https://github.com/simon987/Simple-Incremental-Search-Tool/blob/master/config.py) (Default values are ok in most cases)
|
|
```bash
|
|
git clone https://github.com/simon987/Simple-Incremental-Search-Tool
|
|
|
|
sudo pip3 install -r requirements.txt
|
|
python3 run.py
|
|
```
|
|
|
|
## Running unit tests
|
|
```bash
|
|
python3 -m unittest
|
|
```
|