Tree [d715d3] master /

git clone https://@opensourceprojects.eu/git/p/recollwebui/code recollwebui-code


File Date Author Commit
examples 2012-12-22 koniu koniu [901fa3] examples: add opera-open.sh
static 2016-09-19 koniu koniu [4e748d] restore open local file function (closes #54)
views 2016-12-04 Jean-Francois Dockes Jean-Francois Dockes [6910c8] Use global admin config variables from recoll c...
.gitignore 2014-11-12 Yves Fischer Yves Fischer [967590] Create a .gitignore to hide .pyc files from git
README.rst 2014-07-09 koniu koniu [f26a04] Merge pull request #27 from jobe451/master
bottle.py 2015-03-02 koniu koniu [ee915f] Merge pull request #40 from medoc92/master
rclconfig.py 2013-10-24 koniu koniu [37cd4d] py: import rclconfig and use it
webui-standalone.py 2014-11-10 Yves Fischer Yves Fischer [1a249a] Change directory only if needed
webui-wsgi.py 2013-10-08 koniu koniu [7da8ea] py: fix setting of cwd again
webui.py 2017-09-07 Jean-Francois Dockes Jean-Francois Dockes [d715d3] Use idoctofile in all cases (no direct file:// ...

Read Me

Recoll WebUI

Recoll WebUI is a Python-based web interface for Recoll text search tool for Unix/Linux.

http://i.imgur.com/n8qTnBg.png

Requirements

All you need to use the WebUI is:

  • Python 2.x
  • Recoll 1.17+
  • web browser

Download

If your Recoll version is 1.18.2 or newer:
https://github.com/koniu/recoll-webui/archive/master.zip
If your Recoll version version is 1.17-1.18.1:
https://github.com/koniu/recoll-webui/archive/v1.18.1.zip
You can fetch the full git repository like this:
git clone https://github.com/koniu/recoll-webui.git

Usage

Recoll WebUI can be used as a standalone application or through a web server via WSGI/CGI. Regardless of the mode of operation you need Recoll to be configured on your system as the WebUI only provides a front-end for searching and does not handle index configuration etc.

Run standalone

Run webui-standalone.py and connect to http://localhost:8080.

There's some optional command-line arguments available:

-h, --help            show this help message and exit
-a ADDR, --addr ADDR  address to bind to [127.0.0.1]
-p PORT, --port PORT  port to listen on [8080]

Run as WSGI/CGI

Example WSGI/Apache2 config:

WSGIDaemonProcess recoll user=recoll group=recoll threads=5 display-name=%{GROUP} python-path=/var/recoll-webui-master
WSGIScriptAlias /recoll /var/recoll-webui-master/webui-wsgi.py
<Directory /var/recoll-webui-master>
        WSGIProcessGroup recoll
        Order allow,deny
        allow from all
</Directory>

Remarks: * Without "python-path=" you might see errors that it can't import webui * Run the WSGIDeamonProcess run under the username (user=xyz) of the user that you want to have exposed via web

Example Upstart-Script for Ubuntu to run the indexer as daemon:

description "recoll indexer"

start on runlevel [2345]
stop on runlevel [!2345]

respawn

pre-start script
        exec sudo -u recoll sh -c "/usr/local/share/recoll/examples/rclmon.sh start"
end script

pre-stop script
        exec sudo -u recoll sh -c "/usr/local/share/recoll/examples/rclmon.sh stop"
end script

Remarks: * You need to configure the user for which the indexer should run ("sudo -u [myuser])

Example Crontab entry to have the indexer at least once a day:

22 5    * * *   recoll  recollindex

Issues

Can't open files when Recoll WebUI is running on a server

By default links to files in the result list correspond to the file's physical location on the server. If you have access to the file tree via a local mountpoint or eg. ftp/http you can provide replacement URLs in the WebUI settings. If in doubt, ask your network administrator.