Extension Customizer


Extension Basics

Title
Customizer
Name
ckanext-customizer
Type
Public extension
Description
This CKAN extension provides a way to customize CKAN components using environment variables. This makes production deployments a breeze.
CKAN versions
Download-Url (zip)
Last commit
3 years ago (2022-07-11 00:49:08)
Url to repo
Category
Authentication & Security


Background Infos

Description (long)
Show details

ckanext-customizer

This CKAN extension provides a way to customize a CKAN implementation using environment variables that are not already supported by default or by ckanext-envvars. The goal is to make production deployments a breeze.

Features

  • change name of terms: “organization” and “group” (will handle plurals, capitalizations, etc.) and add custom helper texts for the same
  • remove social media buttons
  • remove the language selection from footer

Please request a feature by creating an issue in this repository.

Requirements

Compatibility with core CKAN versions:

CKAN version Compatible?
2.6 and earlier not tested
2.7 not tested
2.8 yes
2.9 yes

Installation

To install ckanext-customizer:

  1. Activate your CKAN virtual environment, for example:

    . /usr/lib/ckan/default/bin/activate

  2. Clone the source and install it on the virtualenv

    git clone https://github.com/saikarthikp9/ckanext-customizer.git
    cd ckanext-customizer
    pip install -e .
    pip install -r requirements.txt
    
  3. Add customizer to the ckan.plugins setting in your CKAN config file (by default the config file is located at /etc/ckan/default/ckan.ini).

  4. Run the customizer-i18n-branding command

    ckan -c /etc/ckan/default/ckan.ini customizer-i18n-branding
    
  5. Restart CKAN server. For example if you’ve deployed CKAN with Apache on Ubuntu:

    sudo service apache2 reload

Environment Variables:

Name Required Default
CUSTOMIZER_ORGANIZATION_NAME N organization
CUSTOMIZER_ORGANIZATION_DESCRIPTION N CKAN Organisations are used
Version
Version release date
(not set)
Contact name
Sai
Contakt email
(not set)
Contact Url
(not set)


Installation Guide

Configuration hints

To install ckanext-customizer:

  1. Activate your CKAN virtual environment, for example:

    . /usr/lib/ckan/default/bin/activate

  2. Clone the source and install it on the virtualenv

    git clone https://github.com/saikarthikp9/ckanext-customizer.git
    cd ckanext-customizer
    pip install -e .
    pip install -r requirements.txt
    
  3. Add customizer to the ckan.plugins setting in your CKAN config file (by default the config file is located at `/etc/ckan/default/cka

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