Skip to content

Installation

Requirements

Compatibility with core CKAN versions:

CKAN version Compatible?
2.9 no
2.10 yes
2.11 yes

Installation

  1. Install the extension from PyPI:

    pip install ckanext-admin-panel
    

  2. Enable the main plugin and extra plugins you want to use in your CKAN configuration file (e.g. ckan.ini or production.ini):

    ckan.plugins = ... admin_panel admin_panel_log ...
    
  3. Initialize all missing tables with: ckan db pending-migrations --apply

Developer installation

To install ckanext-admin-panel for development, activate your CKAN virtualenv and do:

git clone https://github.com/DataShades/ckanext-admin-panel.git
cd ckanext-admin-panel
pip install -e .

Extra plugins

In addition to the main plugin, ckanext-admin-panel introduces several extensions that enhance the basic functionality by providing convenient tools for working with logs, cron jobs, and more.

See the Features section for a list of available plugins and information on how to enable them.

Dependencies

The extension requires the following CKAN extensions to be installed and enabled:

  1. ckanext-scheming: We're using the scheming extension to create custom forms for plugin configuration pages. See the documentation for more information.

  2. ckanext-collection: The ckanext-collection is a tool for building interfaces for data collections using declarative style. We use it to represent tabular data in the admin panel, such as Content or User list.

  3. ckanext-editable-config: The ckanext-editable-config extension allows you to edit the CKAN configuration in runtime.