Updated: 2024-09 : - Recoll is now built as a 64 bits app, - Update Python versions

Installing the Recoll Python3 extension

The extension is built for Python 3.10 to 3.13 (64 bits) at the moment. It is distributed as separate .whl files The files are located in the Share/dist subdirectory of the Recoll installation directory (so, usually, C:\Program Files (x86)\Recoll\Share\dist)

The folder will contain files with names like the following:

Recoll-1.xx.yy-cp3zt-cp3zt-win_amd64.whl

Where 1.xx.yy is the Recoll version (e.g. 1.40.2), and 3zt the Python one (e.g. 312).

You will need to use a command window to install the extension. Run a command like the following, adjusting things for the Python and Recoll version numbers:

"C:\Program Files\Python312\Scripts\pip.exe" install "C:\Program Files (x86)\Recoll\Share\dist\Recoll-1.40.2-cp312-cp312-win_amd64.whl

Check the installation by running python and trying to import the recoll module:

"C:\Program Files\Python312\python.exe
>>> from recoll import recoll
>>> quit()

Installing the Recoll WebUI

  • Install the waitress HTTP module:

    "C:\Program Files\Python312\Scripts\pip.exe" install waitress

  • Clone the WebUI directory somewhere (e.g. C:\Users\[you]\Documents):

    git clone https://framagit.org/medoc92/recollwebui.git

If you don’t have git around, you can also download a Zip of the WebUI files from https://framagit.org/medoc92/recollwebui. Use the download icon on the left from the Clone button.

  • Run the WEBUI in a command Window, or from a script as:

    "C:\Program Files\Python312\python.exe C:\Users\you\Documents\recollwebui\webui-standalone.py -a 0.0.0.0

The -a 0.0.0.0 would tell the WebUI to use all the available interfaces, you can give it an IP address instead.

By default, the WebUI listens on port 8080. You can change this with the -p option.

By default this will use the Recoll configuration from C:\Users\you\Appdata\Local\Recoll. You can use the RECOLL_CONFDIR environment variable to change the base configuration directory, and RECOLL_EXTRACONFDIRS to add external indexes.