index.rst

Welcome to CKAN's Administration Guide

This Administration Guide covers how to set up and manage CKAN software.

• The first two sections cover your two options for installing CKAN: package or source install.
• The rest of the first half of the Guide, up to :doc:`authorization`, cover setup and basic admin.
• The second half of the Guide, from :doc:`extensions` onwards, covers advanced tasks, including extensions and forms.

For high-level information on what CKAN is, see the CKAN website.

Installation

.. toctree::
   :maxdepth: 2

   install-from-package
   install-from-source
   post-installation
   deployment
   solr-setup

Customizing and Extending

.. toctree::
   :maxdepth: 2

   theming
   commenting
   extensions
   writing-extensions
   forms
   form-integration
   linked-data-and-rdf
   filestore
   datastore
   background-tasks

Publishing Datasets

.. toctree::
   :maxdepth: 2

   loading-data
   authorization
   publisher-profile

The CKAN API

.. toctree::
   :maxdepth: 3

   api

General Administration

.. toctree::
   :maxdepth: 2

   administrative-dashboard
   paster
   database-dumps
   configuration
   common-error-messages

For CKAN Developers

.. toctree::
   :maxdepth: 2

   domain-model
   domain-model-dataset
   domain-model-resource
   domain-model-task-status
   i18n
   test
   buildbot

Other material

.. toctree::
   :maxdepth: 1

   CHANGELOG.rst

Indices and tables

• :ref:`genindex`
• :ref:`modindex`
• :ref:`search`