mirror of
https://github.com/simon987/Simple-Incremental-Search-Tool.git
synced 2025-04-19 02:06:45 +00:00
56 lines
1.8 KiB
Markdown
56 lines
1.8 KiB
Markdown
# Simple incremental search tool
|
|
|
|
Work in progress! Shouldn't be used in production environnments.
|
|
|
|
### 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. To parse video and audio files, `ffmpeg` needs to be installed
|
|
Once the web server is running, you can connect to the search interface by typing `localhost:8080` in your browser.
|
|
|
|
## Setup on Windows
|
|
```bash
|
|
git clone https://github.com/simon987/Simple-Incremental-Search-Tool
|
|
cd Simple-Incremental-Search-Tool
|
|
```
|
|
[Download latest elasticsearch version](https://www.elastic.co/downloads/elasticsearch) and extract to `Simple-Incremental-Search-Tool\elasticsearch`
|
|
|
|
```bash
|
|
sudo pip3 install -r requirements.txt
|
|
|
|
python3 run.py
|
|
```
|
|
|
|
## Setup on Mac/linux
|
|
```bash
|
|
git clone https://github.com/simon987/Simple-Incremental-Search-Tool
|
|
cd Simple-Incremental-Search-Tool
|
|
wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-6.2.4.zip
|
|
unzip elasticsearch-6.2.4.zip
|
|
rm elasticsearch-6.2.4.zip
|
|
mv elasticsearch-6.2.4 elasticsearch
|
|
|
|
sudo pip3 install -r requirements.txt
|
|
|
|
python3 run.py
|
|
```
|
|
|
|
## Running unit tests
|
|
```bash
|
|
python3 -m unittest
|
|
```
|