Welcome to CKAN’s Administration Guide

This Administration Guide covers how to set up and manage CKAN (Comprehensive Knowledge Archive Network) 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.

Contents:

• Option 1: Package Installation
  • Prepare your System
  • Run the Package Installer
  • Upgrading from CKAN 1.5
• 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. Create database tables
  • 9. Create the cache directory
  • 10. Setup Solr
  • 11. Run the CKAN webserver
  • 12. Point your web browser at: http://127.0.0.1:5000/
  • 13. You are Done
• Post-Installation Setup
  • Create an Admin User
  • Load Test Data
  • Deployment
• Setting up Solr
  • Single Solr instance
  • Multiple Solr cores
  • Troubleshooting
  • Handling changes in the CKAN schema
• Customization
  • Site Name and Description
  • Adding CSS, Javascript and other HTML using Config Options
  • More Advanced Customization
• Load Datasets
  • Import Data with the CKAN API
  • Import Data with the Harvester Extension
• Common CKAN Tasks
  • Understanding Paster
  • #. Enabling CKAN commands
  • #. Pointing to your CKAN config
  • #. Virtual environments
  • #. Running Paster on a deployment
  • Common Tasks Using Paster
• Set and Manage Permissions
  • Overview
  • Default Permissions
  • Managing Permissions
  • Openness Modes
• Add Extensions
  • Choosing Extensions
  • Installing an Extension
  • Enabling an Extension
• Understand and Write Extensions
  • CKAN Extensions
  • Plugins
  • The Queue Extension
• Customizing Forms
  • Building a Dataset Form
• Form Integration
  • Redirecting CKAN Forms
• Database Dumps
  • Creating a Dump
  • Daily Dumps
  • Serving the Files
• Internationalize CKAN
  • Supported Languages
  • Adding a New Language
• File uploads
  • Setup and Configuration
  • Storage Web Interface
  • Storage API
  • Webstore Integration
• Reference: CKAN Configuration Options
  • Database Settings
  • Front-End Settings
  • Authentication Settings
  • Internationalisation Settings
  • Storage Settings
  • Theming Settings
  • Form Settings
  • Messaging Settings
  • Search Settings
  • Site Settings
  • Authorization Settings
  • Plugin Settings
  • Directory Settings
• Reference: CKAN API
  • Overview
  • Examples
  • Code Modules for Client Applications
  • Versions
  • API Details - Versions 1 & 2
• Testing for Developers
  • Basic Tests
  • Testing against PostgreSQL
  • Migration Testing
  • Testing Core Extensions
  • Common error messages
• 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'
• Install Buildbot
  • Apt Installs
  • Postgres Setup
  • Buildslave Setup
  • Buildmaster Setup
  • Startup
  • Connect Ports
• About CKAN
  • Development
  • Acknowledgements
  • Copying and Licence

Other material

• CKAN CHANGELOG

Indices and tables

• Index
• Module Index
• Search Page