Welcome to CKAN’s developer documentation!

This Developer Documentation provides more advanced help for CKAN.

The main documentation is found at CKAN on KnowledgeForge.

Contents:

• README
  • Introduction
  • Developer Installation
  • Test
  • Documentation
  • Contributors
  • Copying and License
• CKAN Design
  • Overview
  • Architecture
• Production Deployment
• CKAN Configuration
  • sqlalchemy.url
  • package_form
  • rdf_packages
  • enable_caching
  • licenses_group_url
  • lang
  • extra_template_paths
  • extra_public_paths
  • package_new_return_url & package_edit_return_url
  • carrot_messaging_library
  • amqp_hostname, amqp_port, amqp_user_id, amqp_password
  • build_search_index_synchronously
  • search_backend
  • solr_url
  • site_title
  • site_logo
  • site_url
• The CKAN API
  • Code Modules for Client Applications
  • Overview
  • API Versions
  • CKAN Model API
  • CKAN Search API
  • CKAN Form API
  • CKAN API Status Codes
  • CKAN API Keys
  • JSONP formatted responses
• Plugins
  • Plugin activation
  • Plugin development
• CKAN Feeds
  • Introduction
  • Requests
  • Format
  • Main feed summary
• ‘Getdata’ import scripts
  • Introduction
  • Overview
  • Notes
• Package Importer
  • Introduction
  • Details
  • Format
  • Example
  • Fields
• Package Forms
  • Location of related code
  • Building a package form
  • Defining custom fields
  • Using a custom form
• Form integration
  • Form completion redirect
• Model
  • Migration
  • Creating a new migration script
  • Testing Migration Scripts
• CKAN Authentication and Identification
• CKAN Authorization and Access Control
  • Overview
  • User Notes
  • Developer Notes
  • Comparison with other frameworks and approaches
• Load Testing CKAN
  • What we did
  • Research
• Distributed Revision Control for Data: Format and Protocol
  • Aim
  • Existing Work
  • Use cases
  • Abstract Problem Description
  • Terminology
  • Formats
  • Protocol
  • Appendix: Distributed Revision Control for Source Code
• Database dumps
  • Creating a dump
  • Daily dumps
  • Serving the files

Other material

• CKAN CHANGELOG

Indices and tables

• Index
• Module Index
• Search Page