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
- Activate your CKAN virtual environment
- Clone and install:
git clone https://github.com/saikarthikp9/ckanext-customizer.git
cd ckanext-customizer
pip install -e .
pip install -r requirements.txt
- Add
customizer to ckan.plugins
- Run the customizer-i18n-branding command:
ckan -c /etc/ckan/default/ckan.ini customizer-i18n-branding
- 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