# dadoonet/fscrawler

Elasticsearch File System Crawler (FS Crawler)

Repository: https://github.com/dadoonet/fscrawler
Canonical: https://ross.abutalabs.com/products/fscrawler
Homepage: https://fscrawler.readthedocs.io/
Language: Java
License: Apache-2.0
License Family: permissive
Topics: java, elasticsearch, crawler, tika
Last push: 2026-08-26T18:34:15+00:00

## Health v2 (maintenance only)
Score: 88/100 (v2, computed 2026-09-03T02:20:16.233290+00:00)
- activity 99, release rhythm 67, longevity 100
- inputs: {"age_days": 5199, "days_push": 7, "days_rel": 7, "gap_med": null, "n_releases_24m": 1}
- flags: none
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 1450, forks 308 (observed 2026-08-28T04:04:45.838555+00:00)

## What it is
FSCrawler is a Java-based file system crawler that indexes binary documents (PDF, MS Office, Open Office) into Elasticsearch, tracking new, updated, and deleted files. It supports local and remote (SSH/FTP) file systems and offers a REST interface for uploading documents directly.

## Use cases
- index pdf and office documents into elasticsearch
- crawl a local folder and keep an elasticsearch index in sync
- extract text from binary documents for full-text search
- upload documents to elasticsearch via a rest endpoint
- crawl files over ssh or ftp and index them
- build a document search engine from a file share

## When to choose
- you need to full-text search binary documents stored on a file system with elasticsearch
- you want automatic syncing of file additions, updates, and deletions into an index
- you need tika-based text extraction without writing your own pipeline

## When to avoid
- you use a search engine other than elasticsearch
- you only need to crawl web pages rather than local or remote file systems
- you want a fully managed cloud ingestion service

## Facets
- artifact type: application
- maturity: active
- function: search-engine, etl, ocr, parser
- domain: files, pdf, developer-tools
- platform: jvm, cross-platform, cli
- tags: elasticsearch, tika, file-crawler, binary-documents, indexing, rest-upload, search, docker

## Member repositories
- dadoonet/fscrawler (main) score 88

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:04:45.838555+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-30T04:35:55.190241+00:00, confidence not recorded.
  - readme: https://github.com/dadoonet/fscrawler (fetched 2026-08-28T04:04:45.838555+00:00, sha 3bc8837088dc)
- Data as of 2026-08-30T08:39:29.467469+00:00.
