mirror of
https://github.com/simon987/sist2.git
synced 2025-04-19 10:16:42 +00:00
95 lines
2.5 KiB
Markdown
95 lines
2.5 KiB
Markdown
|
||
[](https://www.codefactor.io/repository/github/simon987/sist2)
|
||
|
||
# sist2
|
||
|
||
sist2 (Simple incremental search tool)
|
||
|
||
*Warning: sist2 is in early development*
|
||
|
||
## Features
|
||
|
||
* Fast, low memory usage
|
||
* Portable (all its features are packaged in a single executable)
|
||
* Extracts text from common file types\*
|
||
* Generates thumbnails\*
|
||
* Incremental scanning
|
||
|
||
|
||
\* See [format support](#format-support)
|
||
|
||
## Getting Started
|
||
|
||
1. Have an [Elasticsearch](https://www.elastic.co/downloads/elasticsearch) instance running
|
||
1. Download the [latest sist2 release](https://github.com/simon987/sist2/releases)
|
||
|
||
*Windows users*: `sist2` runs under [WSL](https://en.wikipedia.org/wiki/Windows_Subsystem_for_Linux)
|
||
|
||
*Mac users*: See [#1](https://github.com/simon987/sist2/issues/1)
|
||
|
||
|
||
## Example usage
|
||
|
||
|
||
|
||
See help page `sist2 --help` for more details.
|
||
|
||
**Scan a directory**
|
||
```bash
|
||
sist2 scan ~/Documents -o ./orig_idx/
|
||
sist2 scan --threads 4 --content-size 16384 /mnt/Pictures
|
||
sist2 scan --incremental ./orig_idx/ -o ./updated_idx/ ~/Documents
|
||
```
|
||
|
||
**Push index to Elasticsearch or file**
|
||
```bash
|
||
sist2 index --force-reset ./my_idx
|
||
sist2 index --print ./my_idx > raw_documents.ndjson
|
||
```
|
||
|
||
**Start web interface**
|
||
```bash
|
||
sist2 web --bind 0.0.0.0 --port 4321 ./my_idx1 ./my_idx2 ./my_idx3
|
||
```
|
||
|
||
## Format support
|
||
|
||
File type | Library | Content | Thumbnail | Metadata
|
||
:---|:---|:---|:---|:---
|
||
pdf,xps,cbz,cbr,fb2,epub | MuPDF | yes | yes, `png` | title |
|
||
`audio/*` | libav | - | yes, `jpeg` | ID3 tags |
|
||
`video/*` | libav | - | yes, `jpeg` | *planned* |
|
||
`image/*` | libav | - | yes, `jpeg` | *planned* |
|
||
ttf,ttc,cff,woff,fnt,otf | Freetype2 | - | yes, `bmp` | Name & style |
|
||
`text/plain` | *(none)* | yes | no | - |
|
||
docx, xlsx, pptx | | *planned* | no | *planned* |
|
||
|
||
|
||
|
||
|
||
## Build from source
|
||
|
||
You can compile **sist2** by yourself if you don't want to use the pre-compiled
|
||
binaries.
|
||
|
||
1. Install compile-time dependencies
|
||
|
||
*(Debian)*
|
||
```bash
|
||
apt install git cmake pkg-config libglib2.0-dev\
|
||
libssl-dev uuid-dev libavformat-dev libswscale-dev \
|
||
python3 libmagic-dev libfreetype6-dev libcurl-dev \
|
||
libbz2-dev yasm
|
||
```
|
||
*(FreeBSD)*
|
||
```bash
|
||
pkg install cmake gcc yasm gmake bash ffmpeg e2fsprogs-uuid
|
||
```
|
||
|
||
2. Build
|
||
```bash
|
||
git clone --recurse-submodules https://github.com/simon987/sist2
|
||
./scripts/get_static_libs.sh
|
||
cmake .
|
||
make
|
||
``` |