what a *nice* Elasticsearch indexer...
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
simon987 95bbe39afc Update libmupdf 1 month ago
.github/ISSUE_TEMPLATE Update issue-template.md 2 months ago
.teamcity build settings 10 months ago
Docker Support for markup files 7 months ago
DockerArm64 Fix arm Dockerfile 2 months ago
ci arm64 build 2 months ago
docs Optionally ES schema from file #117 1 month ago
schema Fix #97 3 months ago
scripts sidecar files #114, version bump 1 month ago
src Optionally ES schema from file #117 1 month ago
third-party Update libmupdf 1 month ago
.gitattributes Initial commit (squashed) 1 year ago
.gitignore 2.0 (#46) 7 months ago
.gitmodules Revert "wip" 6 months ago
CMakeLists.txt sidecar files #114, version bump 1 month ago
LICENSE Initial commit (squashed) 1 year ago
README.md Update build instructions 2 months ago

README.md

GitHub CodeFactor Development snapshots

Demo: sist2.simon987.net

sist2

sist2 (Simple incremental search tool)

Warning: sist2 is in early development

sist2.png

Features

  • Fast, low memory usage, multi-threaded
  • Mobile-friendly Web interface
  • Portable (all its features are packaged in a single executable)
  • Extracts text and metadata from common file types *
  • Generates thumbnails *
  • Incremental scanning
  • Manual tagging from the UI and automatic tagging based on file attributes via user scripts
  • Recursive scan inside archive files **
  • OCR support with tesseract ***
  • Stats page & disk utilisation visualization

* See format support
** See Archive files
*** See OCR

stats

Getting Started

  1. Have an Elasticsearch (>= 6.X.X) instance running

    1. Download from official website
    2. (or) Run using docker:
      docker run -d --name es1 --net sist2_net -p 9200:9200 \
          -e "discovery.type=single-node" elasticsearch:7.5.2
      
    3. (or) Run using docker-compose:
        elasticsearch:
          image: docker.elastic.co/elasticsearch/elasticsearch:7.5.2
          environment:
            - discovery.type=single-node
            - "ES_JAVA_OPTS=-Xms1G -Xmx2G"
      
  2. Download sist2 executable

    1. Download the latest sist2 release *
    2. (or) Download a development snapshot (Not recommended!)
    3. (or) docker pull simon987/sist2:latest
  3. See Usage guide

* Windows users: sist2 runs under WSL

Example usage

See Usage guide for more details

  1. Scan a directory: sist2 scan ~/Documents -o ./docs_idx
  2. Push index to Elasticsearch: sist2 index ./docs_idx
  3. Start web interface: sist2 web ./docs_idx

Format support

File type Library  Content Thumbnail Metadata
pdf,xps,fb2,epub MuPDF text+ocr yes title
cbz,cbr (none) - yes -
audio/* ffmpeg - yes ID3 tags
video/* ffmpeg - yes title, comment, artist
image/* ffmpeg - yes Common EXIF tags
raw, rw2, dng, cr2, crw, dcr, k25, kdc, mrw, pef, xf3, arw, sr2, srf, erf LibRaw - yes Common EXIF tags
ttf,ttc,cff,woff,fnt,otf Freetype2 - yes, bmp Name & style
text/plain (none) yes no -
html, xml (none) yes no -
tar, zip, rar, 7z, ar ... Libarchive yes* - no
docx, xlsx, pptx (none) yes if embedded creator, modified_by, title
mobi, azw, azw3 libmobi yes no author, title

* See Archive files

Archive files

sist2 will scan files stored into archive files (zip, tar, 7z...) as if they were directly in the file system. Recursive (archives inside archives) scan is also supported.

Limitations:

  • Support for parsing media files with formats that require seek (e.g. .gif, .mp4 w/ fragmented metadata etc.) is limitted (see --mem-buffer option)
  • Archive files are scanned sequentially, by a single thread. On systems where sist2 is not I/O bound, scans might be faster when larger archives are split into smaller parts.

OCR

You can enable OCR support for pdf,xps,fb2,epub file types with the --ocr <lang> option. Download the language data files with your package manager (apt install tesseract-ocr-eng) or directly from Github.

The simon987/sist2 image comes with common languages (hin, jpn, eng, fra, rus, spa) pre-installed.

Examples

sist2 scan --ocr jpn ~/Books/Manga/
sist2 scan --ocr eng ~/Books/Textbooks/

Build from source

You can compile sist2 by yourself if you don't want to use the pre-compiled binaries (GCC 7+ required).

  1. Install compile-time dependencies

    vcpkg install lmdb cjson glib libarchive[core,bzip2,libxml2,lz4,lzma,lzo] pthread tesseract libxml2 ffmpeg zstd gtest mongoose libuuid libmagic libraw curl[core,ssl] jbig2dec brotli libmupdf
    
  2. Build

    git clone --recursive https://github.com/simon987/sist2/
    cmake -DCMAKE_TOOLCHAIN_FILE=<VCPKG_ROOT>/scripts/buildsystems/vcpkg.cmake .
    make