ckanext-status
A CKAN extension that adds a status bar to the page.
Overview
Adds a dismissable status bar to the top of every page in the CKAN frontend. Useful for displaying maintenance notices, announcements, or other status messages to users.
Installation
Path variables used below:
- $INSTALL_FOLDER (where CKAN is installed), e.g. /usr/lib/ckan/default
- $CONFIG_FILE, e.g. /etc/ckan/default/development.ini
Installing from PyPI
pip install ckanext-status
Installing from source
cd $INSTALL_FOLDER/src
git clone https://github.com/NaturalHistoryMuseum/ckanext-status.git
cd ckanext-status
pip install -e .
Setup
Add ‘status’ to the list of plugins in your $CONFIG_FILE:
ckan.plugins = ... status
Configuration
| Name |
Description |
Default |
ckanext.status.message |
The status message to display |
(empty) |
Usage
The status bar will appear on all pages when the config value ckanext.status.message is set to a non-empty string. Users can dismiss the bar, which will be remembered for the browser session.
Changelog
v2.4.4 (2025-06-09)
Latest release with CKAN 2.11 support.
Requirements
License
GPL-3.0