FSCrawler

Installation Guide

  • Using docker
  • Using docker compose
  • Running as a Service on Windows
  • Local installation

User Guide

  • Getting Started
  • Tutorial
  • Crawler options
  • OCR integration
  • Starting with a REST gateway
  • Supported formats
  • Tips and tricks

Administration Guide

  • Directory layout
  • CLI options
  • JVM Settings
  • Configuring the logger
  • OTel Tracing / EDOT Collector
  • Job file specifications
  • The most simple crawler
  • Local FS settings
  • External Tags
  • SSH settings
  • FTP settings
  • Elasticsearch settings
  • REST service
  • Checkpoint file

Developer Guide

  • Building the project
  • Writing documentation
  • Release the project
  • Testing FSCrawler CLI

Release Notes

  • Release notes
  • Version 2.10
  • Version 2.9
  • Version 2.8
  • Version 2.7
  • Version 2.6
  • Version 2.5
  • Version 2.4
  • Version 2.3
  • Version 2.2
FSCrawler
  • Search

© Copyright 2026, David Pilato.

Built with Sphinx using a theme provided by Read the Docs.