Extension Desq


Extension Basics

Title
Desq
Name
ckanext-desq
Type
Public extension
Description
The **desq** extension for CKAN provides custom modifications specifically tailored for the DESQ da
CKAN versions
Download-Url (zip)
Last commit
6 months ago (2025-06-25 03:48:58)
Url to repo
Category
Data Management & Quality


Background Infos

Description (long)
Show details

ckanext-desq

Customizations for DESQ. This CKAN plugin is not designed to be generic or easily applicable to other data portals. It requires specific changes to the CKAN configuration and the Solr schema.

Requirements

  • Python 3.9
  • Ubuntu packages required by PyICU: bash sudo apt install libicu-dev python3-icu pkg-config
  • CKAN, DESQ fork, installed with: bash pip install -e 'git+https://github.com/whiskyechobravo/ckan.git@desq#egg=ckan[requirements]'

Tested under Ubuntu 20.04 and 22.04.

Installation

  1. Activate your CKAN virtualenv, for example:

    . /usr/lib/ckan/default/bin/activate
    
  2. Install ckanext-desq in the virtualenv:

    pip install -e 'git+https://github.com/whiskyechobravo/ckanext-desq.git#egg=ckanext-desq'
    

    That will also install some dependencies (listed in ckanext-desq/setup.cfg).

  3. Use config/ckan/sample.ini as a replacement to /etc/ckan/default/ckan.ini, but edit the following settings:

    • beaker.session.secret
    • sqlalchemy.url
    • api_token.jwt.encode.secret
    • api_token.jwt.decode.secret
    • solr_url
    • solr_user
    • solr_password
    • licenses_group_url (must link to ckanext-desq/config/ckan/licenses.json)
    • ckan.storage_path (if need to change from /var/lib/ckan/default)
  4. Copy the required webfonts to the ckanext/desq/public/webfonts/ directory.

  5. Restart CKAN. Assuming it’s installed as a systemd service:

    sudo service ckan restart
    

Performing manual backup and restore

References: - https://docs.ckan.org/en/2.9/maintaining/database-management.html#import-and-export - https://docs.ckan.org/en/2.9/maintaining/cli.html#search-index-rebuild-search-index

Backup:

sudo -u postgres pg_dump --format=custom -d ckan_default > desq-$(date +%Y%m%d-%H%M).pgdump

Restore (replace path to .ini file if necessary):

“`bash ckan -c /etc/ckan/default/ckan.ini db clean sudo -u

Version
Version release date
(not set)
Contact name
Whisky Echo Bravo
Contakt email
Contact Url
(not set)


Installation Guide

Configuration hints
  1. Activate your CKAN virtualenv, for example:

    . /usr/lib/ckan/default/bin/activate
    
  2. Install ckanext-desq in the virtualenv:

    pip install -e 'git+https://github.com/whiskyechobravo/ckanext-desq.git#egg=ckanext-desq'
    

    That will also install some dependencies (listed in ckanext-desq/setup.cfg).

  3. Use config/ckan/sample.ini as a replacement to /etc/ckan/default/ckan.ini, but edit the following settings:

    • beaker.session.secret
    • `
Plugins to configure (ckan.ini)
desq
CKAN Settings (ckan.ini)
DB migration to be executed
(not set)
<< back to Extensions