Welcome to CKAN’s Administration Guide¶
Note
This is the documentation for CKAN version ‘1.7.1‘. If you are using a different version, use the links on the bottom right corner of the page to select the appropriate documentation.
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 Set and Manage Permissions, cover setup and basic admin.
- The second half of the Guide, from Add 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. Ensure the required packages are installed
- 2. Create a Python virtual environment.
- 3. Activate your virtual environment
- 4. Install CKAN source code
- 5. Install Additional Dependencies
- 6. Setup a PostgreSQL database
- 7. Create a CKAN config file
- 8. Setup Solr
- 9. Create database tables
- 10. Create the cache and session directories
- 11. Link to who.ini
- 12. Test the CKAN webserver
- 13. Browse CKAN
- 14. You are done
- Post-Installation Setup
- CKAN Deployment
- Setting up Solr
Customizing and Extending¶
- Theming and Customizing Appearance
- Comments and Commenting
- Add Extensions
- Understand and Write Extensions
- Customizing Forms
- Tag vocabularies
- Form Integration
- Linked Data and RDF
- FileStore and File Uploads
- DataStore and the Data API
- Background Tasks
- Import (“Harvest”) Data from Other Sites
- Geospatial Capabilities
- Translating Datasets, Groups and Tags
Publishing Datasets¶
The CKAN API¶
General Administration¶
- CKAN Administrative Dashboard
- Common CKAN Administrator Tasks
- Database Dumps
- Reference: CKAN Configuration Options
- Common error messages
- nose.config.ConfigError: Error reading config file 'setup.cfg': no such option 'with-pylons'
- OperationalError: (OperationalError) no such function: plainto_tsquery ...
- ImportError: No module named worker
- ImportError: cannot import name get_backend
- ImportError: cannot import name UnicodeMultiDict
- nosetests: error: no such option: --ckan
- AttributeError: 'unicode' object has no attribute 'items' (Cookie.py)
- AttributeError: 'module' object has no attribute 'BigInteger'
- ConfigParser.NoSectionError: No section: 'formatters'
- ImportError: No module named exceptions
- ckan.plugins.core.PluginNotFoundException: stats
- AssertionError: There is no script for 46 version
- AssertionError: Unexpected files/directories in pyenv/src/ckan
- sqlalchemy.exc.IntegrityError: (IntegrityError) could not create unique index "user_name_key
- ERROR: must be member of role "okfn" & WARNING: no privileges could be revoked for "public"
- IOError: [Errno 13] Permission denied: '/var/log/ckan/colorado/colorado.log'
- ImportError: No module named genshi.template
- type "geometry" does not exist
For CKAN Developers¶
Other material¶
- Contrib and Tools
- CKAN CHANGELOG
- 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
