CINXE.COM
Overview — CKAN 2.11.0 documentation
<!DOCTYPE html> <html class="writer-html5" lang="en" data-content_root="./"> <head> <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>Overview — CKAN 2.11.0 documentation</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" /> <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" /> <link rel="stylesheet" href="_static/css/custom.css" type="text/css" /> <!--[if lt IE 9]> <script src="_static/js/html5shiv.min.js"></script> <![endif]--> <script src="_static/jquery.js?v=5d32c60e"></script> <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> <script src="_static/documentation_options.js?v=1647406f"></script> <script src="_static/doctools.js?v=9a2dae69"></script> <script src="_static/sphinx_highlight.js?v=dc90522c"></script> <script src="_static/js/theme.js"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> <!-- RTD Extra Head --> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.org", "builder": "sphinx", "canonical_url": null, "docroot": "/doc/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-1", "language": "en", "page": "index", "programming_language": "py", "project": "ckan", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {"ckanext-spatial": "https://docs.ckan.org/projects/ckanext-spatial/en/latest/"}, "theme": "sphinx_rtd_theme", "user_analytics_code": "UA-82993323-1", "version": "2.11"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <!-- end RTD <extrahead> --> <script async type="text/javascript" src="/_/static/javascript/readthedocs-addons.js"></script><meta name="readthedocs-project-slug" content="ckan" /><meta name="readthedocs-version-slug" content="2.11" /><meta name="readthedocs-resolver-filename" content="/" /><meta name="readthedocs-http-status" content="200" /></head> <body class="wy-body-for-nav"> <div class="wy-grid-for-nav"> <nav data-toggle="wy-nav-shift" class="wy-nav-side"> <div class="wy-side-scroll"> <div class="wy-side-nav-search" > <a href="contents.html"> <img src="_static/ckanlogo.png" class="logo" alt="Logo"/> </a> <div class="version"> 2.11.0 </div> <div role="search"> <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> </div> </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> <ul> <li class="toctree-l1"><a class="reference internal" href="user-guide.html">User guide</a></li> <li class="toctree-l1"><a class="reference internal" href="sysadmin-guide.html">Sysadmin guide</a></li> <li class="toctree-l1"><a class="reference internal" href="maintaining/index.html">Maintainer’s guide</a></li> <li class="toctree-l1"><a class="reference internal" href="api/index.html">API guide</a></li> <li class="toctree-l1"><a class="reference internal" href="extensions/index.html">Extending guide</a></li> <li class="toctree-l1"><a class="reference internal" href="theming/index.html">Theming guide</a></li> <li class="toctree-l1"><a class="reference internal" href="contributing/index.html">Contributing guide</a></li> <li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li> </ul> </div> </div> </nav> <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > <i data-toggle="wy-nav-top" class="fa fa-bars"></i> <a href="contents.html">CKAN</a> </nav> <div class="wy-nav-content"> <div class="rst-content"> <div role="navigation" aria-label="Page navigation"> <ul class="wy-breadcrumbs"> <li><a href="contents.html" class="icon icon-home" aria-label="Home"></a></li> <li class="breadcrumb-item active">Overview</li> <li class="wy-breadcrumbs-aside"> <a href="https://github.com/ckan/ckan/blob/2.11/doc/index.rst" class="fa fa-github"> Edit on GitHub</a> </li> </ul> <hr/> </div> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div itemprop="articleBody"> <section id="overview"> <h1>Overview<a class="headerlink" href="#overview" title="Link to this heading"></a></h1> <p>Welcome to CKAN’s documentation! These docs are organized into several guides, each guide serves a different audience of CKAN users or contributors.</p> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="user-guide.html">User guide</a><ul> <li class="toctree-l2"><a class="reference internal" href="user-guide.html#what-is-ckan">What is CKAN?</a></li> <li class="toctree-l2"><a class="reference internal" href="user-guide.html#using-ckan">Using CKAN</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="sysadmin-guide.html">Sysadmin guide</a><ul> <li class="toctree-l2"><a class="reference internal" href="sysadmin-guide.html#creating-a-sysadmin-account">Creating a sysadmin account</a></li> <li class="toctree-l2"><a class="reference internal" href="sysadmin-guide.html#customizing-look-and-feel">Customizing look and feel</a></li> <li class="toctree-l2"><a class="reference internal" href="sysadmin-guide.html#managing-organizations-and-datasets">Managing organizations and datasets</a></li> <li class="toctree-l2"><a class="reference internal" href="sysadmin-guide.html#permanently-deleting-datasets-organizations-and-groups">Permanently deleting datasets, organizations and groups</a></li> <li class="toctree-l2"><a class="reference internal" href="sysadmin-guide.html#managing-users">Managing users</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="maintaining/index.html">Maintainer’s guide</a><ul> <li class="toctree-l2"><a class="reference internal" href="maintaining/releases.html">CKAN releases</a></li> <li class="toctree-l2"><a class="reference internal" href="maintaining/installing/index.html">Installing CKAN</a></li> <li class="toctree-l2"><a class="reference internal" href="maintaining/upgrading/index.html">Upgrading CKAN</a></li> <li class="toctree-l2"><a class="reference internal" href="maintaining/getting-started.html">Getting started</a></li> <li class="toctree-l2"><a class="reference internal" href="maintaining/database-management.html">Database Management</a></li> <li class="toctree-l2"><a class="reference internal" href="maintaining/cli.html">Command Line Interface (CLI)</a></li> <li class="toctree-l2"><a class="reference internal" href="maintaining/authorization.html">Organizations and authorization</a></li> <li class="toctree-l2"><a class="reference internal" href="maintaining/data-viewer.html">Data preview and visualization</a></li> <li class="toctree-l2"><a class="reference internal" href="maintaining/filestore.html">FileStore and file uploads</a></li> <li class="toctree-l2"><a class="reference internal" href="maintaining/datastore.html">DataStore extension</a></li> <li class="toctree-l2"><a class="reference internal" href="maintaining/table-designer.html">Table Designer extension</a></li> <li class="toctree-l2"><a class="reference internal" href="maintaining/apps-ideas.html">Apps & Ideas</a></li> <li class="toctree-l2"><a class="reference internal" href="maintaining/tag-vocabularies.html">Tag Vocabularies</a></li> <li class="toctree-l2"><a class="reference internal" href="maintaining/form-integration.html">Form Integration</a></li> <li class="toctree-l2"><a class="reference internal" href="maintaining/linked-data-and-rdf.html">Linked Data and RDF</a></li> <li class="toctree-l2"><a class="reference internal" href="maintaining/background-tasks.html">Background jobs</a></li> <li class="toctree-l2"><a class="reference internal" href="maintaining/email-notifications.html">Email notifications</a></li> <li class="toctree-l2"><a class="reference internal" href="maintaining/tracking.html">Page View Tracking</a></li> <li class="toctree-l2"><a class="reference internal" href="maintaining/multilingual.html">Multilingual Extension</a></li> <li class="toctree-l2"><a class="reference internal" href="maintaining/stats.html">Stats Extension</a></li> <li class="toctree-l2"><a class="reference internal" href="maintaining/configuration.html">Configuration Options</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="api/index.html">API guide</a><ul> <li class="toctree-l2"><a class="reference internal" href="api/index.html#making-an-api-request">Making an API request</a></li> <li class="toctree-l2"><a class="reference internal" href="api/index.html#example-importing-datasets-with-the-ckan-api">Example: Importing datasets with the CKAN API</a></li> <li class="toctree-l2"><a class="reference internal" href="api/index.html#api-versions">API versions</a></li> <li class="toctree-l2"><a class="reference internal" href="api/index.html#authentication-and-api-tokens">Authentication and API tokens</a></li> <li class="toctree-l2"><a class="reference internal" href="api/index.html#get-able-api-functions">GET-able API functions</a></li> <li class="toctree-l2"><a class="reference internal" href="api/index.html#jsonp-support">JSONP support</a></li> <li class="toctree-l2"><a class="reference internal" href="api/index.html#api-examples">API Examples</a></li> <li class="toctree-l2"><a class="reference internal" href="api/index.html#action-api-reference">Action API reference</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="extensions/index.html">Extending guide</a><ul> <li class="toctree-l2"><a class="reference internal" href="extensions/tutorial.html">Writing extensions tutorial</a></li> <li class="toctree-l2"><a class="reference internal" href="extensions/custom-config-settings.html">Using custom config settings in extensions</a></li> <li class="toctree-l2"><a class="reference internal" href="extensions/remote-config-update.html">Making configuration options runtime-editable</a></li> <li class="toctree-l2"><a class="reference internal" href="extensions/testing-extensions.html">Testing extensions</a></li> <li class="toctree-l2"><a class="reference internal" href="extensions/best-practices.html">Best practices for writing extensions</a></li> <li class="toctree-l2"><a class="reference internal" href="extensions/adding-custom-fields.html">Customizing dataset and resource metadata fields using IDatasetForm</a></li> <li class="toctree-l2"><a class="reference internal" href="extensions/plugin-interfaces.html">Plugin interfaces reference</a></li> <li class="toctree-l2"><a class="reference internal" href="extensions/plugins-toolkit.html">Plugins toolkit reference</a></li> <li class="toctree-l2"><a class="reference internal" href="extensions/validators.html">Validator functions reference</a></li> <li class="toctree-l2"><a class="reference internal" href="extensions/translating-extensions.html">Internationalizing strings in extensions</a></li> <li class="toctree-l2"><a class="reference internal" href="extensions/flask-migration.html">Migration from Pylons to Flask</a></li> <li class="toctree-l2"><a class="reference internal" href="extensions/signals.html">Signals</a></li> <li class="toctree-l2"><a class="reference internal" href="extensions/custom-data-dictionary.html">Customizing the DataStore Data Dictionary Form</a></li> <li class="toctree-l2"><a class="reference internal" href="extensions/custom-columns-constraints.html">Customizing Table Designer Column Types and Constraints</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="theming/index.html">Theming guide</a><ul> <li class="toctree-l2"><a class="reference internal" href="theming/templates.html">Customizing CKAN’s templates</a></li> <li class="toctree-l2"><a class="reference internal" href="theming/static-files.html">Adding static files</a></li> <li class="toctree-l2"><a class="reference internal" href="theming/css.html">Customizing CKAN’s CSS</a></li> <li class="toctree-l2"><a class="reference internal" href="theming/webassets.html">Adding CSS and JavaScript files using Webassets</a></li> <li class="toctree-l2"><a class="reference internal" href="theming/javascript.html">Customizing CKAN’s JavaScript</a></li> <li class="toctree-l2"><a class="reference internal" href="theming/htmx.html">Creating dynamic user interfaces with htmx</a></li> <li class="toctree-l2"><a class="reference internal" href="theming/best-practices.html">Best practices for writing CKAN themes</a></li> <li class="toctree-l2"><a class="reference internal" href="theming/jinja-tags.html">Custom Jinja2 tags reference</a></li> <li class="toctree-l2"><a class="reference internal" href="theming/variables-and-functions.html">Variables and functions available to templates</a></li> <li class="toctree-l2"><a class="reference internal" href="theming/javascript-module-objects-and-methods.html">Objects and methods available to JavaScript modules</a></li> <li class="toctree-l2"><a class="reference internal" href="theming/template-helper-functions.html">Template helper functions reference</a></li> <li class="toctree-l2"><a class="reference internal" href="theming/template-snippets.html">Template snippets reference</a></li> <li class="toctree-l2"><a class="reference internal" href="theming/javascript-sandbox.html">JavaScript sandbox reference</a></li> <li class="toctree-l2"><a class="reference internal" href="theming/javascript-api-client.html">JavaScript API client reference</a></li> <li class="toctree-l2"><a class="reference internal" href="theming/jquery-plugins.html">CKAN jQuery plugins reference</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="contributing/index.html">Contributing guide</a><ul> <li class="toctree-l2"><a class="reference internal" href="contributing/issues.html">Reporting issues</a></li> <li class="toctree-l2"><a class="reference internal" href="contributing/i18n.html">Translating CKAN</a></li> <li class="toctree-l2"><a class="reference internal" href="contributing/test.html">Testing CKAN</a></li> <li class="toctree-l2"><a class="reference internal" href="contributing/commit-messages.html">Writing commit messages</a></li> <li class="toctree-l2"><a class="reference internal" href="contributing/pull-requests.html">Making a pull request</a></li> <li class="toctree-l2"><a class="reference internal" href="contributing/reviewing.html">Reviewing and merging a pull request</a></li> <li class="toctree-l2"><a class="reference internal" href="contributing/documentation.html">Writing documentation</a></li> <li class="toctree-l2"><a class="reference internal" href="contributing/simple-code-contributions.html">Projects for beginner CKAN developers</a></li> <li class="toctree-l2"><a class="reference internal" href="contributing/architecture.html">CKAN code architecture</a></li> <li class="toctree-l2"><a class="reference internal" href="contributing/css.html">CSS coding standards</a></li> <li class="toctree-l2"><a class="reference internal" href="contributing/html.html">HTML coding standards</a></li> <li class="toctree-l2"><a class="reference internal" href="contributing/javascript.html">JavaScript coding standards</a></li> <li class="toctree-l2"><a class="reference internal" href="contributing/python.html">Python coding standards</a></li> <li class="toctree-l2"><a class="reference internal" href="contributing/string-i18n.html">String internationalization</a></li> <li class="toctree-l2"><a class="reference internal" href="contributing/unicode.html">Unicode handling</a></li> <li class="toctree-l2"><a class="reference internal" href="contributing/testing.html">Testing coding standards</a></li> <li class="toctree-l2"><a class="reference internal" href="contributing/frontend/index.html">Frontend development guidelines</a></li> <li class="toctree-l2"><a class="reference internal" href="contributing/database-migrations.html">Database migrations</a></li> <li class="toctree-l2"><a class="reference internal" href="contributing/upgrading-dependencies.html">Upgrading CKAN’s dependencies</a></li> <li class="toctree-l2"><a class="reference internal" href="contributing/release-process.html">Doing a CKAN release</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li> </ul> </div> <div class="admonition seealso"> <p class="admonition-title">See also</p> <p><a class="reference internal" href="contents.html"><span class="doc">Full table of contents</span></a></p> </div> <div class="admonition note"> <p class="admonition-title">Note</p> <p>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 <a class="reference internal" href="contributing/documentation.html"><span class="doc">Writing documentation</span></a>.</p> </div> </section> </div> </div> <footer> <hr></hr> <p>Support the <a href="http://ckan.org">CKAN Association</a>.</p> <p class="copyright"> © 2009-2024 <a href="https://okfn.org/">Open Knowledge Foundation</a> and <a href="https://github.com/ckan/ckan/graphs/contributors">contributors</a>. Licensed under <a href="https://creativecommons.org/licenses/by-sa/3.0/">Creative Commons Attribution ShareAlike (Unported) v3.0 License</a>.<br /> <img src="https://licensebuttons.net/l/by-sa/3.0/80x15.png" alt="CC License Logo" /> <a href="https://opendefinition.org/"> <img src="https://assets.okfn.org/images/ok_buttons/oc_80x15_blue.png" border="0" alt="{{ _('Open Content') }}" /> </a> </p> <p> <a href="https://github.com/ckan/ckan">Source</a> — <a href="https://github.com/ckan/ckan/issues">Issues</a> — <a href="https://groups.google.com/a/ckan.org/g/ckan-dev">Mailing List</a> — <a href="http://twitter.com/CKANProject">Twitter @CKANProject</a> </p> <p> Related Projects: <a href="http://datacatalogs.org">DataCatalogs.org</a> — <a href="http://openspending.org">OpenSpending.org</a> — <a href="http://opendatahandbook.org">Open Data Handbook</a> </p> <a href="https://github.com/snide/sphinx_rtd_theme">Sphinx theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a> </footer> </div> </div> </section> </div> <script> jQuery(function () { SphinxRtdTheme.Navigation.enable(true); }); </script> </body> </html>