Extension Data.gov.uk


Extension Basics

Title
Data.gov.uk
Name
ckanext-datagovuk
Type
Public extension
Description
The CKAN extension for data.gov.uk, providing Sentry integration, test data management, and deployment tooling.
CKAN versions

~2.10

Show details
Download-Url (zip)
https://github.com/alphagov/ckanext-datagovuk.git#egg=ckanext-datagovuk
Last commit
11 days ago (2026-02-26 12:47:34)
Url to repo
https://github.com/alphagov/ckanext-datagovuk
Category
Regional Government Themes


Background Infos

Description (long)
Show details

ckanext-datagovuk

The CKAN extension for data.gov.uk

Features

  • Configures Sentry automatically using a SENTRY_DSN environment variable.

Running CKAN and Find locally

To run a development version of Find locally you will need to build the development image locally which will allow you to make modifications to the code directly on the docker container.

  1. On the datagovuk_find root directory run make dev-build after making code updates and passing tests.
  2. Check that the image is available by running docker images | grep dev.datagovuk_find.
  3. If you run bootstrap then you can skip this step otherwise run make bootstrap to download the latest repositories.
  4. In the ckanext-datagovuk root directory run make build to build the images needed for the docker stack.
  5. After the build is complete run make run to start the docker compose stack.
    • CKAN - Publishing app - http://localhost:5001
    • Find - Public facing discovery app - http://localhost:4001
    • Solr - Search index server - http://localhost:8983/solr

Development

Using the Makefile

  1. Run make run to start up the docker compose stack
  2. Run make test to just run the tests

Running the Tests

Run the tests inside the CKAN container on the docker compose stack:

python -m pytest --ckan-ini=test.ini ckanext/datagovuk/tests/

Creating test data

First set the environment variables: - CKAN_INI - location of CKAN ini file - CKAN_TEST_SYSADMIN_NAME and CKAN_TEST_SYSADMIN_PASSWORD

Then run the ckan command:

ckan datagovuk create-dgu-test-data
ckan datagovuk reindex-organisations

To remove the test data:

ckan datagovuk remove-dgu-test-data

Deploying CKAN

Environments and URLs

  • Integration: https://ckan.integration.publishing.service.gov.uk
  • Staging: https://ckan.staging.publishing.service.gov.uk
  • Production: https://ckan.publishing.service.gov.uk/

License

AGPL-3.0

Version
1.17.0
Version release date
2025-12-19
Contact name
GDS (Government Digital Service, UK)
Contakt email
ross.jones@digital.cabinet-office.gov.uk
Contact Url
(not set)


Installation Guide

Configuration hints

Configures Sentry via SENTRY_DSN env var. Docker-based development environment with make commands. Requires CKAN 2.10.

Plugins to configure (ckan.ini)
datagovuk datagovuk_publisher_form inventory_harvester
CKAN Settings (ckan.ini) 
# SENTRY_DSN = <your-sentry-dsn>
# CKAN_INI = /path/to/ckan.ini
# CKAN_TEST_SYSADMIN_NAME = admin
# CKAN_TEST_SYSADMIN_PASSWORD = password
DB migration to be executed
(not set)
<< back to Extensions