CKAN Local Development

Docker Compose setup for running CKAN locally in development mode.

Setup

Copy the included .env.example and rename it to .env:

cp .env.example .env

Modify it depending on your own needs — at minimum change CKAN_SYSADMIN_PASSWORD.

Build and run

To build the images:

bin/compose build

To start the containers:

bin/compose up

CKAN will be available at http://localhost:5000.

./bin commands

script	description
bin/ckan …	exec ckan cli within the development container
bin/compose …	dev docker compose commands
bin/generate_extension	generate extension in src directory
bin/install_src	install all extensions from src directory (container does not need to be running)
bin/reload	reload ckan within the development container without restarting
bin/restart	shut down and restart the whole development container (use bin/compose up -d instead to reload new values from .env)
bin/shell	exec bash prompt within the development container

Create an extension

bin/generate_extension

The new extension files are created in the src/ directory.

Install extensions from src

bin/install_src

This installs all extensions located in the src/ directory into the development container.

Manage users

Create a user:

bin/ckan user add admin email=admin@localhost

Set as sysadmin:

bin/ckan sysadmin add admin

Remove a user:

bin/ckan user remove admin

Copying and License

This material is copyright (c) 2006-2023 Open Knowledge Foundation and contributors.

It is open and licensed under the GNU Affero General Public License (AGPL) v3.0 whose full text may be found at:

http://www.fsf.org/licensing/licenses/agpl-3.0.html