Extension Suggest


Extension Basics

Title
Suggest
Name
ckanext-suggest
Type
Public extension
Description
CKAN extension that utilizes the Solr Suggest component to provide auto-suggest functionality in CKAN's main dataset search.
CKAN versions
Download-Url (zip)
Last commit
3 years ago (2022-05-30 15:06:36)
Url to repo
Category
Specialized Tools


Background Infos

Description (long)
Show details

ckanext-suggest

An extension that utilizes Solr Suggest component to provide auto-suggest feature in CKAN’s main dataset search.

Requirements

  • CKAN 2.9: yes
  • Earlier versions: not tested

Installation

  1. Edit solrconfig.xml to add SuggestComponent configuration (datasetTitleSuggester, datasetNotesSuggester, datasetTagsSuggester)
  2. Add /suggest request handler to solrconfig.xml
  3. Restart SOLR: sudo service solr restart
  4. Activate CKAN virtual environment
  5. Clone & install: git clone https://github.com/keitaroinc/ckanext-suggest.git cd ckanext-suggest pip install -e . pip install -r requirements.txt
  6. Add suggest to ckan.plugins
  7. Restart CKAN
  8. Build SOLR lookup data: ckan -c /etc/ckan/default/ckan.ini suggest buid
  9. Set up CRON job: @daily ckan -c /etc/ckan/default/ckan.ini suggest buid

Config Settings

None at the moment.

Tests

pytest --ckan-ini=test.ini

License

AGPL-3.0

Version
0.0.1
Version release date
(not set)
Contact name
Keitaro Inc
Contakt email
Contact Url
(not set)


Installation Guide

Configuration hints

Requires SOLR configuration changes (SuggestComponent and /suggest request handler in solrconfig.xml). Daily CRON job recommended for rebuilding lookup data.

Plugins to configure (ckan.ini)
suggest
CKAN Settings (ckan.ini)
DB migration to be executed
(not set)
<< back to Extensions