Skip to content

Installation

Path variables used below: - $INSTALL_FOLDER (i.e. 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-versioned-datastore

Installing from source

  1. Clone the repository into the src folder: 

    cd $INSTALL_FOLDER/src
git clone https://github.com/NaturalHistoryMuseum/ckanext-versioned-datastore.git

  2. Activate the virtual env: 

    . $INSTALL_FOLDER/bin/activate

  3. Install via pip: 

    pip install $INSTALL_FOLDER/src/ckanext-versioned-datastore

Installing in editable mode

Installing from a pyproject.toml in editable mode (i.e. pip install -e) requires setuptools>=64; however, CKAN 2.9 requires setuptools==44.1.0. See our CKAN fork for a version of v2.9 that uses an updated setuptools if this functionality is something you need.

Post-install setup

  1. Add 'versioned_datastore' to the list of plugins in your $CONFIG_FILE: 

    ckan.plugins = ... versioned_datastore

  2. Install lessc globally: 

    npm install -g "less@~4.1"

Other requirements

At the version of splitgill this plugin uses, you will also need to install: - MongoDB 4.x - Elasticsearch 6.7.x (6.x is probably ok, but untested)

This plugin also requires CKAN's job queue, which is included in recent versions of CKAN or can be added to older versions using the ckanext-rq plugin.