Welcome to CKAN’s Documentation¶
Note
This is the documentation for CKAN version ‘2.0‘. If you are using a different version, use the links on the bottom right corner of the page to select the appropriate documentation.
This documentation 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 Authorization, covers setup and basic admin.
- The second half of the Guide, from Extensions onwards, covers advanced tasks, including extensions and forms.
For high-level information on what CKAN is, see the CKAN website.
Installation¶
- Option 1: Package Installation
- Option 2: Install from Source
- 1. Install the required packages
- 2. Install CKAN into a Python virtual environment
- 3. Setup a PostgreSQL database
- 4. Create a CKAN config file
- 5. Setup Solr
- 6. Create database tables
- 7. Set up the DataStore
- 8. Link to who.ini
- 9. Run CKAN in the development web server
- 10. Run the CKAN Tests
- 11. You’re done!
- Upgrade a source install
- Post-Installation Setup
- Common error messages
- CKAN Deployment
- Setting up Solr
- Setting up the DataStore
Customizing and Extending¶
- Theming and Customizing Appearance
- Front End Documentation
- Templating
- Resources
- Apps & Ideas
- Extensions
- Writing Extensions
- Plugins Toolkit
- Tag vocabularies
- Form Integration
- Linked Data and RDF
- FileStore and File Uploads
- DataStore
- Background Tasks
- Multilingual Extension
- Send Email Notifications to Users
- Page View Tracking
- Stats Extension
Publishing Datasets¶
The CKAN API¶
General Administration¶
For CKAN Developers¶
Other material¶
- CKAN CHANGELOG
- v2.0 2013-05-10
- v1.8.1 2013-05-10
- v1.8 2012-10-19
- v1.7.3 2013-05-10
- v1.7.2 2012-10-19
- v1.7.1 2012-06-20
- v1.7 2012-05-09
- v1.6 2012-02-24
- v1.5.1 2012-01-04
- v1.5 2011-11-07
- v1.4.3.1 2011-09-30
- v1.4.3 2011-09-13
- v1.4.2 2011-08-05
- v1.4.1 2011-06-27
- v1.4 2011-05-19
- v1.3.3 2011-04-08
- v1.3.2 2011-03-15
- v1.3 2011-02-18
- v1.2 2010-11-25
- v1.1 2010-08-10
- v1.0.2 2010-08-27
- v1.0.1 2010-06-23
- v1.0 2010-05-11
- v0.11 2010-01-25
- v0.10 2009-09-30
- v0.9 2009-07-31
- v0.8 2009-04-10
- v0.7 2008-10-31
- v0.6 2008-07-08
- v0.5 2008-01-22
- v0.4 2007-07-04
- v0.3 2007-04-12
- v0.2 2007-02
- v0.1 2006-05
