# CKAN — Open Source Data Portal Platform

> CKAN is the open-source data management system that powers government and research data portals worldwide, making it easy to publish, share, and discover datasets.

## Install

Save as a script file and run:

# CKAN — Open Source Data Portal Platform

## Quick Use
```bash
docker run -d --name ckan -p 5000:5000 ckan/ckan-base:2.11
# Open http://localhost:5000
```

## Introduction
CKAN (Comprehensive Knowledge Archive Network) is a data management system used by governments and organizations to create open data portals. It provides tools for publishing, cataloging, searching, and visualizing datasets through a web interface and a rich API.

## What CKAN Does
- Hosts a searchable catalog of datasets with metadata, tags, and organizations
- Provides a RESTful API for programmatic dataset discovery and retrieval
- Supports file uploads, remote resource links, and data previews in the browser
- Manages user roles, organizations, and dataset access permissions
- Enables data harvesting from other CKAN instances and external sources

## Architecture Overview
CKAN is a Python web application built on Flask (migrated from Pylons). It uses PostgreSQL for metadata storage, Solr for full-text search, and Redis for background job queues. The frontend renders Jinja2 templates and can be themed or replaced entirely. A plugin system allows extending every aspect of the platform, from authentication to data processing.

## Self-Hosting and Configuration
- Deploy using the official Docker Compose setup or install from source on Ubuntu/Debian
- Configure the database connection, Solr URL, and site metadata in the INI config file
- Create an admin account with `ckan sysadmin add USERNAME`
- Install extensions via pip and enable them in the config (e.g., ckanext-harvest, ckanext-spatial)
- Set up a reverse proxy with Nginx and enable HTTPS for production deployments

## Key Features
- Powers data portals for dozens of national governments including the US, UK, Canada, and Australia
- Extensible plugin architecture with hundreds of community extensions
- Built-in data preview for CSV, JSON, GeoJSON, PDF, and image files
- Harvesting framework to import datasets from federated CKAN instances
- Comprehensive API covering every portal operation

## Comparison with Similar Tools
- **Dataverse** — focused on academic data sharing; CKAN is broader and supports government-scale portals
- **Socrata** — proprietary data portal SaaS; CKAN is free and self-hosted
- **DKAN** — Drupal-based CKAN alternative; CKAN has a larger ecosystem and more deployments
- **Magda** — modern federated catalog; CKAN has a longer track record and wider adoption

## FAQ
**Q: What databases does CKAN require?**
A: PostgreSQL for metadata and optionally DataStore for tabular data. Solr handles search indexing.

**Q: Can I customize the look and feel?**
A: Yes. CKAN supports custom themes via Jinja2 templates and CSS. Several community themes exist.

**Q: Does CKAN handle large file uploads?**
A: Yes, though for very large files it is common to store them externally and register resource URLs in the catalog.

**Q: Is there a hosted version available?**
A: Several organizations offer managed CKAN hosting, but the software itself is free to self-host.

## Sources
- https://github.com/ckan/ckan
- https://ckan.org

---
Source: https://tokrepo.com/en/workflows/asset-efebd2eb
Author: Script Depot