Demo: sist2.shyy.io

Community URL: Discord

sist2

sist2 (Simple incremental search tool)

Warning: sist2 is in early development

Features

• Fast, low memory usage, multi-threaded
• Manage & schedule scan jobs with simple web interface (Docker only)
• Mobile-friendly Web interface
• 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

Getting Started

Using Docker Compose (Windows/Linux/Mac)

services:
  elasticsearch:
    image: elasticsearch:7.17.9
    restart: unless-stopped
    volumes:
      # This directory must have 1000:1000 permissions
      - /data/sist2-es-data/:/usr/share/elasticsearch/data
    environment:
      - "discovery.type=single-node"
      - "ES_JAVA_OPTS=-Xms2g -Xmx2g"
  sist2-admin:
    image: sist2app/sist2:latest
    restart: unless-stopped
    volumes:
      - /data/sist2-admin-data/:/sist2-admin/
      - /<path to index>/:/host
    ports:
      - 4090:4090
      # NOTE: Don't expose this port publicly!
      - 8080:8080
    entrypoint: node
    command:
      - /root/sist2-admin/server/main.js

Navigate to http://localhost:8080/ to configure sist2-admin.

Using the executable file (Linux, Windows)

1. Choose search backend (See comparison):

   • Elasticsearch: have an Elasticsearch (version >= 6.8.X, ideally >=7.14.0) instance running
     1. Download from official website
     2. (or) Run using docker:

        docker run -d -p 9200:9200 -e "discovery.type=single-node" elasticsearch:7.17.9
        

   • SQLite: No installation required

2. Download the latest sist2 release. Select the file corresponding to your platform. On Linux, mark the binary as executable with chmod +x; on Windows, run sist2-x64-windows.exe from a terminal.

3. See usage guide for command line usage.

Example usage:

1. Scan a directory: sist2 scan ~/Documents --output ./documents.sist2
2. Prepare search index:
   • Elasticsearch: sist2 index --es-url http://localhost:9200 ./documents.sist2
   • SQLite: sist2 sqlite-index --search-index ./search.sist2 ./documents.sist2
3. Start web interface:
   • Elasticsearch: sist2 web ./documents.sist2
   • SQLite: sist2 web --search-index ./search.sist2 ./documents.sist2

Format support

* 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 ebook (pdf,xps,fb2,epub) or image file types with the --ocr-lang <lang> option in combination with --ocr-images and/or --ocr-ebooks. Download the language data files with your package manager (apt install tesseract-ocr-eng) or directly from Github.

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

You can use the + separator to specify multiple languages. The language name must be identical to the *.traineddata file installed on your system (use chi_sim rather than chi-sim).

Examples:

sist2 scan --ocr-ebooks --ocr-lang jpn ~/Books/Manga/
sist2 scan --ocr-images --ocr-lang eng ~/Images/Screenshots/
sist2 scan --ocr-ebooks --ocr-images --ocr-lang eng+chi_sim ~/Chinese-Bilingual/

Search backends

sist2 v3.0.7+ supports SQLite search backend. The SQLite search backend has fewer features and generally comparable query performance for medium-size indices, but it uses much less memory and is easier to set up.

Build from source

You can compile sist2 by yourself if you don't want to use the pre-compiled binaries

Using docker

git clone https://github.com/sist2app/sist2/
cd sist2
# Static binary for the current architecture
scripts/make_static.sh
# ...or the Windows binary, cross-compiled with mingw-w64 (run this on linux, not Windows)
scripts/make_windows.sh
# ...or the full runtime image
docker buildx build . -t my-sist2-image

Using a linux computer

1. Install compile-time dependencies

   apt install gcc g++ python3 yasm ragel automake autotools-dev wget libtool libssl-dev curl zip unzip tar xorg-dev libglu1-mesa-dev libxcursor-dev libxml2-dev libxinerama-dev gettext nasm git nodejs
   

2. Install vcpkg

3. Build (the frontends must be built before the C binary: their dist/ output is embedded into the executable)

   git clone https://github.com/sist2app/sist2/
   cd sist2
   (cd sist2-vue; npm install; npm run build)
   (cd sist2-admin; npm install; npm run build)
   cmake -B build -DSIST_DEBUG=off -DCMAKE_TOOLCHAIN_FILE=<VCPKG_ROOT>/scripts/buildsystems/vcpkg.cmake
   cmake --build build -j $(nproc)