Skip to content
Back to top
View this page
Edit this page

# Recoll Engine

Recoll is a desktop full-text search tool based on Xapian. By itself Recoll does not offer WEB or API access, this can be achieved using recoll-webui

## Configuration

You must configure the following settings:

- `base_url`

- `mount_prefix`

- `dl_prefix`

- `search_dir`

Example scenario:

1. Recoll indexes a local filesystem mounted in `/export/documents/reference`,

2. the Recoll search interface can be reached at https://recoll.example.org/ and

3. the contents of this filesystem can be reached though https://download.example.org/reference

    base_url: https://recoll.example.org
    mount_prefix: /export/documents
    dl_prefix: https://download.example.org
    search_dir: ""

## Implementations

searx.engines.recoll.base_url: str = ''

  Location where recoll-webui can be reached.

searx.engines.recoll.mount_prefix: str = ''

  Location where the file hierarchy is mounted on your local filesystem.

searx.engines.recoll.dl_prefix: str = ''

  Location where the file hierarchy as indexed by recoll can be reached.

searx.engines.recoll.search_dir: str = ''

  Part of the indexed file hierarchy to be search, if empty the full domain is searched.

searx.engines.recoll.setup(engine_settings: dict[str, Any]) → bool

  Initialization of the Recoll engine, checks if the mandatory values are configured.