Extension Status


Extension Basics

Title
Status
Name
ckanext-status
Type
Public extension
Description
CKAN extension for displaying a status bar with custom messages across all frontend pages, developed by the Natural History Museum.
CKAN versions
Download-Url (zip)
Last commit
9 months ago (2025-06-09 13:10:07)
Url to repo
Category
Specialized Tools


Background Infos

Description (long)
Show details

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

  • CKAN >=2.9
  • Python 3

License

GPL-3.0

Version
2.4.4
Version release date
2025-06-09
Contact name
Natural History Museum
Contakt email
Contact Url
(not set)


Installation Guide

Configuration hints

Set ckanext.status.message to display a status bar on all pages. Leave empty to hide.

Plugins to configure (ckan.ini)
status
CKAN Settings (ckan.ini)
# ckanext.status.message = System maintenance scheduled for tonight.
DB migration to be executed
(not set)
<< back to Extensions