opensearch-fscrawler 0.5.3

File system crawler for OpenSearch / Elasticsearch — Python rewrite of FSCrawler

FSCrawler — Python Edition

Disclaimer: This is a prototype intended for local development and experimentation only. It is not production-ready and should not be used in production environments.

A Python 3.12 rewrite of FSCrawler, a file system crawler that indexes binary documents (PDF, MS Office, plain text, and more) into OpenSearch or Elasticsearch.

Migrating from the Java version? fs.filename_as_id defaults to true here but false in Java. If you are pointing this at an existing index, set fs.filename_as_id: false in your _settings.yaml explicitly — otherwise documents will be re-indexed under new IDs and you will end up with duplicates.

Features

• Backwards-compatible _settings.yaml format — drop-in replacement for the Java version
• Event-driven crawling — watches the filesystem for changes in real time using OS-native events; no polling required
• Apache Tika integration — connects to a running Tika server over HTTP (no bundled JVM)
• Bulk indexing — buffers documents and flushes on document count or byte-size thresholds
• Template management — creates OpenSearch component and index templates automatically
• Multi-arch Docker image — Dockerfile supports linux/amd64 and linux/arm64 (make build)

Docker image

Pre-built multi-arch images (linux/amd64, linux/arm64) are published to GitHub Container Registry on every release:

ghcr.io/p6rguvyrst/opensearch-fscrawler:latest
ghcr.io/p6rguvyrst/opensearch-fscrawler:1.2.3   # pin to a specific version
ghcr.io/p6rguvyrst/opensearch-fscrawler:1.2     # major.minor

docker pull ghcr.io/p6rguvyrst/opensearch-fscrawler:latest

In a Kubernetes manifest or Compose file:

image: ghcr.io/p6rguvyrst/opensearch-fscrawler:latest

Quick start

With Docker Compose

# Start OpenSearch, Tika, Dashboards, and FSCrawler (rebuilds images automatically)
make up

Locally (development)

# One command: install deps, wire git hooks
make develop

# Create a job config
fscrawler --setup myfiles
# Edit ~/.fscrawler/myfiles/_settings.yaml

# Run once
fscrawler myfiles

# Run continuously (watches for filesystem changes)
fscrawler --loop myfiles

Requirements

• Python 3.12+
• A running Apache Tika server (docker run -p 9998:9998 apache/tika:latest-full)
• A running OpenSearch or Elasticsearch cluster

Development only:

• uv — package manager (brew install uv)
• Trivy — vulnerability scanner, required by the pre-push git hook (brew install trivy)

Configuration

See docs/configuration.md for the full settings reference.

Development

make develop      # first-time setup: install deps + activate git hooks
make test         # run unit tests
make lint         # ruff check
make typecheck    # mypy
make test-all     # unit + integration (needs OPENSEARCH_URL)

Integration tests

# Start services
docker compose up -d opensearch tika

# Run integration tests
OPENSEARCH_URL=http://localhost:9200 TIKA_URL=http://localhost:9998 make test-integration

Architecture

src/fscrawler/
├── cli.py        CLI entry point (Click)
├── settings.py   YAML config loader with duration/byte parsing
├── models.py     Document, FileInfo, PathInfo, Meta dataclasses
├── templates.py  OpenSearch component and index template definitions
├── client.py     opensearch-py wrapper
├── crawler.py    Local filesystem walker with checkpoint tracking
├── watcher.py    Watchdog-based filesystem event handler
├── parser.py     Apache Tika HTTP client
└── indexer.py    Bulk buffering/flushing processor

Roadmap

See ROADMAP.md for planned improvements and known limitations.

Security

This prototype has known security issues — including no REST authentication, unbounded upload size, and unvalidated index names — that make it unsuitable for production or internet-facing deployments. See SECURITY.md for the full list.

Credits

This project (opensearch-fscrawler) is a Python rewrite of FSCrawler, originally created by David Pilato in 2012. The configuration format, REST API design, crawl workflow, and checkpoint mechanism are all derived from his work.

If you need the full-featured Java version with Elasticsearch/OpenSearch 7–9 support, SSH/FTP crawling, Apache Tika bundled, and a plugin system, use the original: https://github.com/dadoonet/fscrawler

License

Apache License 2.0 — same as the original FSCrawler project. See LICENSE and NOTICE for full attribution details.