Extension Customizer


Extension Basics

Title
Customizer
Name
ckanext-customizer
Type
Public extension
Description
Customize CKAN components using environment variables including organization/group naming, social buttons, and language selection.
CKAN versions
Download-Url (zip)
Last commit
3 years ago (2022-07-11 04:09:27)
Url to repo
Category
Regional Government Themes


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” (handles plurals, capitalizations, etc.) and add custom helper texts
  • Remove social media buttons
  • Remove language selection from footer

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

  1. Activate your CKAN virtual environment
  2. Clone and install: git clone https://github.com/saikarthikp9/ckanext-customizer.git cd ckanext-customizer pip install -e . pip install -r requirements.txt
  3. Add customizer to ckan.plugins
  4. Run the customizer-i18n-branding command: ckan -c /etc/ckan/default/ckan.ini customizer-i18n-branding
  5. Restart CKAN

Environment Variables

Variable Required Default
CUSTOMIZER_ORGANIZATION_NAME N organization
CUSTOMIZER_ORGANIZATION_DESCRIPTION N (CKAN default description)
CUSTOMIZER_GROUP_NAME N group
CUSTOMIZER_GROUP_DESCRIPTION N (CKAN default description)
CUSTOMIZER_REMOVE_LANG_SELECTION N False
CUSTOMIZER_REMOVE_SOCIALS N False

Limitations

  • “organization” and “group” terms changed only in English
  • The paths “/organization” and “/group” remain unchanged

License

AGPL-3.0

Version
0.1.0
Version release date
2021-01-29
Contact name
saikarthikp9
Contakt email
(not set)
Contact Url


Installation Guide

Configuration hints

Use environment variables for customization. Run ‘ckan customizer-i18n-branding’ after installation.

Plugins to configure (ckan.ini)
customizer
CKAN Settings (ckan.ini)
# CUSTOMIZER_ORGANIZATION_NAME = organization
# CUSTOMIZER_ORGANIZATION_DESCRIPTION = 
# CUSTOMIZER_GROUP_NAME = group
# CUSTOMIZER_GROUP_DESCRIPTION = 
# CUSTOMIZER_REMOVE_LANG_SELECTION = False
# CUSTOMIZER_REMOVE_SOCIALS = False
DB migration to be executed
(not set)
<< back to Extensions