{"id":13558019,"url":"https://github.com/koniu/recoll-webui","last_synced_at":"2025-12-16T20:57:23.602Z","repository":{"id":54783314,"uuid":"7220462","full_name":"koniu/recoll-webui","owner":"koniu","description":"web interface for recoll desktop search","archived":false,"fork":false,"pushed_at":"2020-07-21T11:51:22.000Z","size":132,"stargazers_count":287,"open_issues_count":34,"forks_count":56,"subscribers_count":13,"default_branch":"master","last_synced_at":"2025-05-27T08:54:21.136Z","etag":null,"topics":["full-text-search","python","search-interface","web-interface"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/koniu.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2012-12-18T09:10:40.000Z","updated_at":"2025-04-20T10:22:19.000Z","dependencies_parsed_at":"2022-08-14T02:51:17.795Z","dependency_job_id":null,"html_url":"https://github.com/koniu/recoll-webui","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/koniu/recoll-webui","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koniu%2Frecoll-webui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koniu%2Frecoll-webui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koniu%2Frecoll-webui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koniu%2Frecoll-webui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/koniu","download_url":"https://codeload.github.com/koniu/recoll-webui/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koniu%2Frecoll-webui/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":27771139,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-12-16T02:00:10.477Z","response_time":57,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["full-text-search","python","search-interface","web-interface"],"created_at":"2024-08-01T12:04:41.358Z","updated_at":"2025-12-16T20:57:23.581Z","avatar_url":"https://github.com/koniu.png","language":"Python","funding_links":[],"categories":["Python","python"],"sub_categories":[],"readme":"============\nRecoll WebUI\n============\n\n**Recoll WebUI** is a Python-based web interface for **Recoll** text search\ntool for Unix/Linux.\n\n.. image:: http://i.imgur.com/n8qTnBg.png\n\n* WebUI homepage: https://github.com/koniu/recoll-webui\n* Recoll homepage: http://www.lesbonscomptes.com/recoll\n\nRequirements\n============\n\nAll you need to use the WebUI is:\n\n* Python 2.x\n* Recoll 1.17+\n* web browser\n\nDownload\n========\nIf your Recoll version is 1.18.2 or newer:\n        https://github.com/koniu/recoll-webui/archive/master.zip\nIf your Recoll version version is 1.17-1.18.1:\n        https://github.com/koniu/recoll-webui/archive/v1.18.1.zip\nYou can fetch the full git repository like this:\n        ``git clone https://github.com/koniu/recoll-webui.git``\n\nUsage\n=====\n\n**Recoll WebUI** can be used as a standalone application or through a web\nserver via WSGI/CGI. Regardless of the mode of operation you need Recoll\nto be configured on your system as the WebUI only provides a front-end for\nsearching and does not handle index configuration etc.\n\nRun standalone\n--------------\nRun ``webui-standalone.py`` and connect to ``http://localhost:8080``.\n\nThere's some optional command-line arguments available::\n\n    -h, --help            show this help message and exit\n    -a ADDR, --addr ADDR  address to bind to [127.0.0.1]\n    -p PORT, --port PORT  port to listen on [8080]\n\nRun as WSGI/CGI\n---------------\n\nExample WSGI/Apache2 config::\n\n        WSGIDaemonProcess recoll user=recoll group=recoll threads=5 display-name=%{GROUP} python-path=/var/recoll-webui-master\n        WSGIScriptAlias /recoll /var/recoll-webui-master/webui-wsgi.py\n        \u003cDirectory /var/recoll-webui-master\u003e\n                WSGIProcessGroup recoll\n                Order allow,deny\n                allow from all\n        \u003c/Directory\u003e\n\nRemarks:\n* Without \"python-path=\" you might see errors that it can't import webui \n* Run the WSGIDeamonProcess run under the username (user=xyz) of the user that you want to have exposed via web\n\n\nExample Upstart-Script for Ubuntu to run the indexer as daemon::\n\n\n        description \"recoll indexer\"\n\n        start on runlevel [2345]\n        stop on runlevel [!2345]\n        \n        respawn\n        \n        pre-start script\n                exec sudo -u recoll sh -c \"/usr/local/share/recoll/examples/rclmon.sh start\"\n        end script\n        \n        pre-stop script\n                exec sudo -u recoll sh -c \"/usr/local/share/recoll/examples/rclmon.sh stop\"\n        end script\n\nRemarks:\n* You need to configure the user for which the indexer should run (\"sudo -u [myuser])\n\n\nExample Crontab entry to have the indexer at least once a day::\n\n        22 5    * * *   recoll  recollindex\n\n\n\nIssues\n======\n\nCan't open files when Recoll WebUI is running on a server\n---------------------------------------------------------\nBy default links to files in the result list correspond to the file's\nphysical location on the server. If you have access to the file tree\nvia a local mountpoint or eg. ftp/http you can provide replacement\nURLs in the WebUI settings. If in doubt, ask your network administrator.\n\nOpening files via local links\n-----------------------------\nFor security reasons modern browsers prevent linking to local content from\n'remote' pages. As a result URLs starting with file:// will not, by default,\nbe opened when linked from anything else than pages in file:// or when\naccessed directly from the address bar. Here's ways of working around it:\n\nFirefox\n~~~~~~~\n1. Insert contents of ``examples/firefox-user.js`` into\n   ``~/.mozilla/firefox/\u003cprofile\u003e/user.js``\n2. Restart Firefox\n\nChrom{e,ium}\n~~~~~~~~~~~~\nInstall *LocalLinks* extension:\n\n* http://code.google.com/p/locallinks/\n* https://chrome.google.com/webstore/detail/locallinks/jllpkdkcdjndhggodimiphkghogcpida\n\nOpera\n~~~~~\n1. Copy ``examples/opera-open.sh`` into your PATH (eg. ``/usr/local/bin``)\n2. Go to ``Tools \u003e Preferences \u003e Advanced \u003e Programs \u003e Add``\n3. In ``Protocol`` field enter ``local-file``\n4. Select ``Open with other application`` and enter ``opera-open.sh``\n5. In WebUI settings replace all ``file://`` with ``local-file://``\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkoniu%2Frecoll-webui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkoniu%2Frecoll-webui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkoniu%2Frecoll-webui/lists"}