# Welcome to FSCrawler's documentation!

````{ifconfig} release.endswith('-SNAPSHOT')
```{warning}
This documentation is for the version of FSCrawler currently under development.
Were you looking for <a href="../fscrawler-2.9/">the documentation of the latest stable version</a>?
```
````

Welcome to the FS Crawler for {{ ES }}.

This crawler helps to index binary documents such as PDF, Open Office, MS Office.

```{figure} fscrawler-explained.png
:alt: FSCrawler Explained - Generated with Gemini
:width: 100%
```

**Main features**:

* Local file system (or a mounted drive) crawling and index new files, update existing ones and removes old ones.
* Remote file system over SSH/FTP crawling.
* REST interface to let you "upload" your binary documents to elasticsearch.

```{note}
FS Crawler {{ release }} is using {{ Tika_version }} and is tested against:

* {{ ES_version9 }}.
* {{ ES_version8 }}.
* {{ ES_version7 }}. (Deprecated)
```

```{toctree}
:caption: Installation Guide
:maxdepth: 2

installation
```

```{toctree}
:caption: User Guide
:maxdepth: 3

user/getting_started
user/tutorial
user/options
user/ocr
user/rest
user/formats
user/tips
```

```{toctree}
:caption: Administration Guide
:maxdepth: 3

admin/layout
admin/cli-options
admin/jvm-settings
admin/logger
admin/otel
admin/fs/index
admin/fs/simple
admin/fs/local-fs
admin/fs/document-ids
admin/fs/tags
admin/fs/ssh
admin/fs/ftp
admin/fs/elasticsearch
admin/fs/rest
admin/status
```

```{toctree}
:caption: Developer Guide
:maxdepth: 3

dev/build
dev/doc
dev/release
dev/test-fscrawler-cli
```

```{toctree}
:caption: Release Notes
:maxdepth: 2

release/index
release/3.0
release/2.9
release/2.8
release/2.7
release/2.6
release/2.5
release/2.4
release/2.3
release/2.2
```

## License

```{important}
This software is licensed under the Apache 2 license, quoted below.

Copyright 2011-{{ year }} David Pilato

Licensed under the Apache License, Version 2.0 (the "License"); you may not
use this file except in compliance with the License. You may obtain a copy of
the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations under
the License.
```

## Incompatible 3rd party library licenses

To support JPEG 2000 (JPX/JP2) images, you need to manually add {{ JPEG2000_version }} library to
the `external` directory:

```
cd external
wget https://repo1.maven.org/maven2/com/github/jai-imageio/jai-imageio-jpeg2000/1.4.0/jai-imageio-jpeg2000-1.4.0.jar
```

See
[pdfbox documentation](https://pdfbox.apache.org/2.0/dependencies.html#jai-image-io)
for more details about the license details.

## Special thanks

Thanks to [JetBrains](https://www.jetbrains.com/?from=FSCrawler) for the IntelliJ IDEA License!

[![Jet Brains](jetbrains.png)](https://www.jetbrains.com/?from=FSCrawler)