squirrel/README.md

Squirrel

Find your nuts

Squirrel is a web interface to the excellent Recoll file search engine. It provides a modern search engine interface for a headless first experience.

Building from source

poetry install
poetry build
pip install dist/squirrel-0.3.x-py3-none-any.whl

Running

docker run -v /srv/archive:/mnt/docs:ro -p 8000:8000 squirrel

Development

# Build the package and image
poetry build
docker build . -t squirrel

# Mount the source and start in watching mode
docker run -v ./data:/var/recoll -v /srv/archive:/mnt/docs:ro -v .:/app:ro -e 8000:8000 --entrypoint bash squirrel
$ /opt/squirrel/bin/python3 -m squirrel.server