Overview

Welcome to CKAN’s documentation! These docs are organized into several guides, each guide serves a different audience of CKAN users or contributors.

• User guide
  • What is CKAN?
  • Using CKAN
• Sysadmin guide
  • Creating a sysadmin account
  • Customizing look and feel
  • Managing organizations and datasets
  • Permanently deleting datasets
  • Managing users
• Maintainer’s guide
  • Installing CKAN
  • Upgrading CKAN
  • Getting started
  • Database Management
  • Command Line Interface
  • Organizations and authorization
  • Data preview and visualization
  • FileStore and file uploads
  • DataStore extension
  • Apps & Ideas
  • Tag Vocabularies
  • Form Integration
  • Linked Data and RDF
  • Background jobs
  • Email notifications
  • Page View Tracking
  • Multilingual Extension
  • Stats Extension
  • Configuration Options
• API guide
  • Making an API request
  • Example: Importing datasets with the CKAN API
  • API versions
  • Authentication and API keys
  • GET-able API functions
  • JSONP support
  • API Examples
  • Action API reference
• Extending guide
  • Writing extensions tutorial
  • Using custom config settings in extensions
  • Making configuration options runtime-editable
  • Testing extensions
  • Best practices for writing extensions
  • Customizing dataset and resource metadata fields using IDatasetForm
  • Plugin interfaces reference
  • Plugins toolkit reference
  • Validator functions reference
  • Internationalizing strings in extensions
  • Migration from Pylons to Flask
• Theming guide
  • Customizing CKAN’s templates
  • Adding static files
  • Customizing CKAN’s CSS
  • Adding CSS and JavaScript files using Fanstatic
  • Customizing CKAN’s JavaScript
  • Best practices for writing CKAN themes
  • Custom Jinja2 tags reference
  • Variables and functions available to templates
  • Objects and methods available to JavaScript modules
  • Template helper functions reference
  • Template snippets reference
  • JavaScript sandbox reference
  • JavaScript API client reference
  • CKAN jQuery plugins reference
• Contributing guide
  • Reporting issues
  • Translating CKAN
  • Testing CKAN
  • Writing commit messages
  • Making a pull request
  • Reviewing and merging a pull request
  • Writing documentation
  • Projects for beginner CKAN developers
  • CKAN code architecture
  • CSS coding standards
  • HTML coding standards
  • JavaScript coding standards
  • Python coding standards
  • String internationalization
  • Unicode handling
  • Testing coding standards
  • Frontend development guidelines
  • Database migrations
  • Upgrading CKAN’s dependencies
  • Doing a CKAN release
• Changelog

See also

Full table of contents

Note

These docs are maintained by the CKAN development team. CKAN and its documentation are free and open source, and contributions are welcome. To contribute to these docs, see Writing documentation.