Installation

For either working on a project locally or working on the core DKAN software and libraries, using a standardized, docker-based local environment is recommended. The DKAN core team uses DDEV for local development of both the DKAN module and DKAN-based web projects.

If you’re installing DKAN for local development, to test it and/or contribute to its codebase, see the Local development section of the developer guide.

If you’re creating a new web project that will ultimately go into production, use your workflow of choice for starting a new Drupal project. DKAN is a Drupal module and can be installed into any Drupal 10+ site using Composer.

DKAN is distributed via the Drupal composer repository, and can be added to a project by running:

composer require 'drupal/dkan'

See Drupal’s composer documentation for more information.

DKAN depends on the JSON Form Widget module, which in turn depends on the Select2 module and companion library. The module will be added automatically by composer, but you should follow the steps in the Select2 project’s Readme to install the library.

Upgrading

Keep DKAN upgraded with composer like any other Drupal module. But, if you are already using DKAN 2.x and need to upgrade to 4.x, please be sure to follow the detailed upgrade instructions in the upgrade guide.

Requirements

DKAN is based on Drupal software and – generally – runs anywhere Drupal is supported. For the most common setup, we recommend:

  • Drupal 10+

  • MySQL: See minimum requirements for your Drupal version. MariaDB equivalents also supported.

  • PHP: minimum version 8.1

  • Apache: minimum version 2.4.7

  • Drush: minimum version 11.x.

  • Node: minimum version 18 (if using the decoupled frontend)

DKAN has several functions that expect MySQL/MariaDB database connections; running on other databases (e.g. PostgreSQL) is not recommended at this time.

Add some example datasets to your site

drush en sample_content -y
drush dkan:sample-content:create
drush cron

If you have trouble with generating the sample content, check the Troubleshooting section in the user guide.

Note

Current DKAN development is utilizing a decoupled frontend. To use Drupal’s theme system, there is a dataset twig template available in the metastore module. However, views integration is a roadmap epic with no target date as of yet.