|General||Source||Linux Packages (.rpm and .deb)||Windows||Known bugs||Mac ports||Updated input handlers||Translations|
If you find problems with this page, the package or its installation, please report them.
All download files are signed (gpg) and checksummed. Add .asc or .sha256 to the download URL to get the signature and/or checksum. See here for details about the signature keys.
Recoll Installation / building manual.
The input handlers/filters used for some document types may need external packages not installed on your system by default, and not installed automatically with Recoll: take a look at the list and decide what you need to install.
The Recoll term explorer tool in phonetic mode (marginally useful and optional), and the orthographic suggestions made when a search fails, use the aspell package, version 0.60 (utf-8 support) or newer.
What do the release numbers mean?
The Recoll releases are numbered X.Y.Z. The X would only change for really major modifications like a big change in the index format, and possibly won't ever reach 2.
Y is for functional modifications. These may bring bugs, so if you don't need the new features, you may want to wait a little, and especially skip the first release (X.Y.0), at least for a few weeks.
Z changes for bug fixes only, and moving from X.Y.Z to X.Y.Z+u should in general involve little risk of regression. But, any change can bring problems, if you are not affected by the corrected bugs, there is probably no necessity to upgrade anyway.
Current release: 1.26.4
This can be used with all recent Gnome Desktop versions to include Recoll search results in the Gnome Shell search, and replaces the Unity Scope for recent Ubuntu versions (18.04/bionic and newer).
Packages exist for Ubuntu (on the Recoll PPA), and Fedora (release 28 and above).
For other systems, the module is trivial to install. Download the above file, then, in a terminal window:
Then restart the desktop (Alt-F2 then 'r' with xorg, login/logout with the new stuff).
Ubuntu Unity Lens and Scope (obsolete)
You will probably get these from the PPA, but here are the source files. These are not included in the main tar file any more. For any Recoll version after 1.19 (choose on the Ubuntu version, not the Recoll one):
recoll-lens-22.214.171.12443.tar.gz (Ubuntu up to 13.04 Raring)For Recoll 1.18: recoll-lens-126.96.36.19997.tar.gz
unity-scope-recoll-188.8.131.52.tar.gz (Ubuntu 13.10 and later).
For Recoll 1.17: recoll-lens-184.108.40.20697.tar.gz
Prerequisites for building from source:
- C++ compiler. Be aware that its absence sometimes manifests itself by quite cryptic messages.
Xapian core development libraries. Most Linux distributions carry them in their package repository. Or you will find source and binary packages on the Xapian download page.
Note on building Xapian for older CPUs: The build configurations for Xapian releases 1.0.21 and 1.2.1 or newer enable the use of SSE2 floating point instructions. These instructions are not available in CPUs older than Intel Pentium 4 or AMD Athlon 64. When building for such a CPU, you need to add the --disable-sse flag to the Xapian library configure command. If this is not done, the problem signals itself by "Illegal instruction" crashes (SIGILL) in recollindex and recoll.
- Qt development files: Qt 5.3 or newer (5.2 not ok).
- Qt WebKit development files: these are quite often distributed apart from the main Qt libraries. It is possible to configure Recoll not to use Qt WebKit (see configure --help).
- zlib development files.
- X11 development files.
- Python development package: you can avoid needing this by configuring with --disable-python-module.
The Recoll source repository is hosted on opensourceprojects.eu. The trunk is usually a bit on the bleeding edge, but there is always a maintenance branch for the current production version.
Instructions for building
Normally, it's just:
If a bit more detail is needed, there is some in the manual.
Packages or ports for Recoll are available in the standard repositories for many distributions.
However they are often a bit older or built with older Xapian releases. Here follow some pointers to find newer packages for some distributions. In most cases, you will just need to use an alternate repository.
The Debian Recoll packages are not always up to date in stable distributions. Debian Jessie has Recoll 1.17.3. which is ancient. Stretch has 1.22.4 which is largely ok, and Buster 1.24.3 (fine).
I am maintaining a repository for newer versions of the packages. The repository currently has recoll 1.25.x for Jessie and Stretch, Intel 32 and 64 bits, and armhf, and older 1.22 packages for Wheezy. There is a separate repository for Raspbian Jessie, which is not compatible with vanilla Debian.
To add the Debian or Raspbian repository to your sources:
- See here for the keys used to signed the repository. You will need to import them to suppress apt-get messages about unverified signatures (the method is described on the same page).
- Create and edit
and add the following lines:
for Debian wheezy (debian 7.x, recoll 1.22.3):
deb http://www.lesbonscomptes.com/recoll/debian/ wheezy main deb-src http://www.lesbonscomptes.com/recoll/debian/ wheezy mainfor Debian jessie (debian 8.x):
deb http://www.lesbonscomptes.com/recoll/debian/ jessie main deb-src http://www.lesbonscomptes.com/recoll/debian/ jessie mainfor Debian stretch (debian 9.x):
deb http://www.lesbonscomptes.com/recoll/debian/ stretch main deb-src http://www.lesbonscomptes.com/recoll/debian/ stretch mainfor Debian buster (debian 10.x):
deb http://www.lesbonscomptes.com/recoll/debian/ buster main deb-src http://www.lesbonscomptes.com/recoll/debian/ buster mainfor Raspbian jessie (raspbian 8.x):
deb http://www.lesbonscomptes.com/recoll/raspbian/ jessie main deb-src http://www.lesbonscomptes.com/recoll/raspbian/ jessie mainfor Raspbian stretch (raspbian 9.x):
deb http://www.lesbonscomptes.com/recoll/raspbian/ stretch main deb-src http://www.lesbonscomptes.com/recoll/raspbian/ stretch main
sudo apt-get update sudo apt-get install recoll python-recoll python3-recoll
If you prefer to manually install the packages, they are here:
There are Personal Package Archives on launchpad.net for Recoll, kio-recoll and the recoll Unity Scope. These were built from the latest versions, for the current set of supported Ubuntu versions. Procedure:
The packages in the PPA now have a separate package for the Python extension, like the standard ones, so there should be no more conflict issues while switching from the PPA to the normal repositories and back.
The Ubuntu PPA works perfectly for Mint 13 (and probably other releases too). Just follow the instructions for Ubuntu.
You'll need to install the Xapian, Qt, Qt-Webkit and zlib development packages if you want use the source rpms.
Recoll is present in the standard Fedora package repositories starting from F-12. Recoll packages in Fedora are usually fairly up to date. Please get in touch if you have a need for a Recoll package for Fedora.
EPEL now has a package for Recoll. It is in currently in the testing section, but it should hopefully move on shortly. If you install the test package (which runs just fine as far as I can see), please add feedback to the package page.
Recoll is in the KDE:Extra repository. You just need to add the
repository to your software
sources (Yast2->software->Software repositories).
Repository list (supported Suse versions). After adding the appropriate repository to your software sources, you will be able to install recoll and kio_recoll from the software management interface. The Xapian dependancy will also be satisfied from the build service repository. Some of the older repositories do not build antiword, just tell the software manager to "break" recoll by installing anyway, and get antiword somewhere else.
The port of Recoll to Windows is still a bit experimental and lacking things like real-time indexing or spelling suggestions. However it works well enough to be useful. More info and links to the setup files here.
It seems that Recoll will sometimes find data that Spotlight misses (especially inside pdfs apparently, which is probably more to the credit of poppler than recoll itself).
Recoll is in MacPorts:
- Install MacPorts.
- Type "sudo port install recoll"
Recoll is then available from the command line and as an icon in the usual MacPorts applications place.
However, the official MacPorts version is usually a bit old as it's not easy to get it to update. You can also perform a local repository build with the up-to-date Portfile from the recoll source tree. Look at the README in the packaging/macports directory in the recoll source tree for a detailed procedure.
new or updated input handlers/filters sometimes become available after a release. As a rule, all filters are compatible with all Recoll versions. Any compatibility problem will be explicitely mentionned.
The messages in the Recoll GUI are managed by the normal Qt internationalization mechanism. Each set of messages for a given non-english language is stored in a separate translation source file. (example: recoll_fr.ts, recoll_de.ts).
The .ts files can be managed by using the Qt linguist program, which is easy to use by anybody (no need to be a programmer).
Most of the translations for the current release are usually incomplete, and many languages are missing.
The source translation files are included in the source release, and they are also stored on the Web site for easy access. recoll_xx.ts is a blank Recoll 1.26 message file, appropriate to work on a new translation. You can also list the directory to see all the translation files for updating one of them (the files are the same as those in the maintenance source branch on opensourceprojects.eu).
If your language is not supported yet, or if the translation has some english messages left and you want to take a shot at fixing the problem, you can send the results to me and earn my gratefulness (and your less multilingual compatriot's)...
If you wish to test the result of your work on the .ts file, you need to run the lrelease to produce a .qm binary file. The .qm file should then be copied to /usr/[local/]share/recoll/translations before restarting Recoll.
Updated 1.26 translations that became available after the release:
None for now...
Note that, if you are running an older release, you may find updated messages by looking inside the appropriate maintenance branch in the source repository.